Skip to content
Snippets Groups Projects
Commit 9650196a authored by Russell Taylor's avatar Russell Taylor
Browse files

Tidy up. Re #1944.

parent a8d8ed07
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadInstrument.h
+ 36
− 47
View file @ 9650196a
......@@ -94,10 +94,13 @@ namespace Mantid
void setComponentLinks(boost::shared_ptr<Geometry::Instrument>& instrument, Poco::XML::Element* pElem);
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
void initDocs();
void init();
void exec();
/// Check the validity range and add it to the instrument object
void setValidityRange(const Poco::XML::Element* pRootElem);
/// Reads the contents of the \<defaults\> element to set member variables,
void readDefaults(Poco::XML::Element* defaults);
/// Structure for holding detector IDs
struct IdList
......@@ -119,11 +122,6 @@ namespace Mantid
void reset() { counted=0; vec.clear();};
};
/// Check the validity range and add it to the instrument object
void setValidityRange(const Poco::XML::Element* pRootElem);
/// Reads the contents of the \<defaults\> element to set member variables,
void readDefaults(Poco::XML::Element* defaults);
/// Method for populating IdList
void populateIdList(Poco::XML::Element* pElem, IdList& idList);
......@@ -133,6 +131,8 @@ namespace Mantid
/// Add XML element to parent assuming the element contains other component elements
void appendAssembly(boost::shared_ptr<Geometry::ICompAssembly> parent, Poco::XML::Element* pElem, IdList& idList,
const std::vector<std::string> excludeList);
/// Return true if assembly, false if not assembly and throws exception if string not in assembly
bool isAssembly(std::string) const;
/// Add XML element to parent assuming the element contains no other component elements
void appendLeaf(Geometry::ICompAssembly* parent, Poco::XML::Element* pElem, IdList& idList);
......@@ -146,53 +146,53 @@ namespace Mantid
void setLogfile(const Geometry::IComponent* comp, Poco::XML::Element* pElem,
std::multimap<std::string, boost::shared_ptr<Geometry::XMLlogfile> >& logfileCache);
/// Holds all the xml elements that have a \<parameter\> child element. Added purely for the purpose of computing speed and is used in setLogFile() for the purpose of quickly accessing if a component have a parameter/logfile associated with it or not - instead of using the comparatively slow poco call getElementsByTagName() (or getChildElement)
std::vector<Poco::XML::Element*> hasParameterElement;
/// has hasParameterElement been set - used when public method setComponentLinks is used
bool hasParameterElement_beenSet;
/// Get parent component element of location element
Poco::XML::Element* getParentComponent(Poco::XML::Element* pLocElem);
/// get name of location element
std::string getNameOfLocationElement(Poco::XML::Element* pElem);
/// map which holds names of types and whether or not they are catagorised as being
/// assembles, which means whether the type element contains component elements
std::map<std::string,bool> isTypeAssembly;
/// map which maps the type name to a shared pointer to a geometric shape
std::map<std::string, boost::shared_ptr<Geometry::Object> > mapTypeNameToShape;
/// Container to hold all detectors and monitors added to the instrument. Used for 'facing' these to component specified under \<defaults\>. NOTE: Seems unused, ever.
std::vector< Geometry::ObjComponent* > m_facingComponent;
/// Calculate the position of comp relative to its parent from info provided by \<location\> element
Kernel::V3D getRelativeTranslation(const Geometry::IComponent* comp, const Poco::XML::Element* pElem);
/// Parse position of facing element to V3D
Kernel::V3D parseFacingElementToV3D(Poco::XML::Element* pElem);
/// Set facing of comp as specified in XML facing element
void setFacing(Geometry::IComponent* comp, Poco::XML::Element* pElem);
/// True if defaults->components-are-facing is set in instrument def. file
bool m_haveDefaultFacing;
/// Hold default facing position
Kernel::V3D m_defaultFacing;
/// Make the shape defined in 1st argument face the component in the second argument
void makeXYplaneFaceComponent(Geometry::IComponent* &in, const Geometry::ObjComponent* facing);
/// Make the shape defined in 1st argument face the position in the second argument
void makeXYplaneFaceComponent(Geometry::IComponent* &in, const Kernel::V3D& facingPoint);
/// Return true if assembly, false if not assembly and throws exception if string not in assembly
bool isAssembly(std::string);
/// Reads in or creates the geometry cache ('vtp') file
void setupGeometryCache();
/// Run the sub-algorithm LoadInstrument (or LoadInstrumentFromRaw)
void runLoadParameterFile();
/// map which holds names of types and pointers to these type for fast retrievel in code
/** Holds all the xml elements that have a \<parameter\> child element.
* Added purely for the purpose of computing speed and is used in setLogFile() for the purpose
* of quickly accessing if a component have a parameter/logfile associated with it or not
* - instead of using the comparatively slow poco call getElementsByTagName() (or getChildElement)
*/
std::vector<Poco::XML::Element*> hasParameterElement;
/// has hasParameterElement been set - used when public method setComponentLinks is used
bool hasParameterElement_beenSet;
/** map which holds names of types and whether or not they are categorized as being
* assemblies, which means whether the type element contains component elements
*/
std::map<std::string,bool> isTypeAssembly;
/// map which maps the type name to a shared pointer to a geometric shape
std::map<std::string, boost::shared_ptr<Geometry::Object> > mapTypeNameToShape;
/// Container to hold all detectors and monitors added to the instrument. Used for 'facing' these to component specified under \<defaults\>. NOTE: Seems unused, ever.
std::vector< Geometry::ObjComponent* > m_facingComponent;
/// True if defaults->components-are-facing is set in instrument def. file
bool m_haveDefaultFacing;
/// Hold default facing position
Kernel::V3D m_defaultFacing;
/// map which holds names of types and pointers to these type for fast retrieval in code
std::map<std::string,Poco::XML::Element*> getTypeElement;
/// The name and path of the input file
std::string m_filename;
/// For convenience added pointer to instrument here
boost::shared_ptr<Geometry::Instrument> m_instrument;
......@@ -215,17 +215,6 @@ namespace Mantid
/// Map to store positions of parent components in spherical coordinates
std::map<const Geometry::IComponent*,SphVec> m_tempPosHolder;
void setupGeometryCache();
/// Run the sub-algorithm LoadInstrument (or LoadInstrumentFromRaw)
void runLoadParameterFile();
/// get name of location element
std::string getNameOfLocationElement(Poco::XML::Element* pElem);
/// Calculate the position of comp relative to its parent from info provided by \<location\> element
Kernel::V3D getRelativeTranslation(const Geometry::IComponent* comp, const Poco::XML::Element* pElem);
/// when this const equals 1 it means that angle=degree (default) is set in IDF
/// otherwise if this const equals 180/pi it means that angle=radian is set in IDF
double m_angleConvertConst;
......
Code/Mantid/Framework/DataHandling/src/LoadInstrument.cpp
+ 5
− 14
View file @ 9650196a
......@@ -1182,7 +1182,6 @@ namespace Mantid
}
//-----------------------------------------------------------------------------------------------------------------------
/** Returns True if the (string) type given is an assembly.
*
......@@ -1190,10 +1189,9 @@ namespace Mantid
* @return True if the type is an assembly
* @throw InstrumentDefinitionError Thrown if type not defined in XML definition
*/
bool LoadInstrument::isAssembly(std::string type)
bool LoadInstrument::isAssembly(std::string type) const
{
std::map<std::string,bool>::iterator it;
it = isTypeAssembly.find(type);
std::map<std::string,bool>::const_iterator it = isTypeAssembly.find(type);
if ( it == isTypeAssembly.end() )
{
......@@ -1201,7 +1199,7 @@ namespace Mantid
" not defined.", m_filename);
}
return isTypeAssembly[type];
return it->second;
}
......@@ -1215,13 +1213,10 @@ namespace Mantid
*/
void LoadInstrument::makeXYplaneFaceComponent(Geometry::IComponent* &in, const Geometry::ObjComponent* facing)
{
const Kernel::V3D facingPoint = facing->getPos();
makeXYplaneFaceComponent(in, facingPoint);
makeXYplaneFaceComponent(in, facing->getPos());
}
//-----------------------------------------------------------------------------------------------------------------------
/** Make the shape defined in 1st argument face the position in the second argument,
* by rotating the z-axis of the component passed in 1st argument so that it points in the
......@@ -1235,16 +1230,13 @@ namespace Mantid
Kernel::V3D pos = in->getPos();
// vector from facing object to component we want to rotate
Kernel::V3D facingDirection = pos - facingPoint;
facingDirection.normalize();
if ( facingDirection.norm() == 0.0 ) return;
// now aim to rotate shape such that the z-axis of of the object we want to rotate
// points in the direction of facingDirection. That way the XY plane faces the 'facing object'.
Kernel::V3D z = Kernel::V3D(0,0,1);
Kernel::Quat R = in->getRotation();
R.inverse();
......@@ -1273,7 +1265,6 @@ namespace Mantid
*/
Kernel::V3D LoadInstrument::parseFacingElementToV3D(Poco::XML::Element* pElem)
{
Kernel::V3D retV3D;
// Polar coordinates can be labelled as (r,t,p) or (R,theta,phi)
......@@ -1662,7 +1653,7 @@ namespace Mantid
if ( unit_it != units.end() )
if ( unit_it->second == "radian" )
m_angleConvertConst = 180.0/M_PI;
for (unsigned long iLink = 0; iLink < numberLinks; iLink++)
{
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment