Namespaces
namespace	ComponentHelper
	A set of helper functions for dealing with components, i.e.

namespace	ComponentInfoBankHelpers

namespace	Conversion

namespace	CoplanarChecks

namespace	detail
	ShapeInfo : Stores shape types and information relevant to drawing the shape.

namespace	GroupFactory

namespace	MDAlgorithms

namespace	MeshObjectCommon
	MeshObjectCommon : Performs functions common to 3D and 2D closed meshes.

namespace	RandomPoint

namespace	Rasterize

namespace	RenderingHelpers

namespace	StructureFactorCalculatorFactory

Classes
class	AbstractIDFObject
	IDFObject : File object wrapper over an IDF file. More...

class	AbstractSpaceGroupGenerator
	AbstractSpaceGroupGenerator is used by SpaceGroupFactory to delay (possibly costly) construction of space group prototype objects until they are actually requested. More...

class	AbstractSymmetryElementGenerator
	SymmetryElementFactoryImpl does not generate SymmetryElement objects directly. More...

class	Acomp
	Holds a state point in the decision tree. More...

class	Algebra
	Computes Boolean algebra for simplification. More...

class	AlgorithmicSpaceGroupGenerator
	Concrete space group generator that uses space group generators as given in ITA. More...

class	AtomPositionsEqual
	Equality-functor for comparison of atom positions with specifiable precision. More...

class	AtomPositionsLessThan
	Less-than-functor for comparison of atom positions with specifiable precision. More...

class	BaseVisit
	Adds the main. More...

class	BnId
	Tri-state variable. More...

class	BoolValue
	Rule Status class. More...

class	BoundingBox
	A simple structure that defines an axis-aligned cuboid shaped bounding box for a geometrical object. More...

class	BraggScatterer
	BraggScatterer is a general interface for representing scatterers in the unit cell of a periodic structure. More...

class	BraggScattererFactoryImpl

class	BraggScattererInCrystalStructure
	This class provides an extension of BraggScatterer, suitable for scatterers that are part of a crystal structure. More...

class	CenteringGroup
	This class is mostly a convenience class. More...

class	CenteringGroupCreatorImpl
	Helper class to keep this out of the interface of CenteringGroup. More...

class	CompAssembly
	Class for Assembly of geometric components. More...

class	CompGrp
	Compemented Grup. More...

class	CompObj
	Compemented Object. More...

class	Component
	Component is a wrapper for a Component which can modify some of its parameters, e.g. More...

class	ComponentInfo
	ComponentInfo : Provides a component centric view on to the instrument. More...

class	ComponentInfoItem
	ComponentInfoItem Return type for ComponentInfoIterators. More...

class	ComponentInfoIterator
	ComponentInfoIterator for random access iteration over ComponentInfo. More...

class	ComponentParser
	This class implements the Poco SAX ContentHandler class for reading component XML. More...

class	ComponentPool

class	ComponentVisitor
	ComponentVisitor : Visitor for IComponents. More...

class	CompositeBraggScatterer
	CompositeBraggScatterer accumulates scatterers, for easier calculation of structure factors. More...

class	CompositeImplicitFunction
	This class represents a composite implicit function used for communicating and implementing an operation against an MDWorkspace. More...

class	ConcretePeakTransformFactory
	Concrete PeakTransformFactory producing PeakTransforms of type provided by type argument. More...

class	Cone
	Holds a cone in vector form. More...

class	Container
	Models a Container is used to hold a sample in the beam. More...

class	ConventionalCell
	Instances of this class represent information about a selected conventional cell based on a specified UB for a Niggli reduced cell. More...

class	ConvexPolygon
	An implementation of a convex polygon. More...

class	CrystalStructure
	Three components are required to describe a crystal structure: More...

struct	CrystalSystemComparator
	This is necessary to make the map work with older compilers. More...

class	CSGObject
	Constructive Solid Geometry object. More...

struct	CuboidCorners

class	CyclicGroup
	A cyclic group G has the property that it can be represented by powers of one symmetry operation S of order n: More...

class	Cylinder
	Holds a cylinder as a vector form. More...

class	Detector
	This class represents a detector - i.e. More...

class	DetectorGroup
	Holds a collection of detectors. More...

class	DetectorInfo
	Geometry::DetectorInfo is an intermediate step towards a DetectorInfo that is part of Instrument-2.0. More...

class	DetectorInfoItem
	DetectorInfoItem. More...

class	DetectorInfoIterator
	DetectorInfoIterator for random access iteration over DetectorInfo. More...

struct	findID
	Helper unary comparison type for finding IMDDimensions by a specified id. More...

struct	findIntegrated
	Helper unary comparison type for finding non-integrated dimensions. More...

class	FitParameter
	Store information about a fitting parameter such as its value if it is constrained or tied. More...

class	General
	Holds a general quadratic surface. More...

class	GeneralFrame
	GeneralFrame : Any MDFrame that isn't related to momemtum transfer. More...

class	GeneralFrameFactory
	GeneralFrameFactory derived MDFrameFactory type. More...

class	GeometryHandler
	Handles rendering of all object Geometry. More...

class	Goniometer
	Class to represent a particular goniometer setting, which is described by the rotation matrix. More...

struct	GoniometerAxis
	Counter clockwise rotation. More...

class	GridDetector
	GridDetector is a type of CompAssembly, an assembly of components. More...

class	GridDetectorPixel
	GridrDetectorPixel: a sub-class of Detector that is one pixel inside a GridDetector. More...

class	Group
	The class Group represents a set of symmetry operations (or symmetry group). More...

class	GroupTransformation
	GroupTransformation. More...

struct	Hexahedron

class	HKL
	HKL : HKL MDFrame. More...

class	HKLFilter
	HKLFilter. More...

class	HKLFilterAnd
	Logical "And"-operation for HKLFilter. More...

class	HKLFilterBinaryLogicOperation
	Base class for binary logic operations for HKLFilter. More...

class	HKLFilterCentering
	A class to filter HKLs according to a lattice centering. More...

class	HKLFilterDRange
	A class to filter HKLs by their d-values. More...

class	HKLFilterNone
	BasicHKLFilters. More...

class	HKLFilterNot
	Logical "Not"-operation for HKLFilter. More...

class	HKLFilterOr
	Logical "Or"-operation for HKLFilter. More...

class	HKLFilterSpaceGroup
	A class to filter HKLs according to a space group. More...

class	HKLFilterStructureFactor
	A class to filter HKLs according to structure factor magnitudes. More...

class	HKLFilterUnaryLogicOperation
	Base class for unary logic operations for HKLFilter. More...

class	HKLFilterWavelength
	HKLFilterWavelength. More...

class	HKLFrameFactory
	HKLFrame derived MDFrameFactory type. More...

class	HKLGenerator
	HKLGenerator. More...

class	ICompAssembly
	Class for Assembly of geometric components. More...

class	IComponent
	base class for Geometric IComponent More...

class	IDetector
	Interface class for detector objects. More...

class	IDFObject
	Concrete IDF Object. More...

class	IMDDimension
	The class describes one dimension of multidimensional dataset representing an orthogonal dimension and linear axis. More...

class	IndexingUtils
	This class contains static utility methods for indexing peaks and finding the UB matrix. More...

class	InfoIteratorBase
	InfoIterator. More...

class	Instrument
	Base Instrument Class. More...

class	InstrumentDefinitionParser
	Creates an instrument data from a XML instrument description file. More...

class	InstrumentRayTracer
	This class is responsible for tracking rays and accumulating a list of objects that are intersected along the way. More...

class	InstrumentVisitor
	InstrumentVisitor : Visitor for components with access to Info wrapping features. More...

class	Intersection
	Combines two Rule objects in an intersection. More...

struct	IntersectionPoint
	Stores a point of intersection along a track. More...

class	IObjComponent
	Object Component class, this class brings together the physical attributes of the component to the positioning and geometry tree. More...

class	IObject
	IObject : Interface for geometry objects. More...

class	IPeak
	Structure describing a single-crystal peak. More...

class	IsotropicAtomBraggScatterer
	IsotropicAtomBraggScatterer calculates the structure factor for a given HKL using the following equation, which gives the structure factor for the j-th atom in the unit cell: More...

class	IsotropicAtomBraggScattererParser

class	LatticeSpacingCalculator
	Small helper functor to calculate d-Values from a unit cell. More...

class	Line
	Impliments a line. More...

class	LineIntersectVisit
	Interset of Line with a surface. More...

struct	Link
	For a leg of a track. More...

class	MatrixVectorPair
	MatrixVectorPair. More...

class	MatrixVectorPairBuilder

class	MatrixVectorPairParser
	MatrixVectorPairParser. More...

class	MDBoxImplicitFunction
	General N-dimensional box implicit function: Defines a cuboid in N dimensions that is aligned with the axes of a MDEventWorkspace. More...

class	MDDimensionExtents
	Simple class that holds the extents (min/max) of a given dimension in a MD workspace or MDBox. More...

class	MDFrame
	MDFrame : The coordinate frame for a dimension, or set of dimensions in a multidimensional workspace. More...

class	MDFrameArgument
	Input argument type for MDFrameFactory chainable factory. More...

class	MDFrameFactory
	MDFrameFactory.h : Chain of repsonsibility factory for the MDFrameFactory. More...

class	MDGeometryBuilderXML

class	MDGeometryXMLDefinitions
	This type contains definitions that will be found in the xml schema for the rebinning instructions, but must be used in code as part of the peristance/fetching routines. More...

class	MDGeometryXMLParser
	Handles the extraction of dimensions from a xml xml string to determine how mappings have been formed. More...

class	MDHistoDimension
	MDHistoDimension : More...

class	MDHistoDimensionBuilder
	MDHistoDimensionBuilder : More...

class	MDImplicitFunction
	An "ImplicitFunction" defining a hyper-cuboid-shaped region in N dimensions. More...

class	MDPlane
	A generalized description of a N-dimensional hyperplane. More...

class	MDPlaneImplicitFunction
	A general N-dimensional plane implicit function. More...

class	MeshObject
	Triangular Mesh Object. More...

class	MeshObject2D
	MeshObject2D : More...

class	NiggliCell
	Class to implement UB matrix. More...

class	NoDeleting
	Void deleter for shared pointers. More...

struct	NoDimensionPolicy

class	NullIDFObject

class	NullImplicitFunction
	This class represents a Null Implicit function. More...

class	ObjCompAssembly
	Class for Assembly of geometric components. More...

class	ObjComponent
	Object Component class, this class brings together the physical attributes of the component to the positioning and geometry tree. More...

class	OrientedLattice
	Class to implement UB matrix. More...

class	Parameter
	Base class for parameters of an instrument. More...

class	ParameterFactory
	The ParameterFactory class creates parameters for the instrument ParameterMap. More...

class	ParameterMap
	ParameterMap class. More...

class	ParameterType
	Templated class for parameters of type `Type`. More...

class	ParComponentFactory
	A Factory for creating Parameterized component from their respective non-parameterized objects. More...

class	PeakShape
	PeakShape : Abstract type to describes the shape of a peak. More...

class	PeakTransform
	Used to remap coordinates into a form consistent with an axis reordering. More...

class	PeakTransformException
	Exceptions occuring when PeakTransformations cannot be formed. More...

class	PeakTransformFactory
	Abstract type defining Factory Method interface for generating PeakTransforms. More...

class	PeakTransformHKL
	Used to remap coordinates into a form consistent with an axis reordering. More...

class	PeakTransformQLab
	Used to remap coordinates into a form consistent with an axis reordering. More...

class	PeakTransformQSample
	Used to remap coordinates into a form consistent with an axis reordering. More...

class	PeakTransformSelector
	Used to choose an appropriate PeakTransformFactory. More...

class	Plane
	Holds a simple Plane. More...

class	PointGroup
	A class containing the Point Groups for a crystal. More...

class	PointGroupFactoryImpl

class	PointGroupGenerator

class	PolygonEdge
	PolygonEdge Defines a directed edge between two points on a polygon. More...

class	ProductOfCyclicGroups
	ProductOfCyclicGroups expands a bit on the explanations given in CyclicGroup. More...

class	QLab
	QLab : Q in the lab frame MDFrame. More...

class	QLabFrameFactory
	QLabFrameFactory derived MDFrameFactory type. More...

class	QSample
	QSample : Q in the sample frame. More...

class	QSampleFrameFactory
	QSampleFrameFactory derived MDFrameFactory type. More...

class	Quadratic
	Holds a basic quadratic surface. More...

class	Quadrilateral
	A ConvexPolygon with only 4 vertices. More...

struct	Raster
	Holds the information used for doing numerical integrations of object in the beam. More...

class	RectangularDetector
	RectangularDetector is a type of CompAssembly, an assembly of components. More...

class	ReducedCell
	Instances of this class represent information about reduced cell types including the transformation required to transform the reduced cell to a conventional cell. More...

class	ReferenceFrame
	ReferenceFrame : Holds reference frame information from the geometry description file. More...

class	ReflectionCondition
	A class containing the Reflection Condition for a crystal. More...

class	ReflectionConditionAFaceCentred
	A-face centred ReflectionCondition. More...

class	ReflectionConditionAllFaceCentred
	All-face centred ReflectionCondition. More...

class	ReflectionConditionBFaceCentred
	B-face centred ReflectionCondition. More...

class	ReflectionConditionBodyCentred
	Body centred ReflectionCondition. More...

class	ReflectionConditionCFaceCentred
	C-face centred ReflectionCondition. More...

class	ReflectionConditionHexagonallyReverse
	Hexagonally centred, reverse ReflectionCondition. More...

class	ReflectionConditionPrimitive
	Primitive ReflectionCondition. More...

class	ReflectionConditionRhombohedrallyObverse
	Rhombohedrally centred, obverse ReflectionCondition. More...

class	ReflectionConditionRhombohedrallyReverse
	Rhombohedrally centred, reverse ReflectionCondition. More...

class	ReflectionGenerator
	ReflectionGenerator. More...

struct	RegisterConditions

struct	RegisterConditions< R, Args... >

struct	RegisterConditions<>

class	RenderingMesh
	RenderingMesh : Mesh abstraction required for rendering. More...

class	RotaryCounter
	Simple multilevel-cyclic counter. More...

class	Rule
	Object generation rule tree. More...

class	SampleEnvironment
	Defines a single instance of a SampleEnvironment. More...

class	ScalarUtils
	This class contains static utility methods for determining an orientation matrix corresponding to a conventional, given the orientation matrix corresponding to the Niggli reduced cell. More...

class	ShapeFactory
	Class originally intended to be used with the DataHandling 'LoadInstrument' algorithm. More...

class	SpaceGroup
	A class for representing space groups, inheriting from Group. More...

class	SpaceGroupFactoryImpl

class	Sphere
	Holds a Sphere as vector form. More...

struct	StrictDimensionPolicy

class	StructuredDetector
	StructuredDetector is a type of CompAssembly, an assembly of components. More...

class	StructureFactorCalculator
	StructureFactorCalculator. More...

class	StructureFactorCalculatorSummation
	StructureFactorCalculatorSummation. More...

class	Surface
	Holds a basic quadratic surface. More...

class	SurfaceFactory
	Creates instances of Surfaces. More...

class	SurfPoint
	Surface leaf node. More...

class	SymmetryElement
	SymmetryElement is an interface for representing symmetry elements that occur for example in space and point groups. More...

class	SymmetryElementFactoryImpl
	This factory takes a SymmetryOperation and generates the corresponding SymmetryElement. More...

class	SymmetryElementIdentity
	SymmetryElementIdentity represents the identity. More...

class	SymmetryElementIdentityGenerator
	This implementation of AbstractSymmetryElementGenerator produces only identity elements. More...

class	SymmetryElementInversion
	SymmetryElementInversion represents the inversion. More...

class	SymmetryElementInversionGenerator
	This implementation of AbstractSymmetryElementGenerator produces only inversion elements. More...

class	SymmetryElementMirror
	SymmetryElementMirror represents mirror and glide-planes. More...

class	SymmetryElementMirrorGenerator
	SymmetryElementMirrorGenerator also inherits from SymmetryElementWithAxisGenerator. More...

class	SymmetryElementRotation
	SymmetryElementRotation represents rotation-, rotoinversion- and screw-axes. More...

class	SymmetryElementRotationGenerator
	SymmetryElementRotationGenerator inherits from SymmetryElementWithAxisGenerator, using its methods for determination of rotation axis and translations in case of screw axes. More...

class	SymmetryElementTranslation
	SymmetryElementTranslation represents translations. More...

class	SymmetryElementTranslationGenerator
	This implementation of AbstractSymmetryElementGenerator produces only translation elements. More...

class	SymmetryElementWithAxis
	SymmetryElementWithAxis does not represent any symmetry element directly. More...

class	SymmetryElementWithAxisGenerator
	SymmetryElementWithAxisGenerator does not create any elements directly, it serves as a base for SymmetryElementRotationGenerator and SymmetryAxisMirrorGenerator, which have in common that the axis of the symmetry element as well as any potential translations must be determined. More...

class	SymmetryOperation
	Crystallographic symmetry operations are composed of a rotational component, which is represented by a matrix and a translational part, which is described by a vector. More...

class	SymmetryOperationFactoryImpl
	A factory for symmetry operations. More...

class	SymmetryOperationSymbolParser
	This is a parser for symmetry operation symbols in the Jones faithful representation. More...

class	TabulatedSpaceGroupGenerator
	Concrete space group generator that constructs space groups from a list of symmetry operations with no further computations. More...

class	Torus
	Holds a torus in vector form. More...

class	Track
	Defines a track as a start point and a direction. More...

class	TransformationSpaceGroupGenerator
	Concrete generator that generates a space group from another space group using a transformation. More...

class	Union
	Combines two Rule objects in an union. More...

class	UnitCell
	Class to implement unit cell of crystals. More...

class	UnitCellStringValidator
	Helper class for validating unit cell strings. More...

class	UnknownFrame
	UnknownFrame : Unknown MDFrame. More...

class	UnknownFrameFactory
	Unknown Frame derived MDFrameFactory type. More...

class	V3R

class	vtkGeometryCacheReader
	Reads the Geometry Cache from the file to the Object. More...

class	vtkGeometryCacheWriter
	Writes the Geometry from Object to Cache. More...

class	XMLInstrumentParameter
	This class is used to store information about parameters in XML instrument definition files and instrument parameter files, so that such parameters can be added to a workspace when appropriate. More...

Typedefs
using	AbstractSpaceGroupGenerator_sptr = std::shared_ptr< AbstractSpaceGroupGenerator >

using	AbstractSymmetryElementGenerator_sptr = std::shared_ptr< AbstractSymmetryElementGenerator >

using	BoundingBox_const_sptr = std::shared_ptr< const BoundingBox >
	A shared pointer to a const BoundingBox. More...

using	BoundingBox_sptr = std::shared_ptr< BoundingBox >
	A shared pointer to a BoundingBox. More...

using	BraggScatterer_sptr = std::shared_ptr< BraggScatterer >

using	BraggScattererFactory = Mantid::Kernel::SingletonHolder< BraggScattererFactoryImpl >

using	BraggScattererInCrystalStructure_sptr = std::shared_ptr< BraggScattererInCrystalStructure >

using	CenteringGroup_const_sptr = std::shared_ptr< const CenteringGroup >

using	CenteringGroup_sptr = std::shared_ptr< CenteringGroup >

using	CenteringGroupCreator = Mantid::Kernel::SingletonHolder< CenteringGroupCreatorImpl >

using	component_map_cit = tbb::concurrent_unordered_multimap< ComponentID, std::shared_ptr< Parameter > >::const_iterator

using	component_map_it = tbb::concurrent_unordered_multimap< ComponentID, std::shared_ptr< Parameter > >::iterator
	Parameter map iterator typedef. More...

using	ComponentID = IComponent *
	Define a type for a unique component identifier. More...

using	ComponentInfoConstIt = ComponentInfoIterator< const ComponentInfo >

using	ComponentInfoIt = ComponentInfoIterator< ComponentInfo >

using	CompositeBraggScatterer_sptr = std::shared_ptr< CompositeBraggScatterer >

using	Container_const_sptr = std::shared_ptr< const Container >
	Typdef for a shared pointer to a const object. More...

using	Container_sptr = std::shared_ptr< Container >
	Typdef for a shared pointer. More...

using	CrystalStructure_sptr = std::shared_ptr< CrystalStructure >

using	CyclicGroup_const_sptr = std::shared_ptr< const CyclicGroup >

using	CyclicGroup_sptr = std::shared_ptr< CyclicGroup >

using	DetectorGroup_const_sptr = std::shared_ptr< const DetectorGroup >
	Typedef for shared pointer to a const object. More...

using	DetectorGroup_sptr = std::shared_ptr< DetectorGroup >
	Typedef for shared pointer. More...

using	DetectorInfoConstIt = DetectorInfoIterator< const DetectorInfo >

using	DetectorInfoIt = DetectorInfoIterator< DetectorInfo >

using	GridDetector_const_sptr = std::shared_ptr< const GridDetector >

using	GridDetector_sptr = std::shared_ptr< GridDetector >

using	Group_const_sptr = std::shared_ptr< const Group >

using	Group_sptr = std::shared_ptr< Group >

using	HKLFilter_const_sptr = std::shared_ptr< const HKLFilter >

using	HKLFilter_sptr = std::shared_ptr< HKLFilter >

using	HKLFilter_uptr = std::unique_ptr< HKLFilter >

using	ICompAssembly_const_sptr = std::shared_ptr< const ICompAssembly >
	Shared pointer to a const ICompAssembly. More...

using	ICompAssembly_sptr = std::shared_ptr< ICompAssembly >
	Shared pointer to a ICompAssembly. More...

using	IComponent_const_sptr = std::shared_ptr< const IComponent >
	Typdef of a shared pointer to a const IComponent. More...

using	IComponent_sptr = std::shared_ptr< IComponent >
	Typedef of a shared pointer to a IComponent. More...

using	IDetector_const_sptr = std::shared_ptr< const Mantid::Geometry::IDetector >
	Shared pointer to IDetector (const version) More...

using	IDetector_const_uptr = std::unique_ptr< const IDetector >
	unique pointer to an IDetector (const version) More...

using	IDetector_sptr = std::shared_ptr< Mantid::Geometry::IDetector >
	Shared pointer to IDetector. More...

using	IDetector_uptr = std::unique_ptr< IDetector >
	unique pointer to an IDetector More...

using	IDFObject_const_sptr = std::shared_ptr< const AbstractIDFObject >

using	IDFObject_sptr = std::shared_ptr< AbstractIDFObject >

using	IMDDimension_const_sptr = std::shared_ptr< const IMDDimension >
	Shared Pointer to const IMDDimension. More...

using	IMDDimension_sptr = std::shared_ptr< IMDDimension >
	Shared Pointer for IMDDimension. Frequently used type in framework. More...

using	Instrument_const_sptr = std::shared_ptr< const Instrument >
	Shared pointer to an const instrument object. More...

using	Instrument_const_uptr = std::unique_ptr< const Instrument >
	unique pointer to an instrument (const version) More...

using	Instrument_sptr = std::shared_ptr< Instrument >
	Shared pointer to an instrument object. More...

using	Instrument_uptr = std::unique_ptr< Instrument >
	unique pointer to an instrument More...

using	InstrumentParameterCache = std::map< std::pair< std::string, const IComponent * >, std::shared_ptr< XMLInstrumentParameter > >
	Convenience typedef. More...

using	IObjComponent_const_sptr = std::shared_ptr< const IObjComponent >
	Shared pointer to IObjComponent (const version) More...

using	IObjComponent_sptr = std::shared_ptr< IObjComponent >
	Shared pointer to IObjComponent. More...

using	IObject_const_sptr = std::shared_ptr< const IObject >
	Typdef for a shared pointer to a const object. More...

using	IObject_const_uptr = std::unique_ptr< const IObject >
	Typdef for a unique pointer to a const object. More...

using	IObject_sptr = std::shared_ptr< IObject >
	Typdef for a shared pointer. More...

using	IObject_uptr = std::unique_ptr< IObject >
	Typdef for a unique pointer. More...

using	IPeak_uptr = std::unique_ptr< IPeak >

using	IsotropicAtomBraggScatterer_sptr = std::shared_ptr< IsotropicAtomBraggScatterer >

using	Links = Track::LType
	Typedef for object intersections. More...

using	MDFrame_const_sptr = std::shared_ptr< const MDFrame >

using	MDFrame_const_uptr = std::unique_ptr< const MDFrame >

using	MDFrame_sptr = std::shared_ptr< MDFrame >

using	MDFrame_uptr = std::unique_ptr< MDFrame >

using	MDFrameFactory_uptr = std::unique_ptr< MDFrameFactory >
	Helper typedef. More...

using	MDHistoDimension_const_sptr = std::shared_ptr< const MDHistoDimension >
	Shared pointer to a const MDHistoDimension. More...

using	MDHistoDimension_sptr = std::shared_ptr< MDHistoDimension >
	Shared pointer to a MDHistoDimension. More...

using	MDImplicitFunction_sptr = std::shared_ptr< MDImplicitFunction >

using	ObjCompAssembly_const_sptr = std::shared_ptr< const ObjCompAssembly >
	Shared pointer to ObjCompAssembly (const version) More...

using	ObjCompAssembly_sptr = std::shared_ptr< ObjCompAssembly >
	Shared pointer to ObjCompAssembly. More...

using	Parameter_sptr = std::shared_ptr< Parameter >
	Typedef for the shared pointer. More...

using	ParameterMap_const_sptr = std::shared_ptr< const ParameterMap >
	ParameterMap constant shared pointer typedef. More...

using	ParameterMap_sptr = std::shared_ptr< ParameterMap >
	ParameterMap shared pointer typedef. More...

using	ParsedRationalNumber = boost::fusion::vector< int, boost::optional< int > >

using	PeakShape_const_sptr = std::shared_ptr< const PeakShape >

using	PeakShape_sptr = std::shared_ptr< PeakShape >

using	PeakTransform_const_sptr = std::shared_ptr< const PeakTransform >

using	PeakTransform_sptr = std::shared_ptr< PeakTransform >
	Typedef for a PeakTransform wrapped in a shared_pointer. More...

using	PeakTransformFactory_sptr = std::shared_ptr< PeakTransformFactory >
	Factory Shared Pointer typedef. More...

using	PeakTransformHKLFactory = ConcretePeakTransformFactory< PeakTransformHKL >
	Typedef a factory for type of PeaksTransform. More...

using	PeakTransformQLabFactory = ConcretePeakTransformFactory< PeakTransformQLab >
	Typedef a factory for type of PeaksTransform. More...

using	PeakTransformQSampleFactory = ConcretePeakTransformFactory< PeakTransformQSample >
	Typedef a factory for type of PeaksTransform. More...

using	PointGroup_sptr = std::shared_ptr< PointGroup >
	Shared pointer to a PointGroup. More...

using	PointGroupCrystalSystemMap = std::multimap< PointGroup::CrystalSystem, PointGroup_sptr, CrystalSystemComparator >

using	PointGroupFactory = Mantid::Kernel::SingletonHolder< PointGroupFactoryImpl >

using	PointGroupGenerator_sptr = std::shared_ptr< PointGroupGenerator >

using	RationalNumber = boost::rational< int >
	V3R : More...

using	RectangularDetector_const_sptr = std::shared_ptr< const RectangularDetector >

using	RectangularDetector_sptr = std::shared_ptr< RectangularDetector >

using	ReflectionCondition_sptr = std::shared_ptr< ReflectionCondition >
	Shared pointer to a ReflectionCondition. More...

using	ReflectionConditions = std::vector< ReflectionCondition_sptr >
	A collection of reflections. More...

using	SampleEnvironment_const_uptr = std::unique_ptr< const SampleEnvironment >

using	SampleEnvironment_uptr = std::unique_ptr< SampleEnvironment >

using	SpaceGroup_const_sptr = std::shared_ptr< const SpaceGroup >

using	SpaceGroup_sptr = std::shared_ptr< SpaceGroup >

using	SpaceGroupFactory = Mantid::Kernel::SingletonHolder< SpaceGroupFactoryImpl >

using	StructuredDetector_const_sptr = std::shared_ptr< const StructuredDetector >

using	StructuredDetector_sptr = std::shared_ptr< StructuredDetector >

using	StructureFactor = std::complex< double >

using	StructureFactorCalculator_sptr = std::shared_ptr< StructureFactorCalculator >

using	StructureFactorSummation_sptr = std::shared_ptr< StructureFactorCalculatorSummation >

using	SymmetryElement_sptr = std::shared_ptr< SymmetryElement >

using	SymmetryElementFactory = Mantid::Kernel::SingletonHolder< SymmetryElementFactoryImpl >

using	SymmetryElementIdentity_sptr = std::shared_ptr< SymmetryElementIdentity >

using	SymmetryElementInversion_sptr = std::shared_ptr< SymmetryElementInversion >

using	SymmetryElementMirror_sptr = std::shared_ptr< SymmetryElementMirror >

using	SymmetryElementRotation_sptr = std::shared_ptr< SymmetryElementRotation >

using	SymmetryElementTranslation_sptr = std::shared_ptr< SymmetryElementTranslation >

using	SymmetryElementWithAxis_sptr = std::shared_ptr< SymmetryElementWithAxis >

using	SymmetryOperationFactory = Mantid::Kernel::SingletonHolder< SymmetryOperationFactoryImpl >

using	Vec_MDHistoDimensionBuilder = std::vector< MDHistoDimensionBuilder >
	Handy typedef for collection of builders. More...

using	VecIMDDimension_const_sptr = std::vector< IMDDimension_const_sptr >
	Vector of constant shared pointers to IMDDimensions. More...

using	VecIMDDimension_sptr = std::vector< IMDDimension_sptr >
	Vector of shared pointers to IMDDimensions. More...

Enumerations
enum	AngleUnits { angDegrees , angRadians }
	Flag for angle units used in UnitCell class. More...

enum	det_topology { rect , cyl , undef }
	Describes the topology of a detectors group used to calculate angular position and angular measures for detectors. More...

enum	Handedness { Left , Right }
	Type to distingusih between l and r handedness. More...

enum	PointClassification { OnLeft , OnRight , Beyond , Behind , Between , Origin , Destination }
	Enumeration for point type w.r.t an edge. More...

enum	PointingAlong { X = 0 , Y = 1 , Z = 2 }
	Type to describe pointing along options. More...

enum struct	ReflectionConditionFilter { None , Centering , SpaceGroup , StructureFactor }

enum	RotationSense { CW = -1 , CCW = 1 }

enum class	TrackDirection { LEAVING = -1 , INVALID = 0 , ENTERING = 1 }

Functions
PointingAlong	axisNameToAxisType (const std::string &label, const std::string &input)

bool	checkValidOrderString (const std::string &order)

MANTID_GEOMETRY_DLL PointClassification	classify (const Kernel::V2D &pt, const PolygonEdge &edge)
	Helper function for classification. More...

static bool	CompareABCsum (const DblMatrix &UB_1, const DblMatrix &UB_2)
	Comparator function for sorting list of UB matrices based on the sum of the lengths of the corresponding real space cell edge lengths \|a\|+\|b\|+\|C\|. More...

static bool	CompareDiffFrom90 (const DblMatrix &UB_1, const DblMatrix &UB_2)
	Comparator to sort a list of UBs in decreasing order based on the difference of cell angles from 90 degrees. More...

template<typename T , typename U >
Kernel::Matrix< T >	convertMatrix (const Kernel::Matrix< U > &matrix)

MANTID_GEOMETRY_DLL IMDDimension_sptr	createDimension (const Poco::XML::Element &dimensionXML)
	Create a dimension from the provided XML element. More...

MANTID_GEOMETRY_DLL IMDDimension_sptr	createDimension (const std::string &dimensionXMLString)
	Creates IMDDimension objects based on input XML. More...

MANTID_GEOMETRY_DLL IMDDimension_sptr	createDimension (const std::string &dimensionXMLString, int nBins, coord_t min, coord_t max)
	Create a dimension object from the provided XML string, overriding certain attributes. More...

MANTID_GEOMETRY_DLL PolygonEdge::Orientation	crossingPoint (const PolygonEdge &edgeOne, const PolygonEdge &edgeTwo, Kernel::V2D &crossPoint)
	Calculate the crossing point of one edge with wrt another. More...

	DECLARE_GENERATED_SPACE_GROUP (137, "P 42/n m c", "-x,-y,z; -y+1/2,x+1/2,z+1/2; -x+1/2,y+1/2,-z+1/2; -x+1/2,-y+1/2,-z+1/2") DECLARE_GENERATED_SPACE_GROUP(141

z	DECLARE_GENERATED_SPACE_GROUP (142, "I 41/a c d", "-x+1/2,-y+1/2,z+1/2; -y,x+1/2,z+1/4; -x+1/2,y,-z+1/4; -x,-y+1/2,-z+1/4") DECLARE_GENERATED_SPACE_GROUP(227

MANTID_GEOMETRY_DLL bool	edgeAimsAt (const PolygonEdge &a, const PolygonEdge &b, PointClassification aclass, PolygonEdge::Orientation crossType)
	Return if the edges aim at each other. More...

MANTID_GEOMETRY_DLL bool	edgePixel (const Geometry::Instrument_const_sptr &inst, const std::string &bankName, int col, int row, int Edge)
	Function to find peaks near detector edge. More...

MANTID_GEOMETRY_DLL std::vector< PointGroup_sptr >	getAllPointGroups ()

MANTID_GEOMETRY_DLL std::vector< std::string >	getAllReflectionConditionNames ()
	Returns all ReflectionCondition names. More...

MANTID_GEOMETRY_DLL const ReflectionConditions &	getAllReflectionConditions ()

MANTID_GEOMETRY_DLL std::vector< std::string >	getAllReflectionConditionSymbols ()
	Returns all centering symbols. More...

MANTID_GEOMETRY_DLL std::string	getCrystalSystemAsString (const PointGroup::CrystalSystem &crystalSystem)
	Return a human-readable string for the given crystal system. More...

MANTID_GEOMETRY_DLL PointGroup::CrystalSystem	getCrystalSystemFromString (const std::string &crystalSystem)
	Returns the crystal system enum that corresponds to the supplied string or throws an invalid_argument exception. More...

static double	GetDiffFrom90Sum (const DblMatrix &UB)
	Get the cell angles for the unit cell corresponding to matrix UB and calculate the sum of the differences of the cell angles from 90 degrees. More...

detid_t	getFillFirstX (const GridDetector *me, int x, int y, int z)

detid_t	getFillFirstY (const GridDetector *me, int x, int y, int z)

detid_t	getFillFirstZ (const GridDetector *me, int x, int y, int z)

MANTID_GEOMETRY_DLL gsl_matrix *	getGSLIdentityMatrix (size_t rows, size_t cols)
	Returns a GSL-indentity matrix. More...

MANTID_GEOMETRY_DLL gsl_matrix *	getGSLMatrix (const Kernel::IntMatrix &matrix)
	Returns a GSL-matrix for the given IntMatrix. More...

MANTID_GEOMETRY_DLL std::string	getIsotropicAtomBraggScattererString (const BraggScatterer_sptr &scatterer)

MANTID_GEOMETRY_DLL std::string	getLatticeSystemAsString (const PointGroup::LatticeSystem &latticeSystem)
	Returns the supplied LatticeSystem as a string. More...

MANTID_GEOMETRY_DLL PointGroup::LatticeSystem	getLatticeSystemFromString (const std::string &latticeSystem)
	Returns the lattice system enum that corresponds to the supplied string or throws an invalid_argument exception.PointGroup::LatticeSystem. More...

MANTID_GEOMETRY_DLL PointGroupCrystalSystemMap	getPointGroupsByCrystalSystem ()
	Returns a multimap with crystal system as key and point groups as values. More...

MANTID_GEOMETRY_DLL ReflectionCondition_sptr	getReflectionConditionByName (const std::string &name)
	Returns the requested ReflectionCondition, see getAllReflectionConditionNames for possible names. More...

MANTID_GEOMETRY_DLL ReflectionCondition_sptr	getReflectionConditionBySymbol (const std::string &symbol)
	Returns the ReflectionCondition for the specified centering symbol, see getAllReflectionConditionSymbols for possible symbols. More...

ReflectionCondition_sptr	getReflectionConditionWhere (const std::function< bool(const ReflectionCondition_sptr &)> &fn, const std::string &hint)
	Returns a reflection condition according to a filter function. More...

MANTID_GEOMETRY_DLL std::vector< std::string >	getTokenizedPositionString (const std::string &position)
	Returns components of comma-separated position string, cleaned from [ and ]. More...

MANTID_GEOMETRY_DLL SymmetryOperation	getUnitCellIntervalOperation (const SymmetryOperation &symOp)
	Returns a SymmetryOperation with the vector wrapped to the interval (0, 1]. More...

MANTID_GEOMETRY_DLL Kernel::V3D	getWrappedVector (const Kernel::V3D &vector)
	Returns a V3D with components on the interval (0, 1], as the version for V3R. More...

MANTID_GEOMETRY_DLL V3R	getWrappedVector (const V3R &vector)
	Wraps a V3R to the interval (0, 1]. More...

std::tuple< int, int, int >	getXYZFillFirstX (const GridDetector *me, int col, int id)

std::tuple< int, int, int >	getXYZFillFirstY (const GridDetector *me, int col, int id)

std::tuple< int, int, int >	getXYZFillFirstZ (const GridDetector *me, int col, int id)

bool MANTID_GEOMETRY_DLL	intersection (const ConvexPolygon &P, const ConvexPolygon &Q, ConvexPolygon &out)
	Compute the instersection of two convex polygons. More...

bool MANTID_GEOMETRY_DLL	isValidGeneratorString (const std::string &generatorString)
	Free function that tries to parse the given list of symmetry operations and returns true if successfull. More...

MDFrameFactory_uptr MANTID_GEOMETRY_DLL	makeMDFrameFactoryChain ()
	Make a complete factory chain. More...

MANTID_GEOMETRY_DLL bool	operator!= (const Group_const_sptr &lhs, const Group_const_sptr &rhs)
	Inequality operator for shared pointers. More...

MANTID_GEOMETRY_DLL const HKLFilter_const_sptr	operator& (const HKLFilter_const_sptr &lhs, const HKLFilter_const_sptr &rhs)
	Constructs an HKLFilterAnd from the operands. More...

MANTID_GEOMETRY_DLL Group_const_sptr	operator* (const Group_const_sptr &lhs, const Group_const_sptr &rhs)
	Convenience operator* for directly multiplying groups using shared pointers. More...

MANTID_GEOMETRY_DLL std::vector< Kernel::V3D >	operator* (const Group_const_sptr &lhs, const Kernel::V3D &rhs)
	Convenience operator* for getting a vector of V3D using shared pointers. More...

template<typename T >
V3R	operator* (const Kernel::Matrix< T > &lhs, const V3R &rhs)
	Performs a matrix multiplication v' = M * v, throws Kernel::Exception::MisMatch<size_t> if M does not have exactly 3 columns. More...

std::vector< std::string > MANTID_GEOMETRY_DLL	operator* (const SymmetryOperation &symOp, const std::vector< std::string > &strings)
	Transform a vector of strings using a symmetry operation. More...

bool	operator< (const TrackDirection left, const TrackDirection right)

std::ostream &	operator<< (std::ostream &of, const BnId &A)
	Output as a stream. More...

MANTID_GEOMETRY_DLL std::ostream &	operator<< (std::ostream &os, const BoundingBox &box)
	Print out the bounding box values to a stream. More...

MANTID_GEOMETRY_DLL std::ostream &	operator<< (std::ostream &os, const CompAssembly &ass)
	Print information about elements in the assembly to a stream Overload the operator <<. More...

std::ostream &	operator<< (std::ostream &os, const Component &comp)
	Prints a text representation. More...

MANTID_GEOMETRY_DLL std::ostream &	operator<< (std::ostream &os, const ConvexPolygon &polygon)
	Print a polygon to a stream. More...

MANTID_GEOMETRY_DLL std::ostream &	operator<< (std::ostream &os, const FitParameter &f)
	Prints the value of parameter. More...

MANTID_GEOMETRY_DLL std::ostream &	operator<< (std::ostream &os, const GridDetector &ass)
	Print information about elements in the assembly to a stream Overload the operator <<. More...

MANTID_GEOMETRY_DLL std::ostream &	operator<< (std::ostream &os, const ObjCompAssembly &ass)
	Print information about elements in the assembly to a stream Overload the operator <<. More...

MANTID_GEOMETRY_DLL std::ostream &	operator<< (std::ostream &os, const RectangularDetector &ass)
	Print information about elements in the assembly to a stream Overload the operator <<. More...

MANTID_GEOMETRY_DLL std::ostream &	operator<< (std::ostream &os, const StructuredDetector &ass)
	Print information about elements in the assembly to a stream Overload the operator <<. More...

MANTID_GEOMETRY_DLL std::ostream &	operator<< (std::ostream &os, const TrackDirection &direction)

std::ostream &	operator<< (std::ostream &os, TrackDirection direction)

MANTID_GEOMETRY_DLL std::ostream &	operator<< (std::ostream &out, const UnitCell &unitCell)

std::ostream &	operator<< (std::ostream &OX, const Acomp &A)
	Stream operator (uses Acomp::write) More...

std::ostream &	operator<< (std::ostream &OX, const Algebra &A)
	Write to standard stream. More...

std::ostream &	operator<< (std::ostream &OX, const RotaryCounter &A)
	Output stream assesor. More...

MANTID_GEOMETRY_DLL std::ostream &	operator<< (std::ostream &stream, const PointGroup &self)
	Returns a streamed representation of the PointGroup object. More...

MANTID_GEOMETRY_DLL std::ostream &	operator<< (std::ostream &stream, const SpaceGroup &self)

MANTID_GEOMETRY_DLL std::ostream &	operator<< (std::ostream &stream, const SymmetryOperation &operation)
	Stream output operator, writes the identifier to stream. More...

MANTID_GEOMETRY_DLL bool	operator== (const Group_const_sptr &lhs, const Group_const_sptr &rhs)
	Equality operator for shared pointers. More...

MANTID_GEOMETRY_DLL std::istream &	operator>> (std::istream &in, FitParameter &f)
	Reads in information about a fitting parameter. More...

MANTID_GEOMETRY_DLL std::istream &	operator>> (std::istream &stream, SymmetryOperation &operation)
	Reads identifier from stream and tries to parse as a symbol. More...

MANTID_GEOMETRY_DLL const HKLFilter_const_sptr	operator\| (const HKLFilter_const_sptr &lhs, const HKLFilter_const_sptr &rhs)
	Constructs an HKLFilterOr from the operands. More...

MANTID_GEOMETRY_DLL const HKLFilter_const_sptr	operator~ (const HKLFilter_const_sptr &filter)
	Constructs an HKLFilterNot from the operand. More...

MANTID_GEOMETRY_DLL PolygonEdge::Orientation	orientation (const PolygonEdge &focusEdge, const PolygonEdge &refEdge, double &t)
	Calculate the orientation type of one edge wrt to another. More...

template<typename T >
MatrixVectorPair< T, V3R >	parseMatrixVectorPair (const std::string &matrixVectorString)
	Tries to parse the given string. More...

int	sectionV3D (std::string &A, Mantid::Kernel::V3D &out)

void	split (const int A, int &S, int &V)
	Split a number into the sign and positive value. More...

MANTID_GEOMETRY_DLL UnitCell	strToUnitCell (const std::string &unitCellString)

std::vector< std::string >	transformReflectionConditions (const std::function< std::string(const ReflectionCondition_sptr &)> &fn)
	Helper function that transforms all ReflectionConditions to strings. More...

MANTID_GEOMETRY_DLL std::string	unitCellToStr (const UnitCell &unitCell)

Variables
static const std::string	center_types [ReducedCell::NUM_CELL_TYPES+1]
	Array of Strings specifying the centering for reduced cells for rows 1 to 44 of Table 2. More...

I a m	d

constexpr double	deg2rad = M_PI / 180.
	Defines units/enum for Crystal work. More...

Mantid::Kernel::Logger	g_log ("Goniometer")

static const std::string	lattice_types [ReducedCell::NUM_CELL_TYPES+1]
	Array of Strings specifying the cell type for reduced cells for rows 1 to 44 of Table 2. More...

z F d	m

constexpr double	rad2deg = 180. / M_PI
	Radians to degrees conversion factor. More...

static const double	transform_modifier [2][3][3]
	These transforms pre-multiply the basic transforms in certain cases, as listed in the footnotes to Table 2. More...

static const double	transforms [ReducedCell::NUM_CELL_TYPES+1][3][3]
	Array of basic transformations from reduced cell to conventional cell for rows 1 to 44 of Table 2. More...

I a m	x

I a m	y

I a m	z

Typedef Documentation

◆ AbstractSpaceGroupGenerator_sptr

using Mantid::Geometry::AbstractSpaceGroupGenerator_sptr = typedef std::shared_ptr<AbstractSpaceGroupGenerator>

Definition at line 64 of file SpaceGroupFactory.h.

◆ AbstractSymmetryElementGenerator_sptr

using Mantid::Geometry::AbstractSymmetryElementGenerator_sptr = typedef std::shared_ptr<AbstractSymmetryElementGenerator>

Definition at line 48 of file SymmetryElementFactory.h.

◆ BoundingBox_const_sptr

using Mantid::Geometry::BoundingBox_const_sptr = typedef std::shared_ptr<const BoundingBox>

A shared pointer to a const BoundingBox.

Definition at line 195 of file BoundingBox.h.

◆ BoundingBox_sptr

using Mantid::Geometry::BoundingBox_sptr = typedef std::shared_ptr<BoundingBox>

A shared pointer to a BoundingBox.

Definition at line 193 of file BoundingBox.h.

◆ BraggScatterer_sptr

using Mantid::Geometry::BraggScatterer_sptr = typedef std::shared_ptr<BraggScatterer>

Definition at line 25 of file BraggScatterer.h.

◆ BraggScattererFactory

using Mantid::Geometry::BraggScattererFactory = typedef Mantid::Kernel::SingletonHolder<BraggScattererFactoryImpl>

Definition at line 71 of file BraggScattererFactory.h.

◆ BraggScattererInCrystalStructure_sptr

using Mantid::Geometry::BraggScattererInCrystalStructure_sptr = typedef std::shared_ptr<BraggScattererInCrystalStructure>

Definition at line 60 of file BraggScattererInCrystalStructure.h.

◆ CenteringGroup_const_sptr

using Mantid::Geometry::CenteringGroup_const_sptr = typedef std::shared_ptr<const CenteringGroup>

Definition at line 54 of file CenteringGroup.h.

◆ CenteringGroup_sptr

using Mantid::Geometry::CenteringGroup_sptr = typedef std::shared_ptr<CenteringGroup>

Definition at line 53 of file CenteringGroup.h.

◆ CenteringGroupCreator

using Mantid::Geometry::CenteringGroupCreator = typedef Mantid::Kernel::SingletonHolder<CenteringGroupCreatorImpl>

Definition at line 80 of file CenteringGroup.h.

◆ component_map_cit

using Mantid::Geometry::component_map_cit = typedef tbb::concurrent_unordered_multimap<ComponentID, std::shared_ptr<Parameter> >::const_iterator

Definition at line 41 of file ParameterMap.h.

◆ component_map_it

using Mantid::Geometry::component_map_it = typedef tbb::concurrent_unordered_multimap<ComponentID, std::shared_ptr<Parameter> >::iterator

Parameter map iterator typedef.

Definition at line 40 of file ParameterMap.h.

◆ ComponentID

using Mantid::Geometry::ComponentID = typedef IComponent *

Define a type for a unique component identifier.

Definition at line 33 of file IComponent.h.

◆ ComponentInfoConstIt

using Mantid::Geometry::ComponentInfoConstIt = typedef ComponentInfoIterator<const ComponentInfo>

Definition at line 141 of file ComponentInfo.h.

◆ ComponentInfoIt

using Mantid::Geometry::ComponentInfoIt = typedef ComponentInfoIterator<ComponentInfo>

Definition at line 140 of file ComponentInfo.h.

◆ CompositeBraggScatterer_sptr

using Mantid::Geometry::CompositeBraggScatterer_sptr = typedef std::shared_ptr<CompositeBraggScatterer>

Definition at line 47 of file CompositeBraggScatterer.h.

◆ Container_const_sptr

using Mantid::Geometry::Container_const_sptr = typedef std::shared_ptr<const Container>

Typdef for a shared pointer to a const object.

Definition at line 107 of file Container.h.

◆ Container_sptr

using Mantid::Geometry::Container_sptr = typedef std::shared_ptr<Container>

Typdef for a shared pointer.

Definition at line 105 of file Container.h.

◆ CrystalStructure_sptr

using Mantid::Geometry::CrystalStructure_sptr = typedef std::shared_ptr<CrystalStructure>

Definition at line 101 of file CrystalStructure.h.

◆ CyclicGroup_const_sptr

using Mantid::Geometry::CyclicGroup_const_sptr = typedef std::shared_ptr<const CyclicGroup>

Definition at line 77 of file CyclicGroup.h.

◆ CyclicGroup_sptr

using Mantid::Geometry::CyclicGroup_sptr = typedef std::shared_ptr<CyclicGroup>

Definition at line 76 of file CyclicGroup.h.

◆ DetectorGroup_const_sptr

using Mantid::Geometry::DetectorGroup_const_sptr = typedef std::shared_ptr<const DetectorGroup>

Typedef for shared pointer to a const object.

Definition at line 235 of file DetectorGroup.h.

◆ DetectorGroup_sptr

using Mantid::Geometry::DetectorGroup_sptr = typedef std::shared_ptr<DetectorGroup>

Typedef for shared pointer.

Definition at line 233 of file DetectorGroup.h.

◆ DetectorInfoConstIt

using Mantid::Geometry::DetectorInfoConstIt = typedef DetectorInfoIterator<const DetectorInfo>

Definition at line 138 of file DetectorInfo.h.

◆ DetectorInfoIt

using Mantid::Geometry::DetectorInfoIt = typedef DetectorInfoIterator<DetectorInfo>

Definition at line 137 of file DetectorInfo.h.

◆ GridDetector_const_sptr

using Mantid::Geometry::GridDetector_const_sptr = typedef std::shared_ptr<const GridDetector>

Definition at line 207 of file GridDetector.h.

◆ GridDetector_sptr

using Mantid::Geometry::GridDetector_sptr = typedef std::shared_ptr<GridDetector>

Definition at line 206 of file GridDetector.h.

◆ Group_const_sptr

using Mantid::Geometry::Group_const_sptr = typedef std::shared_ptr<const Group>

Definition at line 179 of file Group.h.

◆ Group_sptr

using Mantid::Geometry::Group_sptr = typedef std::shared_ptr<Group>

Definition at line 178 of file Group.h.

◆ HKLFilter_const_sptr

using Mantid::Geometry::HKLFilter_const_sptr = typedef std::shared_ptr<const HKLFilter>

Definition at line 76 of file HKLFilter.h.

◆ HKLFilter_sptr

using Mantid::Geometry::HKLFilter_sptr = typedef std::shared_ptr<HKLFilter>

Definition at line 77 of file HKLFilter.h.

◆ HKLFilter_uptr

using Mantid::Geometry::HKLFilter_uptr = typedef std::unique_ptr<HKLFilter>

Definition at line 75 of file HKLFilter.h.

◆ ICompAssembly_const_sptr

using Mantid::Geometry::ICompAssembly_const_sptr = typedef std::shared_ptr<const ICompAssembly>

Shared pointer to a const ICompAssembly.

Definition at line 81 of file ICompAssembly.h.

◆ ICompAssembly_sptr

using Mantid::Geometry::ICompAssembly_sptr = typedef std::shared_ptr<ICompAssembly>

Shared pointer to a ICompAssembly.

Definition at line 79 of file ICompAssembly.h.

◆ IComponent_const_sptr

using Mantid::Geometry::IComponent_const_sptr = typedef std::shared_ptr<const IComponent>

Typdef of a shared pointer to a const IComponent.

Definition at line 161 of file IComponent.h.

◆ IComponent_sptr

using Mantid::Geometry::IComponent_sptr = typedef std::shared_ptr<IComponent>

Typedef of a shared pointer to a IComponent.

Definition at line 159 of file IComponent.h.

◆ IDetector_const_sptr

typedef std::shared_ptr< const IDetector > Mantid::Geometry::IDetector_const_sptr

Shared pointer to IDetector (const version)

Shared pointer to an const IDetector object.

Definition at line 102 of file IDetector.h.

◆ IDetector_const_uptr

using Mantid::Geometry::IDetector_const_uptr = typedef std::unique_ptr<const IDetector>

unique pointer to an IDetector (const version)

Definition at line 27 of file IDetector_fwd.h.

◆ IDetector_sptr

typedef std::shared_ptr< IDetector > Mantid::Geometry::IDetector_sptr

Shared pointer to IDetector.

Shared pointer to an IDetector object.

Definition at line 100 of file IDetector.h.

◆ IDetector_uptr

using Mantid::Geometry::IDetector_uptr = typedef std::unique_ptr<IDetector>

unique pointer to an IDetector

Definition at line 25 of file IDetector_fwd.h.

◆ IDFObject_const_sptr

using Mantid::Geometry::IDFObject_const_sptr = typedef std::shared_ptr<const AbstractIDFObject>

Definition at line 92 of file IDFObject.h.

◆ IDFObject_sptr

using Mantid::Geometry::IDFObject_sptr = typedef std::shared_ptr<AbstractIDFObject>

Definition at line 91 of file IDFObject.h.

◆ IMDDimension_const_sptr

using Mantid::Geometry::IMDDimension_const_sptr = typedef std::shared_ptr<const IMDDimension>

Shared Pointer to const IMDDimension.

Not strictly necessary since IMDDimension is pure abstract.

Definition at line 101 of file IMDDimension.h.

◆ IMDDimension_sptr

using Mantid::Geometry::IMDDimension_sptr = typedef std::shared_ptr<IMDDimension>

Shared Pointer for IMDDimension. Frequently used type in framework.

Definition at line 98 of file IMDDimension.h.

◆ Instrument_const_sptr

using Mantid::Geometry::Instrument_const_sptr = typedef std::shared_ptr<const Instrument>

Shared pointer to an const instrument object.

Definition at line 23 of file Instrument_fwd.h.

◆ Instrument_const_uptr

using Mantid::Geometry::Instrument_const_uptr = typedef std::unique_ptr<const Instrument>

unique pointer to an instrument (const version)

Definition at line 27 of file Instrument_fwd.h.

◆ Instrument_sptr

using Mantid::Geometry::Instrument_sptr = typedef std::shared_ptr<Instrument>

Shared pointer to an instrument object.

Definition at line 21 of file Instrument_fwd.h.

◆ Instrument_uptr

using Mantid::Geometry::Instrument_uptr = typedef std::unique_ptr<Instrument>

unique pointer to an instrument

Definition at line 25 of file Instrument_fwd.h.

◆ InstrumentParameterCache

using Mantid::Geometry::InstrumentParameterCache = typedef std::map<std::pair<std::string, const IComponent *>, std::shared_ptr<XMLInstrumentParameter> >

Convenience typedef.

Definition at line 36 of file Instrument.h.

◆ IObjComponent_const_sptr

using Mantid::Geometry::IObjComponent_const_sptr = typedef std::shared_ptr<const IObjComponent>

Shared pointer to IObjComponent (const version)

Definition at line 108 of file IObjComponent.h.

◆ IObjComponent_sptr

using Mantid::Geometry::IObjComponent_sptr = typedef std::shared_ptr<IObjComponent>

Shared pointer to IObjComponent.

Definition at line 106 of file IObjComponent.h.

◆ IObject_const_sptr

using Mantid::Geometry::IObject_const_sptr = typedef std::shared_ptr<const IObject>

Typdef for a shared pointer to a const object.

Definition at line 94 of file IObject.h.

◆ IObject_const_uptr

using Mantid::Geometry::IObject_const_uptr = typedef std::unique_ptr<const IObject>

Typdef for a unique pointer to a const object.

Definition at line 98 of file IObject.h.

◆ IObject_sptr

using Mantid::Geometry::IObject_sptr = typedef std::shared_ptr<IObject>

Typdef for a shared pointer.

Definition at line 92 of file IObject.h.

◆ IObject_uptr

using Mantid::Geometry::IObject_uptr = typedef std::unique_ptr<IObject>

Typdef for a unique pointer.

Definition at line 96 of file IObject.h.

◆ IPeak_uptr

using Mantid::Geometry::IPeak_uptr = typedef std::unique_ptr<IPeak>

Definition at line 103 of file IPeak.h.

◆ IsotropicAtomBraggScatterer_sptr

typedef std::shared_ptr< IsotropicAtomBraggScatterer > Mantid::Geometry::IsotropicAtomBraggScatterer_sptr

Definition at line 18 of file IsotropicAtomBraggScatterer.h.

◆ Links

using Mantid::Geometry::Links = typedef Track::LType

Typedef for object intersections.

Definition at line 27 of file InstrumentRayTracer.h.

◆ MDFrame_const_sptr

using Mantid::Geometry::MDFrame_const_sptr = typedef std::shared_ptr<const MDFrame>

Definition at line 39 of file MDFrame.h.

◆ MDFrame_const_uptr

using Mantid::Geometry::MDFrame_const_uptr = typedef std::unique_ptr<const MDFrame>

Definition at line 37 of file MDFrame.h.

◆ MDFrame_sptr

using Mantid::Geometry::MDFrame_sptr = typedef std::shared_ptr<MDFrame>

Definition at line 38 of file MDFrame.h.

◆ MDFrame_uptr

using Mantid::Geometry::MDFrame_uptr = typedef std::unique_ptr<MDFrame>

Definition at line 36 of file MDFrame.h.

◆ MDFrameFactory_uptr

using Mantid::Geometry::MDFrameFactory_uptr = typedef std::unique_ptr<MDFrameFactory>

Helper typedef.

Definition at line 37 of file MDFrameFactory.h.

◆ MDHistoDimension_const_sptr

using Mantid::Geometry::MDHistoDimension_const_sptr = typedef std::shared_ptr<const MDHistoDimension>

Shared pointer to a const MDHistoDimension.

Definition at line 151 of file MDHistoDimension.h.

◆ MDHistoDimension_sptr

using Mantid::Geometry::MDHistoDimension_sptr = typedef std::shared_ptr<MDHistoDimension>

Shared pointer to a MDHistoDimension.

Definition at line 148 of file MDHistoDimension.h.

◆ MDImplicitFunction_sptr

using Mantid::Geometry::MDImplicitFunction_sptr = typedef std::shared_ptr<MDImplicitFunction>

Definition at line 278 of file MDImplicitFunction.h.

◆ ObjCompAssembly_const_sptr

using Mantid::Geometry::ObjCompAssembly_const_sptr = typedef std::shared_ptr<const ObjCompAssembly>

Shared pointer to ObjCompAssembly (const version)

Definition at line 96 of file ObjCompAssembly.h.

◆ ObjCompAssembly_sptr

using Mantid::Geometry::ObjCompAssembly_sptr = typedef std::shared_ptr<ObjCompAssembly>

Shared pointer to ObjCompAssembly.

Definition at line 94 of file ObjCompAssembly.h.

◆ Parameter_sptr

using Mantid::Geometry::Parameter_sptr = typedef std::shared_ptr<Parameter>

Typedef for the shared pointer.

Definition at line 195 of file Parameter.h.

◆ ParameterMap_const_sptr

using Mantid::Geometry::ParameterMap_const_sptr = typedef std::shared_ptr<const ParameterMap>

ParameterMap constant shared pointer typedef.

Definition at line 337 of file ParameterMap.h.

◆ ParameterMap_sptr

using Mantid::Geometry::ParameterMap_sptr = typedef std::shared_ptr<ParameterMap>

ParameterMap shared pointer typedef.

Definition at line 335 of file ParameterMap.h.

◆ ParsedRationalNumber

using Mantid::Geometry::ParsedRationalNumber = typedef boost::fusion::vector<int, boost::optional<int> >

Definition at line 21 of file MatrixVectorPairParser.h.

◆ PeakShape_const_sptr

using Mantid::Geometry::PeakShape_const_sptr = typedef std::shared_ptr<const PeakShape>

Definition at line 43 of file PeakShape.h.

◆ PeakShape_sptr

using Mantid::Geometry::PeakShape_sptr = typedef std::shared_ptr<PeakShape>

Definition at line 42 of file PeakShape.h.

◆ PeakTransform_const_sptr

using Mantid::Geometry::PeakTransform_const_sptr = typedef std::shared_ptr<const PeakTransform>

Definition at line 60 of file PeakTransform.h.

◆ PeakTransform_sptr

using Mantid::Geometry::PeakTransform_sptr = typedef std::shared_ptr<PeakTransform>

Typedef for a PeakTransform wrapped in a shared_pointer.

Definition at line 59 of file PeakTransform.h.

◆ PeakTransformFactory_sptr

using Mantid::Geometry::PeakTransformFactory_sptr = typedef std::shared_ptr<PeakTransformFactory>

Factory Shared Pointer typedef.

Definition at line 26 of file PeakTransformFactory.h.

◆ PeakTransformHKLFactory

using Mantid::Geometry::PeakTransformHKLFactory = typedef ConcretePeakTransformFactory<PeakTransformHKL>

Typedef a factory for type of PeaksTransform.

Definition at line 36 of file PeakTransformHKL.h.

◆ PeakTransformQLabFactory

using Mantid::Geometry::PeakTransformQLabFactory = typedef ConcretePeakTransformFactory<PeakTransformQLab>

Typedef a factory for type of PeaksTransform.

Definition at line 36 of file PeakTransformQLab.h.

◆ PeakTransformQSampleFactory

using Mantid::Geometry::PeakTransformQSampleFactory = typedef ConcretePeakTransformFactory<PeakTransformQSample>

Typedef a factory for type of PeaksTransform.

Definition at line 36 of file PeakTransformQSample.h.

◆ PointGroup_sptr

using Mantid::Geometry::PointGroup_sptr = typedef std::shared_ptr<PointGroup>

Shared pointer to a PointGroup.

Definition at line 67 of file PointGroup.h.

◆ PointGroupCrystalSystemMap

using Mantid::Geometry::PointGroupCrystalSystemMap = typedef std::multimap<PointGroup::CrystalSystem, PointGroup_sptr, CrystalSystemComparator>

Definition at line 91 of file PointGroup.h.

◆ PointGroupFactory

using Mantid::Geometry::PointGroupFactory = typedef Mantid::Kernel::SingletonHolder<PointGroupFactoryImpl>

Definition at line 97 of file PointGroupFactory.h.

◆ PointGroupGenerator_sptr

using Mantid::Geometry::PointGroupGenerator_sptr = typedef std::shared_ptr<PointGroupGenerator>

Definition at line 42 of file PointGroupFactory.h.

◆ RationalNumber

using Mantid::Geometry::RationalNumber = typedef boost::rational<int>

V3R :

In crystallography, many operations use rational numbers like 1/2, 1/4 or 2/3. Floating point numbers can approximate these, but calculations involving these approximations are never exact.

V3R is a vector with three rational components, implemented using boost::rational<int>. This way, crystallographic calculations involving fractional vectors may be carried out exactly (for example symmetry operations with a translational component).

Author: Michael Wedel, Paul Scherrer Institut - SINQ

Date: 26/09/2014

Definition at line 35 of file V3R.h.

◆ RectangularDetector_const_sptr

using Mantid::Geometry::RectangularDetector_const_sptr = typedef std::shared_ptr<const RectangularDetector>

Definition at line 95 of file RectangularDetector.h.

◆ RectangularDetector_sptr

using Mantid::Geometry::RectangularDetector_sptr = typedef std::shared_ptr<RectangularDetector>

Definition at line 94 of file RectangularDetector.h.

◆ ReflectionCondition_sptr

using Mantid::Geometry::ReflectionCondition_sptr = typedef std::shared_ptr<ReflectionCondition>

Shared pointer to a ReflectionCondition.

Definition at line 152 of file ReflectionCondition.h.

◆ ReflectionConditions

using Mantid::Geometry::ReflectionConditions = typedef std::vector<ReflectionCondition_sptr>

A collection of reflections.

Definition at line 154 of file ReflectionCondition.h.

◆ SampleEnvironment_const_uptr

using Mantid::Geometry::SampleEnvironment_const_uptr = typedef std::unique_ptr<const SampleEnvironment>

Definition at line 68 of file SampleEnvironment.h.

◆ SampleEnvironment_uptr

using Mantid::Geometry::SampleEnvironment_uptr = typedef std::unique_ptr<SampleEnvironment>

Definition at line 66 of file SampleEnvironment.h.

◆ SpaceGroup_const_sptr

using Mantid::Geometry::SpaceGroup_const_sptr = typedef std::shared_ptr<const SpaceGroup>

Definition at line 82 of file SpaceGroup.h.

◆ SpaceGroup_sptr

using Mantid::Geometry::SpaceGroup_sptr = typedef std::shared_ptr<SpaceGroup>

Definition at line 81 of file SpaceGroup.h.

◆ SpaceGroupFactory

using Mantid::Geometry::SpaceGroupFactory = typedef Mantid::Kernel::SingletonHolder<SpaceGroupFactoryImpl>

Definition at line 226 of file SpaceGroupFactory.h.

◆ StructuredDetector_const_sptr

using Mantid::Geometry::StructuredDetector_const_sptr = typedef std::shared_ptr<const StructuredDetector>

Definition at line 173 of file StructuredDetector.h.

◆ StructuredDetector_sptr

using Mantid::Geometry::StructuredDetector_sptr = typedef std::shared_ptr<StructuredDetector>

Definition at line 172 of file StructuredDetector.h.

◆ StructureFactor

using Mantid::Geometry::StructureFactor = typedef std::complex<double>

Definition at line 21 of file BraggScatterer.h.

◆ StructureFactorCalculator_sptr

using Mantid::Geometry::StructureFactorCalculator_sptr = typedef std::shared_ptr<StructureFactorCalculator>

Definition at line 43 of file StructureFactorCalculator.h.

◆ StructureFactorSummation_sptr

using Mantid::Geometry::StructureFactorSummation_sptr = typedef std::shared_ptr<StructureFactorCalculatorSummation>

Definition at line 39 of file StructureFactorCalculatorSummation.h.

◆ SymmetryElement_sptr

using Mantid::Geometry::SymmetryElement_sptr = typedef std::shared_ptr<SymmetryElement>

Definition at line 53 of file SymmetryElement.h.

◆ SymmetryElementFactory

using Mantid::Geometry::SymmetryElementFactory = typedef Mantid::Kernel::SingletonHolder<SymmetryElementFactoryImpl>

Definition at line 223 of file SymmetryElementFactory.h.

◆ SymmetryElementIdentity_sptr

using Mantid::Geometry::SymmetryElementIdentity_sptr = typedef std::shared_ptr<SymmetryElementIdentity>

Definition at line 67 of file SymmetryElement.h.

◆ SymmetryElementInversion_sptr

using Mantid::Geometry::SymmetryElementInversion_sptr = typedef std::shared_ptr<SymmetryElementInversion>

Definition at line 88 of file SymmetryElement.h.

◆ SymmetryElementMirror_sptr

using Mantid::Geometry::SymmetryElementMirror_sptr = typedef std::shared_ptr<SymmetryElementMirror>

Definition at line 184 of file SymmetryElement.h.

◆ SymmetryElementRotation_sptr

using Mantid::Geometry::SymmetryElementRotation_sptr = typedef std::shared_ptr<SymmetryElementRotation>

Definition at line 166 of file SymmetryElement.h.

◆ SymmetryElementTranslation_sptr

using Mantid::Geometry::SymmetryElementTranslation_sptr = typedef std::shared_ptr<SymmetryElementTranslation>

Definition at line 109 of file SymmetryElement.h.

◆ SymmetryElementWithAxis_sptr

using Mantid::Geometry::SymmetryElementWithAxis_sptr = typedef std::shared_ptr<SymmetryElementWithAxis>

Definition at line 135 of file SymmetryElement.h.

◆ SymmetryOperationFactory

using Mantid::Geometry::SymmetryOperationFactory = typedef Mantid::Kernel::SingletonHolder<SymmetryOperationFactoryImpl>

Definition at line 65 of file SymmetryOperationFactory.h.

◆ Vec_MDHistoDimensionBuilder

using Mantid::Geometry::Vec_MDHistoDimensionBuilder = typedef std::vector<MDHistoDimensionBuilder>

Handy typedef for collection of builders.

Definition at line 86 of file MDHistoDimensionBuilder.h.

◆ VecIMDDimension_const_sptr

using Mantid::Geometry::VecIMDDimension_const_sptr = typedef std::vector<IMDDimension_const_sptr>

Vector of constant shared pointers to IMDDimensions.

Definition at line 103 of file IMDDimension.h.

◆ VecIMDDimension_sptr

using Mantid::Geometry::VecIMDDimension_sptr = typedef std::vector<IMDDimension_sptr>

Vector of shared pointers to IMDDimensions.

Definition at line 105 of file IMDDimension.h.

Enumeration Type Documentation

◆ AngleUnits

enum Mantid::Geometry::AngleUnits

Flag for angle units used in UnitCell class.

Enumerator
angDegrees
angRadians

Definition at line 26 of file AngleUnits.h.

◆ det_topology

enum Mantid::Geometry::det_topology

Describes the topology of a detectors group used to calculate angular position and angular measures for detectors.

The topology defines the meaning of angular measurements for a detector

Enumerator
rect
cyl
undef

Definition at line 31 of file IDetector.h.

◆ Handedness

enum Mantid::Geometry::Handedness

Type to distingusih between l and r handedness.

Enumerator
Left
Right

Definition at line 18 of file ReferenceFrame.h.

◆ PointClassification

enum Mantid::Geometry::PointClassification

Enumeration for point type w.r.t an edge.

Enumerator
OnLeft	Point is to left of edge.
OnRight	Point is to right of edge.
Beyond	Point is right of edge destination.
Behind	Point is left of edge origin.
Between	Point is between edge origin and destination.
Origin	Point equals edge origin.
Destination	Point equals edge destination.

Definition at line 58 of file PolygonEdge.h.

◆ PointingAlong

enum Mantid::Geometry::PointingAlong

Type to describe pointing along options.

Enumerator
X
Y
Z

Definition at line 16 of file ReferenceFrame.h.

◆ ReflectionConditionFilter

enum struct Mantid::Geometry::ReflectionConditionFilter

strong

Enumerator
None
Centering
SpaceGroup
StructureFactor

Definition at line 17 of file ReflectionGenerator.h.

◆ RotationSense

enum Mantid::Geometry::RotationSense

Enumerator
CW
CCW	Clockwise rotation.

Definition at line 32 of file Goniometer.h.

◆ TrackDirection

enum class Mantid::Geometry::TrackDirection

strong

Enumerator
LEAVING
INVALID
ENTERING

Definition at line 91 of file Track.h.

Function Documentation

◆ axisNameToAxisType()

PointingAlong Mantid::Geometry::axisNameToAxisType	(	const std::string &	label,
		const std::string &	input
	)

Definition at line 922 of file InstrumentDefinitionParser.cpp.

References X, Y, and Z.

Referenced by Mantid::Geometry::InstrumentDefinitionParser::readDefaults().

◆ checkValidOrderString()

bool Mantid::Geometry::checkValidOrderString ( const std::string & order )

Definition at line 488 of file GridDetector.cpp.

Referenced by Mantid::Geometry::GridDetector::validateInput().

◆ classify()

PointClassification Mantid::Geometry::classify	(	const V2D &	pt,
		const PolygonEdge &	edge
	)

Helper function for classification.

Classify a point with respect to an edge, i.e.

left, right of edge etc.

Parameters

pt	:: A point as V2D
edge	:: A test edge object

Returns: The type of the point

Definition at line 47 of file PolygonEdge.cpp.

References Behind, Between, Beyond, Destination, Mantid::Geometry::PolygonEdge::direction(), Mantid::Geometry::PolygonEdge::end(), Mantid::Kernel::V2D::norm(), OnLeft, OnRight, Origin, Mantid::Geometry::PolygonEdge::start(), Mantid::Kernel::V2D::X(), and Mantid::Kernel::V2D::Y().

Referenced by Mantid::Geometry::ConvexPolygon::contains(), intersection(), and orientation().

◆ CompareABCsum()

static bool Mantid::Geometry::CompareABCsum	(	const DblMatrix &	UB_1,
		const DblMatrix &	UB_2
	)

static

Comparator function for sorting list of UB matrices based on the sum of the lengths of the corresponding real space cell edge lengths |a|+|b|+|C|.

Definition at line 26 of file NiggliCell.cpp.

References Mantid::Geometry::OrientedLattice::GetABC(), and Mantid::Kernel::V3D::norm().

Referenced by Mantid::Geometry::NiggliCell::MakeNiggliUB().

◆ CompareDiffFrom90()

static bool Mantid::Geometry::CompareDiffFrom90	(	const DblMatrix &	UB_1,
		const DblMatrix &	UB_2
	)

static

Comparator to sort a list of UBs in decreasing order based on the difference of cell angles from 90 degrees.

Definition at line 70 of file NiggliCell.cpp.

References GetDiffFrom90Sum().

Referenced by Mantid::Geometry::NiggliCell::MakeNiggliUB().

◆ convertMatrix()

template<typename T , typename U >

Kernel::Matrix< T > Mantid::Geometry::convertMatrix ( const Kernel::Matrix< U > & matrix )

Definition at line 159 of file SymmetryOperation.h.

References Mantid::Kernel::Matrix< T >::numCols(), and Mantid::Kernel::Matrix< T >::numRows().

◆ createDimension() [1/3]

IMDDimension_sptr Mantid::Geometry::createDimension ( const Poco::XML::Element & dimensionXML )

Create a dimension from the provided XML element.

Definition at line 41 of file IMDDimensionFactory.cpp.

References makeMDFrameFactoryChain().

◆ createDimension() [2/3]

IMDDimension_sptr Mantid::Geometry::createDimension ( const std::string & dimensionXMLString )

Creates IMDDimension objects based on input XML.

Create a dimension object from the provided XML string.

Parameters

dimensionXMLString The XML string

Exceptions

Poco::XML::SAXParseException If the provided string is not valid XML

Returns: The created dimension.

Definition at line 27 of file IMDDimensionFactory.cpp.

References createDimension().

Referenced by createDimension(), Mantid::Geometry::MDGeometryXMLParser::execute(), and Mantid::MDAlgorithms::LoadMD::loadDimensions().

◆ createDimension() [3/3]

IMDDimension_sptr Mantid::Geometry::createDimension	(	const std::string &	dimensionXMLString,
		int	nBins,
		coord_t	min,
		coord_t	max
	)

Create a dimension object from the provided XML string, overriding certain attributes.

Parameters

dimensionXMLString	The XML string from which to construct the dimension object.
nBins	The number of bins to set on the dimension object.
min	The minimum extent to set on the dimension.
max	The maximum extent to set on the dimension.

Returns: The created dimension.

Definition at line 127 of file IMDDimensionFactory.cpp.

References createDimension().

◆ crossingPoint()

PolygonEdge::Orientation Mantid::Geometry::crossingPoint	(	const PolygonEdge &	edgeOne,
		const PolygonEdge &	edgeTwo,
		V2D &	crossPoint
	)

Calculate the crossing point of one edge with wrt another.

Calculate the crossing point of this edge with another.

Parameters

edgeOne	:: The first polygon edge
edgeTwo	:: The second polygon edge
crossPoint	[Out] :: If found the point of intersection is filled here

Definition at line 104 of file PolygonEdge.cpp.

References Mantid::Geometry::PolygonEdge::Collinear, Mantid::Geometry::PolygonEdge::direction(), Mantid::Geometry::PolygonEdge::end(), EPSILON(), Mantid::Kernel::gtEquals(), Mantid::Kernel::ltEquals(), Mantid::Kernel::V2D::norm(), orientation(), Mantid::Geometry::PolygonEdge::Parallel, Mantid::Geometry::PolygonEdge::point(), Mantid::Geometry::PolygonEdge::SkewCross, Mantid::Geometry::PolygonEdge::SkewNoCross, and Mantid::Geometry::PolygonEdge::start().

Referenced by intersection().

◆ DECLARE_GENERATED_SPACE_GROUP() [1/2]

Mantid::Geometry::DECLARE_GENERATED_SPACE_GROUP	(	137	,
		"P 42/n m c"	,
		"-	x,
		-	y,
		z;-y+1/	2,
		x+1/	2,
		z+1/2;-x+1/	2,
		y+1/	2,
		-z+1/2;-x+1/	2,
		-y+1/	2,
		-z+1/2"
	)

◆ DECLARE_GENERATED_SPACE_GROUP() [2/2]

z Mantid::Geometry::DECLARE_GENERATED_SPACE_GROUP	(	142	,
		"I 41/a c d"	,
		"-x+1/	2,
		-y+1/	2,
		z+1/2;-	y,
		x+1/	2,
		z+1/4;-x+1/	2,
		y	,
		-z+1/4;-	x,
		-y+1/	2,
		-z+1/4"
	)

◆ edgeAimsAt()

bool Mantid::Geometry::edgeAimsAt	(	const PolygonEdge &	a,
		const PolygonEdge &	b,
		PointClassification	aclass,
		PolygonEdge::Orientation	crossType
	)

Return if the edges aim at each other.

Parameters

a	:: First edge
b	:: Second edge
aclass	:: The point classification of a point on edge a
crossType	:: The edge orientation classification

Definition at line 145 of file PolygonEdge.cpp.

References Beyond, Mantid::Geometry::PolygonEdge::Collinear, Mantid::Geometry::PolygonEdge::direction(), Mantid::Kernel::gtEquals(), OnLeft, OnRight, and Mantid::Kernel::V2D::X().

Referenced by intersection().

◆ edgePixel()

bool Mantid::Geometry::edgePixel	(	const Mantid::Geometry::Instrument_const_sptr &	inst,
		const std::string &	bankName,
		int	col,
		int	row,
		int	Edge
	)

Function to find peaks near detector edge.

Parameters

inst	Instrument
bankName	Name of detector bank
col	Column number containing peak
row	Row number containing peak
Edge	Number of edge points for each bank

Returns: True if peak is on edge

Definition at line 22 of file EdgePixel.cpp.

References getName().

Referenced by Mantid::MDAlgorithms::FindPeaksMD::addPeak(), Mantid::Crystal::PredictPeaks::calculateQAndAddToOutput(), Mantid::Crystal::OptimizeLatticeForCellType::exec(), Mantid::MDAlgorithms::FindPeaksMD::findPeaks(), Mantid::Crystal::CentroidPeaks::integrate(), Mantid::Crystal::CentroidPeaks::integrateEvent(), and Mantid::Crystal::CentroidPeaks::removeEdgePeaks().

◆ getAllPointGroups()

std::vector< PointGroup_sptr > Mantid::Geometry::getAllPointGroups ( )

Returns: a vector with all possible PointGroup objects

Definition at line 195 of file PointGroup.cpp.

References Mantid::Kernel::SingletonHolder< T >::Instance().

Referenced by getPointGroupsByCrystalSystem().

◆ getAllReflectionConditionNames()

std::vector< std::string > Mantid::Geometry::getAllReflectionConditionNames ( )

Returns all ReflectionCondition names.

Definition at line 58 of file ReflectionCondition.cpp.

References transformReflectionConditions().

◆ getAllReflectionConditions()

const ReflectionConditions & Mantid::Geometry::getAllReflectionConditions ( )

Returns: a vector with all possible ReflectionCondition objects

Definition at line 33 of file ReflectionCondition.cpp.

Referenced by Mantid::Crystal::PredictFractionalPeaks::exec(), getReflectionConditionWhere(), Mantid::Crystal::PredictFractionalPeaks::init(), Mantid::Crystal::StatisticsOfPeaksWorkspace::init(), Mantid::Geometry::CrystalStructure::setReflectionConditionFromSpaceGroup(), and transformReflectionConditions().

◆ getAllReflectionConditionSymbols()

std::vector< std::string > Mantid::Geometry::getAllReflectionConditionSymbols ( )

Returns all centering symbols.

Definition at line 63 of file ReflectionCondition.cpp.

References transformReflectionConditions().

Referenced by Mantid::Crystal::CountReflections::init().

◆ getCrystalSystemAsString()

std::string Mantid::Geometry::getCrystalSystemAsString ( const PointGroup::CrystalSystem & crystalSystem )

Return a human-readable string for the given crystal system.

Definition at line 219 of file PointGroup.cpp.

References Mantid::Geometry::PointGroup::Cubic, Mantid::Geometry::PointGroup::Hexagonal, Mantid::Geometry::PointGroup::Monoclinic, Mantid::Geometry::PointGroup::Orthorhombic, Mantid::Geometry::PointGroup::Tetragonal, and Mantid::Geometry::PointGroup::Trigonal.

Referenced by operator<<().

◆ getCrystalSystemFromString()

PointGroup::CrystalSystem Mantid::Geometry::getCrystalSystemFromString ( const std::string & crystalSystem )

Returns the crystal system enum that corresponds to the supplied string or throws an invalid_argument exception.

Definition at line 240 of file PointGroup.cpp.

References Mantid::Geometry::PointGroup::Cubic, Mantid::Geometry::PointGroup::Hexagonal, Mantid::Geometry::PointGroup::Monoclinic, Mantid::Geometry::PointGroup::Orthorhombic, Mantid::Geometry::PointGroup::Tetragonal, Mantid::Geometry::PointGroup::Triclinic, and Mantid::Geometry::PointGroup::Trigonal.

◆ GetDiffFrom90Sum()

static double Mantid::Geometry::GetDiffFrom90Sum ( const DblMatrix & UB )

static

Get the cell angles for the unit cell corresponding to matrix UB and calculate the sum of the differences of the cell angles from 90 degrees.

Parameters

UB	the UB matrix

Returns: The sum of the difference of the cell angles from 90 degrees.

Definition at line 49 of file NiggliCell.cpp.

References Mantid::Kernel::V3D::angle(), fabs, and Mantid::Geometry::OrientedLattice::GetABC().

Referenced by CompareDiffFrom90().

◆ getFillFirstX()

detid_t Mantid::Geometry::getFillFirstX	(	const GridDetector *	me,
		int	x,
		int	y,
		int	z
	)

Definition at line 138 of file GridDetector.cpp.

References Mantid::Geometry::GridDetector::idFillOrder(), Mantid::Geometry::GridDetector::idstart(), Mantid::Geometry::GridDetector::idstep(), Mantid::Geometry::GridDetector::idstepbyrow(), x, y, Mantid::Geometry::GridDetector::ypixels(), z, and Mantid::Geometry::GridDetector::zpixels().

Referenced by Mantid::Geometry::GridDetector::getDetectorIDAtXYZ().

◆ getFillFirstY()

detid_t Mantid::Geometry::getFillFirstY	(	const GridDetector *	me,
		int	x,
		int	y,
		int	z
	)

Definition at line 131 of file GridDetector.cpp.

References Mantid::Geometry::GridDetector::idFillOrder(), Mantid::Geometry::GridDetector::idstart(), Mantid::Geometry::GridDetector::idstep(), Mantid::Geometry::GridDetector::idstepbyrow(), x, Mantid::Geometry::GridDetector::xpixels(), y, z, and Mantid::Geometry::GridDetector::zpixels().

Referenced by Mantid::Geometry::GridDetector::getDetectorIDAtXYZ().

◆ getFillFirstZ()

detid_t Mantid::Geometry::getFillFirstZ	(	const GridDetector *	me,
		int	x,
		int	y,
		int	z
	)

Definition at line 124 of file GridDetector.cpp.

References Mantid::Geometry::GridDetector::idFillOrder(), Mantid::Geometry::GridDetector::idstart(), Mantid::Geometry::GridDetector::idstep(), Mantid::Geometry::GridDetector::idstepbyrow(), x, Mantid::Geometry::GridDetector::xpixels(), y, Mantid::Geometry::GridDetector::ypixels(), and z.

Referenced by Mantid::Geometry::GridDetector::getDetectorIDAtXYZ().

◆ getGSLIdentityMatrix()

gsl_matrix * Mantid::Geometry::getGSLIdentityMatrix	(	size_t	rows,
		size_t	cols
	)

Returns a GSL-indentity matrix.

This free function returns a GSL-matrix with the provided dimensions. It allocates the memory using gsl_matrix_alloc and the caller of the function is responsible for freeing the memory again.

Parameters

rows	:: Number of rows in the matrix.
cols	:: Number of columns in the matrix.

Returns: Identity matrix with dimensions (rows, columns).

Definition at line 94 of file SymmetryElementFactory.cpp.

Referenced by Mantid::Geometry::SymmetryElementWithAxisGenerator::determineAxis().

◆ getGSLMatrix()

gsl_matrix * Mantid::Geometry::getGSLMatrix ( const Kernel::IntMatrix & matrix )

Returns a GSL-matrix for the given IntMatrix.

This free function takes an IntMatrix and returns a GSL-matrix with the data. It allocates the memory using gsl_matrix_alloc and the caller of the function is responsible for freeing the memory again.

Parameters

matrix :: Kernel::IntMatrix.

Returns: GSL-matrix containing the same data as the input matrix.

Definition at line 71 of file SymmetryElementFactory.cpp.

References Mantid::Kernel::Matrix< T >::numCols(), and Mantid::Kernel::Matrix< T >::numRows().

Referenced by Mantid::Geometry::SymmetryElementWithAxisGenerator::determineAxis().

◆ getIsotropicAtomBraggScattererString()

std::string Mantid::Geometry::getIsotropicAtomBraggScattererString ( const BraggScatterer_sptr & scatterer )

Definition at line 191 of file IsotropicAtomBraggScatterer.cpp.

References getTokenizedPositionString().

◆ getLatticeSystemAsString()

std::string Mantid::Geometry::getLatticeSystemAsString ( const PointGroup::LatticeSystem & latticeSystem )

Returns the supplied LatticeSystem as a string.

Definition at line 263 of file PointGroup.cpp.

References Mantid::Geometry::PointGroup::Cubic, Mantid::Geometry::PointGroup::Hexagonal, Mantid::Geometry::PointGroup::Monoclinic, Mantid::Geometry::PointGroup::Orthorhombic, Mantid::Geometry::PointGroup::Rhombohedral, and Mantid::Geometry::PointGroup::Tetragonal.

Referenced by operator<<().

◆ getLatticeSystemFromString()

PointGroup::LatticeSystem Mantid::Geometry::getLatticeSystemFromString ( const std::string & latticeSystem )

Returns the lattice system enum that corresponds to the supplied string or throws an invalid_argument exception.PointGroup::LatticeSystem.

Definition at line 284 of file PointGroup.cpp.

References Mantid::Geometry::PointGroup::Cubic, Mantid::Geometry::PointGroup::Hexagonal, Mantid::Geometry::PointGroup::Monoclinic, Mantid::Geometry::PointGroup::Orthorhombic, Mantid::Geometry::PointGroup::Rhombohedral, Mantid::Geometry::PointGroup::Tetragonal, and Mantid::Geometry::PointGroup::Triclinic.

Referenced by Mantid::CurveFitting::Functions::PawleyParameterFunction::setLatticeSystem().

◆ getPointGroupsByCrystalSystem()

PointGroupCrystalSystemMap Mantid::Geometry::getPointGroupsByCrystalSystem ( )

Returns a multimap with crystal system as key and point groups as values.

Definition at line 206 of file PointGroup.cpp.

References getAllPointGroups().

◆ getReflectionConditionByName()

ReflectionCondition_sptr Mantid::Geometry::getReflectionConditionByName ( const std::string & name )

Returns the requested ReflectionCondition, see getAllReflectionConditionNames for possible names.

Definition at line 96 of file ReflectionCondition.cpp.

References getReflectionConditionWhere().

◆ getReflectionConditionBySymbol()

ReflectionCondition_sptr Mantid::Geometry::getReflectionConditionBySymbol ( const std::string & symbol )

Returns the ReflectionCondition for the specified centering symbol, see getAllReflectionConditionSymbols for possible symbols.

Definition at line 103 of file ReflectionCondition.cpp.

References getReflectionConditionWhere().

Referenced by Mantid::Crystal::CountReflections::exec().

◆ getReflectionConditionWhere()

ReflectionCondition_sptr Mantid::Geometry::getReflectionConditionWhere	(	const std::function< bool(const ReflectionCondition_sptr &)> &	fn,
		const std::string &	hint
	)

Returns a reflection condition according to a filter function.

This small helper function returns a ReflectionCondition_sptr for which the supplied function returns true. If no ReflectionCondition is found, an std::invalid_argument exception is thrown. The message of the exception contains the hint-parameter, which could be string that was used as a matching criterion to find the ReflectionCondition.

Parameters

fn	:: Unary predicate for matching ReflectionCondition
hint	:: Hint to include in exception message. Name or symbol.

Returns: ReflectionCondition for which fn matches.

Definition at line 81 of file ReflectionCondition.cpp.

References getAllReflectionConditions().

Referenced by getReflectionConditionByName(), and getReflectionConditionBySymbol().

◆ getTokenizedPositionString()

std::vector< std::string > Mantid::Geometry::getTokenizedPositionString ( const std::string & position )

Returns components of comma-separated position string, cleaned from [ and ].

Definition at line 117 of file BraggScattererInCrystalStructure.cpp.

References position.

Referenced by getIsotropicAtomBraggScattererString(), and Mantid::Geometry::BraggScattererInCrystalStructure::getPositionFromString().

◆ getUnitCellIntervalOperation()

SymmetryOperation Mantid::Geometry::getUnitCellIntervalOperation ( const SymmetryOperation & symOp )

Returns a SymmetryOperation with the vector wrapped to the interval (0, 1].

Definition at line 317 of file SymmetryOperation.cpp.

References getWrappedVector(), Mantid::Geometry::SymmetryOperation::matrix(), and Mantid::Geometry::SymmetryOperation::vector().

Referenced by Mantid::Geometry::Group::setSymmetryOperations().

◆ getWrappedVector() [1/2]

Kernel::V3D Mantid::Geometry::getWrappedVector ( const Kernel::V3D & vector )

Returns a V3D with components on the interval (0, 1], as the version for V3R.

Definition at line 278 of file SymmetryOperation.cpp.

◆ getWrappedVector() [2/2]

V3R Mantid::Geometry::getWrappedVector ( const V3R & vector )

Wraps a V3R to the interval (0, 1].

For certain crystallographic calculations it is necessary to constrain fractional coordinates to the unit cell, for example to generate all atomic positions in the cell. In this context, the fractional coordinate -0.45 is equal to "0.55 of the next cell", so it's transformed to 0.55.

Parameters

vector :: Input vector with arbitrary numbers.

Returns: Vector with components on the interval (0, 1]

Definition at line 262 of file SymmetryOperation.cpp.

Referenced by Mantid::Geometry::SpaceGroup::getSiteSymmetryGroup(), getUnitCellIntervalOperation(), Mantid::Geometry::BraggScattererInCrystalStructure::setPosition(), and Mantid::Geometry::GroupTransformation::transformOperation().

◆ getXYZFillFirstX()

std::tuple< int, int, int > Mantid::Geometry::getXYZFillFirstX	(	const GridDetector *	me,
		int	col,
		int	id
	)

Definition at line 193 of file GridDetector.cpp.

References Mantid::Geometry::GridDetector::idFillOrder(), Mantid::Geometry::GridDetector::idstepbyrow(), Mantid::Geometry::GridDetector::ypixels(), and Mantid::Geometry::GridDetector::zpixels().

Referenced by Mantid::Geometry::GridDetector::getXYZForDetectorID().

◆ getXYZFillFirstY()

std::tuple< int, int, int > Mantid::Geometry::getXYZFillFirstY	(	const GridDetector *	me,
		int	col,
		int	id
	)

Definition at line 181 of file GridDetector.cpp.

References Mantid::Geometry::GridDetector::idFillOrder(), Mantid::Geometry::GridDetector::idstepbyrow(), Mantid::Geometry::GridDetector::xpixels(), and Mantid::Geometry::GridDetector::zpixels().

Referenced by Mantid::Geometry::GridDetector::getXYZForDetectorID().

◆ getXYZFillFirstZ()

std::tuple< int, int, int > Mantid::Geometry::getXYZFillFirstZ	(	const GridDetector *	me,
		int	col,
		int	id
	)

Definition at line 169 of file GridDetector.cpp.

References Mantid::Geometry::GridDetector::idFillOrder(), Mantid::Geometry::GridDetector::idstepbyrow(), Mantid::Geometry::GridDetector::xpixels(), and Mantid::Geometry::GridDetector::ypixels().

Referenced by Mantid::Geometry::GridDetector::getXYZForDetectorID().

◆ intersection()

bool MANTID_GEOMETRY_DLL Mantid::Geometry::intersection	(	const ConvexPolygon &	P,
		const ConvexPolygon &	Q,
		ConvexPolygon &	out
	)

Compute the instersection of two convex polygons.

The intersection is computed using the method described by Michael Laszlo in "Computational Geometry and Computer Graphics in C++" by Michael J.

Laszlo. It assumes that each polygon is closed and has no holes.

Parameters

P	First polygon
Q	Second polygon
out	A reference to the object to fill with the intersections. The object is not touched with the exception of appending vertices for the calculated overlap. If the same object is reused with multiple calculations this must be handled by the user.

Returns: True if a valid intersection was found, false otherwise

Definition at line 85 of file PolygonIntersection.cpp.

References Mantid::Geometry::ConvexPolygon::area(), Behind, classify(), Mantid::Geometry::PolygonEdge::Collinear, Mantid::Geometry::ConvexPolygon::contains(), crossingPoint(), Mantid::Geometry::ConvexPolygon::Iterator::edge(), edgeAimsAt(), Mantid::Geometry::PolygonEdge::end(), Mantid::Geometry::ConvexPolygon::insert(), intersection(), Mantid::Geometry::ConvexPolygon::isValid(), Mantid::Geometry::ConvexPolygon::npoints(), OnLeft, OnRight, Mantid::Geometry::PolygonEdge::SkewCross, Mantid::Geometry::PolygonEdge::start(), Mantid::Geometry::ConvexPolygon::toPoly(), VERBOSE, Mantid::Kernel::V2D::X(), and Mantid::Kernel::V2D::Y().

Referenced by Mantid::DataObjects::FractionalRebinning::calcGeneralIntersections(), Mantid::Algorithms::XrayAbsorptionCorrection::calculateMuonPos(), Mantid::Geometry::MeshObject2D::distance(), Mantid::Geometry::MeshObject::distance(), Mantid::Geometry::MeshObject::getIntersections(), Mantid::Geometry::MeshObject2D::interceptSurface(), intersection(), Mantid::Geometry::MeshObjectCommon::rayIntersectsTriangle(), and Mantid::DataObjects::FractionalRebinning::rebinToOutput().

◆ isValidGeneratorString()

bool Mantid::Geometry::isValidGeneratorString ( const std::string & generatorString )

Free function that tries to parse the given list of symmetry operations and returns true if successfull.

Definition at line 25 of file SpaceGroupFactory.cpp.

References Mantid::Geometry::SymmetryOperationSymbolParser::parseIdentifier().

Referenced by Mantid::Geometry::AlgorithmicSpaceGroupGenerator::AlgorithmicSpaceGroupGenerator(), and Mantid::Geometry::TabulatedSpaceGroupGenerator::TabulatedSpaceGroupGenerator().

◆ makeMDFrameFactoryChain()

MDFrameFactory_uptr Mantid::Geometry::makeMDFrameFactoryChain ( )

Make a complete factory chain.

Definition at line 86 of file MDFrameFactory.cpp.

Referenced by createDimension(), Mantid::MDAlgorithms::CreateMDWorkspace::createMDFrame(), Mantid::MDAlgorithms::ImportMDHistoWorkspaceBase::createMDFrame(), Mantid::MDAlgorithms::SetMDFrame::createMDFrame(), Mantid::Geometry::MDHistoDimensionBuilder::createRaw(), Mantid::MDAlgorithms::ConvertToDiffractionMDWorkspace::exec(), Mantid::MDAlgorithms::MDWSDescription::getFrame(), Mantid::MDAlgorithms::LoadMD::loadDimensions2(), and Mantid::MDAlgorithms::MDNorm::setQUnit().

◆ operator!=()

bool Mantid::Geometry::operator!=	(	const Group_const_sptr &	lhs,
		const Group_const_sptr &	rhs
	)

Inequality operator for shared pointers.

Definition at line 275 of file Group.cpp.

References operator==(), and rhs.

◆ operator&()

const HKLFilter_const_sptr Mantid::Geometry::operator&	(	const HKLFilter_const_sptr &	lhs,
		const HKLFilter_const_sptr &	rhs
	)

Constructs an HKLFilterAnd from the operands.

This function makes it easy to construct HKLFilterAnd by using the operator & directly on HKLFilter_const_sptr.

Parameters

lhs	:: Left-hand side HKLFilter operand.
rhs	:: Right-hand side HKLFilter operand.

Returns: HKLFilterAnd with two wrapped filters.

Definition at line 94 of file HKLFilter.cpp.

References rhs.

◆ operator*() [1/4]

Group_const_sptr Mantid::Geometry::operator*	(	const Group_const_sptr &	lhs,
		const Group_const_sptr &	rhs
	)

Convenience operator* for directly multiplying groups using shared pointers.

Definition at line 248 of file Group.cpp.

References rhs.

◆ operator*() [2/4]

std::vector< Kernel::V3D > Mantid::Geometry::operator*	(	const Group_const_sptr &	lhs,
		const Kernel::V3D &	rhs
	)

Convenience operator* for getting a vector of V3D using shared pointers.

Definition at line 257 of file Group.cpp.

References rhs.

◆ operator*() [3/4]

template<typename T >

V3R Mantid::Geometry::operator*	(	const Kernel::Matrix< T > &	lhs,
		const V3R &	rhs
	)

Performs a matrix multiplication v' = M * v, throws Kernel::Exception::MisMatch<size_t> if M does not have exactly 3 columns.

Definition at line 115 of file V3R.h.

References Mantid::Kernel::Matrix< T >::numCols(), Mantid::Kernel::Matrix< T >::numRows(), and rhs.

◆ operator*() [4/4]

std::vector< std::string > Mantid::Geometry::operator*	(	const SymmetryOperation &	symOp,
		const std::vector< std::string > &	strings
	)

Transform a vector of strings using a symmetry operation.

This operator uses the matrix of the supplied symmetry operation to transform the supplied vector of strings. For example

z,x,y * {a, b, c} -> c, a, b

Only the first three elements of the vector are considered, the rest is appended untransformed. Negative indices are transformed to positive, so basically this is a way to get all permutations of the first three elements of the vector.

Parameters

symOp	:: SymmetryOperation to use for transformation.
strings	:: String array to be transformed.

Returns

Definition at line 57 of file SpaceGroupFactory.cpp.

References index, and Mantid::Geometry::SymmetryOperation::matrix().

◆ operator<()

bool Mantid::Geometry::operator<	(	const TrackDirection	left,
		const TrackDirection	right
	)

inline

Definition at line 93 of file Track.h.

References left, and right.

◆ operator<<() [1/19]

std::ostream & Mantid::Geometry::operator<<	(	std::ostream &	of,
		const BnId &	A
	)

Output as a stream.

Parameters

of	:: Reference to the output stream
A	:: The object to output

Returns: stream representation

Definition at line 27 of file BnId.cpp.

References Mantid::Geometry::BnId::display().

◆ operator<<() [2/19]

std::ostream & Mantid::Geometry::operator<<	(	std::ostream &	os,
		const BoundingBox &	box
	)

Print out the bounding box values to a stream.

Parameters

os	:: The output stream
box	:: A reference to the bounding box to print out.

Returns: the stream representation of the bounding box

Definition at line 267 of file BoundingBox.cpp.

References Mantid::Geometry::BoundingBox::xMax(), Mantid::Geometry::BoundingBox::xMin(), Mantid::Geometry::BoundingBox::yMax(), Mantid::Geometry::BoundingBox::yMin(), Mantid::Geometry::BoundingBox::zMax(), and Mantid::Geometry::BoundingBox::zMin().

◆ operator<<() [3/19]

std::ostream & Mantid::Geometry::operator<<	(	std::ostream &	os,
		const CompAssembly &	ass
	)

Print information about elements in the assembly to a stream Overload the operator <<.

Parameters

os	:: output stream
ass	:: component assembly

Returns: stream representation of component assembly

Loops through all components in the assembly and call printSelf(os). Also output the number of children

Definition at line 498 of file CompAssembly.cpp.

References Mantid::Geometry::CompAssembly::nelements(), Mantid::Geometry::CompAssembly::printChildren(), and Mantid::Geometry::Component::printSelf().

◆ operator<<() [4/19]

std::ostream & Mantid::Geometry::operator<<	(	std::ostream &	os,
		const Component &	comp
	)

Prints a text representation.

Parameters

os	:: The output stream to write to
comp	:: The Component to output

Returns: The output stream

Definition at line 527 of file Component.cpp.

References Mantid::Geometry::Component::printSelf().

◆ operator<<() [5/19]

std::ostream & Mantid::Geometry::operator<<	(	std::ostream &	os,
		const ConvexPolygon &	polygon
	)

Print a polygon to a stream.

The vertices are output in the order defined by the object

Parameters

os	:: A reference to an output stream
polygon	:: A reference to the polygon to output to the stream

Returns: A reference to the input stream

Definition at line 230 of file ConvexPolygon.cpp.

References Mantid::Geometry::ConvexPolygon::npoints().

◆ operator<<() [6/19]

std::ostream & Mantid::Geometry::operator<<	(	std::ostream &	os,
		const FitParameter &	f
	)

Prints the value of parameter.

Parameters

os	:: the Stream to output to
f	:: the FitParameter to output

Returns: the output stream

Definition at line 131 of file FitParameter.cpp.

References Mantid::Geometry::FitParameter::printSelf().

◆ operator<<() [7/19]

std::ostream & Mantid::Geometry::operator<<	(	std::ostream &	os,
		const GridDetector &	ass
	)

Print information about elements in the assembly to a stream Overload the operator <<.

Parameters

os	:: output stream
ass	:: component assembly

Returns: stream representation of grid detector

Loops through all components in the assembly and call printSelf(os). Also output the number of children

Definition at line 855 of file GridDetector.cpp.

References Mantid::Geometry::CompAssembly::nelements(), Mantid::Geometry::CompAssembly::printChildren(), and Mantid::Geometry::IComponent::printSelf().

◆ operator<<() [8/19]

std::ostream & Mantid::Geometry::operator<<	(	std::ostream &	os,
		const ObjCompAssembly &	ass
	)

Print information about elements in the assembly to a stream Overload the operator <<.

Parameters

os	:: output stream
ass	:: component assembly

Returns: the stream representation of the object component assembly Loops through all components in the assembly and call printSelf(os). Also output the number of children

Definition at line 607 of file ObjCompAssembly.cpp.

References Mantid::Geometry::ObjCompAssembly::nelements(), Mantid::Geometry::ObjCompAssembly::printChildren(), and Mantid::Geometry::IComponent::printSelf().

◆ operator<<() [9/19]

std::ostream & Mantid::Geometry::operator<<	(	std::ostream &	os,
		const RectangularDetector &	ass
	)

Print information about elements in the assembly to a stream Overload the operator <<.

Parameters

os	:: output stream
ass	:: component assembly

Returns: stream representation of rectangular detector

Loops through all components in the assembly and call printSelf(os). Also output the number of children

Definition at line 288 of file RectangularDetector.cpp.

References Mantid::Geometry::CompAssembly::nelements(), Mantid::Geometry::CompAssembly::printChildren(), and Mantid::Geometry::IComponent::printSelf().

◆ operator<<() [10/19]

std::ostream & Mantid::Geometry::operator<<	(	std::ostream &	os,
		const StructuredDetector &	ass
	)

Print information about elements in the assembly to a stream Overload the operator <<.

Parameters

os	:: output stream
ass	:: component assembly

Returns: stream representation of structured detector

Loops through all components in the assembly and call printSelf(os). Also output the number of children

Definition at line 604 of file StructuredDetector.cpp.

References Mantid::Geometry::CompAssembly::nelements(), Mantid::Geometry::CompAssembly::printChildren(), and Mantid::Geometry::IComponent::printSelf().

◆ operator<<() [11/19]

MANTID_GEOMETRY_DLL std::ostream & Mantid::Geometry::operator<<	(	std::ostream &	os,
		const TrackDirection &	direction
	)

◆ operator<<() [12/19]

std::ostream & Mantid::Geometry::operator<<	(	std::ostream &	os,
		TrackDirection	direction
	)

Definition at line 259 of file Track.cpp.

References ENTERING, INVALID, and LEAVING.

◆ operator<<() [13/19]

std::ostream & Mantid::Geometry::operator<<	(	std::ostream &	out,
		const UnitCell &	unitCell
	)

Definition at line 865 of file UnitCell.cpp.

◆ operator<<() [14/19]

std::ostream & Mantid::Geometry::operator<<	(	std::ostream &	OX,
		const Acomp &	A
	)

Stream operator (uses Acomp::write)

Parameters

OX	:: output stream
A	:: Acomp unit to output

Returns: Output stream

Definition at line 29 of file Acomp.cpp.

References Mantid::Geometry::Acomp::display().

◆ operator<<() [15/19]

std::ostream & Mantid::Geometry::operator<<	(	std::ostream &	OX,
		const Algebra &	A
	)

Write to standard stream.

Parameters

OX	:: Output stream
A	:: Algebra to write

Returns: stream representation

Definition at line 29 of file Algebra.cpp.

References Mantid::Geometry::Algebra::display().

◆ operator<<() [16/19]

std::ostream & Mantid::Geometry::operator<<	(	std::ostream &	OX,
		const RotaryCounter &	A
	)

Output stream assesor.

Parameters

OX	:: Output stream
A	:: RotaryCounter to writeout

Returns: the ouput stream

Definition at line 14 of file RotCounter.cpp.

◆ operator<<() [17/19]

std::ostream & Mantid::Geometry::operator<<	(	std::ostream &	stream,
		const PointGroup &	self
	)

Returns a streamed representation of the PointGroup object.

Definition at line 312 of file PointGroup.cpp.

References Mantid::Geometry::PointGroup::crystalSystem(), getCrystalSystemAsString(), getLatticeSystemAsString(), Mantid::Geometry::PointGroup::getSymbol(), and Mantid::Geometry::PointGroup::latticeSystem().

◆ operator<<() [18/19]

std::ostream & Mantid::Geometry::operator<<	(	std::ostream &	stream,
		const SpaceGroup &	self
	)

Definition at line 110 of file SpaceGroup.cpp.

References Mantid::Geometry::SpaceGroup::hmSymbol().

◆ operator<<() [19/19]

std::ostream & Mantid::Geometry::operator<<	(	std::ostream &	stream,
		const SymmetryOperation &	operation
	)

Stream output operator, writes the identifier to stream.

Definition at line 293 of file SymmetryOperation.cpp.

References Mantid::Geometry::SymmetryOperation::identifier().

◆ operator==()

bool Mantid::Geometry::operator==	(	const Group_const_sptr &	lhs,
		const Group_const_sptr &	rhs
	)

Equality operator for shared pointers.

Definition at line 266 of file Group.cpp.

References rhs.

Referenced by Mantid::Geometry::Acomp::operator!=(), and operator!=().

◆ operator>>() [1/2]

std::istream & Mantid::Geometry::operator>>	(	std::istream &	in,
		FitParameter &	f
	)

Reads in information about a fitting parameter.

The expected format is a comma separated list of 3 or more entries. The list will be read according to:

1st (0) : parameter value (which is converted to float) 2nd (1) : fitting function this parameter belong to 3rd (2) : parameter name 4th (3) : constrain min 5th (4) : constrain max 6th (5) : constrain penalty factor 7th (6) : set tie 8th (7) : set formula 9th (8) : set formula unit 10th (9) : set result unit 11th onwards (10-) : read lookup table values

Information about fitting <parameter> can be found on www.mantidproject.org/IDF. Note also printSelf() does the reverse of the this method, i.e. print of the information of a parameter as listed above.

Parameters

in	:: Input Stream
f	:: FitParameter to write to

Returns: Current state of stream

Definition at line 162 of file FitParameter.cpp.

◆ operator>>() [2/2]

std::istream & Mantid::Geometry::operator>>	(	std::istream &	stream,
		SymmetryOperation &	operation
	)

Reads identifier from stream and tries to parse as a symbol.

Definition at line 300 of file SymmetryOperation.cpp.

◆ operator|()

const HKLFilter_const_sptr Mantid::Geometry::operator\|	(	const HKLFilter_const_sptr &	lhs,
		const HKLFilter_const_sptr &	rhs
	)

Constructs an HKLFilterOr from the operands.

This function makes it easy to construct HKLFilterOr by using the operator | directly on HKLFilter_const_sptr.

Parameters

lhs	:: Left-hand side HKLFilter operand.
rhs	:: Right-hand side HKLFilter operand.

Returns: HKLFilterOr with two wrapped filters.

Definition at line 108 of file HKLFilter.cpp.

References rhs.

◆ operator~()

const HKLFilter_const_sptr Mantid::Geometry::operator~ ( const HKLFilter_const_sptr & filter )

Constructs an HKLFilterNot from the operand.

This function makes it easy to construct HKLFilterNot by using the operator ~, which inverts the wrapped filter.

Parameters

filter :: HKLFilter to invert.

Returns: HKLFilterNot with the wrapped filter.

Definition at line 80 of file HKLFilter.cpp.

◆ orientation()

PolygonEdge::Orientation Mantid::Geometry::orientation	(	const PolygonEdge &	focusEdge,
		const PolygonEdge &	refEdge,
		double &	t
	)

Calculate the orientation type of one edge wrt to another.

Calculate the orientation type of this edge with another.

Parameters

focusEdge	:: A reference to the PolygonEdge to test
refEdge	:: A reference to another PolygonEdge object to compare with
t	[Out] :: If an intersection is found this value is set to the ratio of the dot products between the normal to the other line

Returns: An enumeration denoting the orientation type

Definition at line 81 of file PolygonEdge.cpp.

References classify(), Mantid::Geometry::PolygonEdge::Collinear, Mantid::Geometry::PolygonEdge::direction(), Mantid::Geometry::PolygonEdge::end(), Mantid::Kernel::equals(), OnLeft, OnRight, Mantid::Geometry::PolygonEdge::Parallel, Mantid::Kernel::V2D::scalar_prod(), Mantid::Geometry::PolygonEdge::Skew, Mantid::Geometry::PolygonEdge::start(), Mantid::Kernel::V2D::X(), and Mantid::Kernel::V2D::Y().

Referenced by crossingPoint(), Mantid::Algorithms::SumRowColumn::exec(), Mantid::Algorithms::SumRowColumn::init(), Mantid::DataHandling::LoadMuonNexusV2NexusHelper::loadMainFieldDirectionFromNexus(), and Mantid::DataHandling::LoadMuonNexus1::runLoadLog().

◆ parseMatrixVectorPair()

template<typename T >

MatrixVectorPair< T, V3R > Mantid::Geometry::parseMatrixVectorPair ( const std::string & matrixVectorString )

Tries to parse the given string.

Throws a ParseError-exception if there is unparsable string left at the end.

Definition at line 238 of file MatrixVectorPairParser.h.

References Mantid::Geometry::MatrixVectorPairBuilder::getMatrixVectorPair().

◆ sectionV3D()

int Mantid::Geometry::sectionV3D	(	std::string &	A,
		Mantid::Kernel::V3D &	out
	)

Definition at line 108 of file Torus.cpp.

Referenced by Mantid::Geometry::Torus::setSurface().

◆ split()

void Mantid::Geometry::split	(	const int	A,
		int &	S,
		int &	V
	)

Split a number into the sign and positive value.

Parameters

A	:: number to split
S	:: sign value +/- 1
V	:: abs(A)

Definition at line 42 of file Acomp.cpp.

References split().

Referenced by Mantid::Geometry::Acomp::addUnit(), Mantid::Geometry::Acomp::display(), Mantid::Geometry::Acomp::displayDepth(), Mantid::DataHandling::SaveFocusedXYE::exec(), Mantid::DataHandling::SaveGSS::exec(), Mantid::Kernel::TimeSeriesProperty< TYPE >::expandFilterToRange(), Mantid::Geometry::Acomp::getAbsLiterals(), Mantid::Geometry::Acomp::isTrue(), Mantid::Kernel::TimeSeriesProperty< TYPE >::makeFilterByValue(), Mantid::Algorithms::GeneratePeaks::processTableColumnNames(), split(), and Mantid::DataHandling::SaveGSS::validateInputs().

◆ strToUnitCell()

UnitCell Mantid::Geometry::strToUnitCell ( const std::string & unitCellString )

Definition at line 896 of file UnitCell.cpp.

References Mantid::Kernel::StringTokenizer::cbegin(), Mantid::Kernel::StringTokenizer::cend(), Mantid::Kernel::StringTokenizer::size(), and Mantid::Kernel::StringTokenizer::TOK_IGNORE_EMPTY.

Referenced by Mantid::Geometry::BraggScattererInCrystalStructure::afterPropertySet(), Mantid::Geometry::CrystalStructure::CrystalStructure(), Mantid::CurveFitting::Functions::PawleyFunction::setUnitCell(), and Mantid::CurveFitting::LatticeFunction::setUnitCell().

◆ transformReflectionConditions()

std::vector< std::string > Mantid::Geometry::transformReflectionConditions ( const std::function< std::string(const ReflectionCondition_sptr &)> & fn )

Helper function that transforms all ReflectionConditions to strings.

Definition at line 47 of file ReflectionCondition.cpp.

References getAllReflectionConditions().

Referenced by getAllReflectionConditionNames(), and getAllReflectionConditionSymbols().

◆ unitCellToStr()

std::string Mantid::Geometry::unitCellToStr ( const UnitCell & unitCell )

Definition at line 886 of file UnitCell.cpp.

References Mantid::Geometry::UnitCell::a(), Mantid::Geometry::UnitCell::alpha(), Mantid::Geometry::UnitCell::b(), Mantid::Geometry::UnitCell::beta(), Mantid::Geometry::UnitCell::c(), and Mantid::Geometry::UnitCell::gamma().

Referenced by Mantid::Geometry::CrystalStructure::assignUnitCellToScatterers(), and Mantid::CurveFitting::Algorithms::PawleyFit::exec().

Variable Documentation

◆ center_types

const std::string Mantid::Geometry::center_types[ReducedCell::NUM_CELL_TYPES+1]

static

Array of Strings specifying the centering for reduced cells for rows 1 to 44 of Table 2.

This array is indexed by the row number 1 to 44. Entry 0 is the String "None".

Definition at line 149 of file ReducedCell.cpp.

Referenced by Mantid::Geometry::ReducedCell::init().

◆ d

I a m Mantid::Geometry::d

Definition at line 674 of file SpaceGroupFactory.cpp.

◆ deg2rad

constexpr double Mantid::Geometry::deg2rad = M_PI / 180.

constexpr

Defines units/enum for Crystal work.

Degrees to radians conversion factor

Definition at line 20 of file AngleUnits.h.

◆ g_log

Mantid::Kernel::Logger Mantid::Geometry::g_log("Goniometer") ( "Goniometer" )

◆ lattice_types

const std::string Mantid::Geometry::lattice_types[ReducedCell::NUM_CELL_TYPES+1]

static

Array of Strings specifying the cell type for reduced cells for rows 1 to 44 of Table 2.

This array is indexed by the row number 1 to 44. Entry 0 is the String "None".

Definition at line 89 of file ReducedCell.cpp.

Referenced by Mantid::Geometry::ReducedCell::init().

◆ m

z F d Mantid::Geometry::m

Definition at line 803 of file SpaceGroupFactory.cpp.

◆ rad2deg

constexpr double Mantid::Geometry::rad2deg = 180. / M_PI

constexpr

Radians to degrees conversion factor.

Definition at line 23 of file AngleUnits.h.

◆ transform_modifier

const double Mantid::Geometry::transform_modifier[2][3][3]

static

Initial value:

= {{{0, 0, -1}, {0, 1, 0}, {1, 0, 1}},

{{-1, 0, -1}, {0, 1, 0}, {1, 0, 0}}}

These transforms pre-multiply the basic transforms in certain cases, as listed in the footnotes to Table 2.

Definition at line 81 of file ReducedCell.cpp.

Referenced by Mantid::Geometry::ReducedCell::premultiply().

◆ transforms

const double Mantid::Geometry::transforms[ReducedCell::NUM_CELL_TYPES+1][3][3]

static

Array of basic transformations from reduced cell to conventional cell for rows 1 to 44 of Table 2.

This array is indexed by the row number 1 to 44. Entry 0 is the identity matrix.

Definition at line 21 of file ReducedCell.cpp.

Referenced by Mantid::Geometry::ReducedCell::init().

◆ x

z F d Mantid::Geometry::x

Definition at line 675 of file SpaceGroupFactory.cpp.

◆ y

z F d Mantid::Geometry::y

Definition at line 675 of file SpaceGroupFactory.cpp.

◆ z

z F d Mantid::Geometry::z

Definition at line 675 of file SpaceGroupFactory.cpp.

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ AbstractSpaceGroupGenerator_sptr

◆ AbstractSymmetryElementGenerator_sptr

◆ BoundingBox_const_sptr

◆ BoundingBox_sptr

◆ BraggScatterer_sptr

◆ BraggScattererFactory

◆ BraggScattererInCrystalStructure_sptr

◆ CenteringGroup_const_sptr

◆ CenteringGroup_sptr

◆ CenteringGroupCreator

◆ component_map_cit

◆ component_map_it

◆ ComponentID

◆ ComponentInfoConstIt

◆ ComponentInfoIt

◆ CompositeBraggScatterer_sptr

◆ Container_const_sptr

◆ Container_sptr

◆ CrystalStructure_sptr

◆ CyclicGroup_const_sptr

◆ CyclicGroup_sptr

◆ DetectorGroup_const_sptr

◆ DetectorGroup_sptr

◆ DetectorInfoConstIt

◆ DetectorInfoIt

◆ GridDetector_const_sptr

◆ GridDetector_sptr

◆ Group_const_sptr

◆ Group_sptr

◆ HKLFilter_const_sptr

◆ HKLFilter_sptr

◆ HKLFilter_uptr

◆ ICompAssembly_const_sptr

◆ ICompAssembly_sptr

◆ IComponent_const_sptr

◆ IComponent_sptr

◆ IDetector_const_sptr

◆ IDetector_const_uptr

◆ IDetector_sptr

◆ IDetector_uptr

◆ IDFObject_const_sptr

◆ IDFObject_sptr

◆ IMDDimension_const_sptr

◆ IMDDimension_sptr

◆ Instrument_const_sptr

◆ Instrument_const_uptr

◆ Instrument_sptr

◆ Instrument_uptr

◆ InstrumentParameterCache

◆ IObjComponent_const_sptr

◆ IObjComponent_sptr

◆ IObject_const_sptr

◆ IObject_const_uptr

◆ IObject_sptr

◆ IObject_uptr

◆ IPeak_uptr

◆ IsotropicAtomBraggScatterer_sptr

◆ Links

◆ MDFrame_const_sptr

◆ MDFrame_const_uptr

◆ MDFrame_sptr

◆ MDFrame_uptr

◆ MDFrameFactory_uptr

◆ MDHistoDimension_const_sptr

◆ MDHistoDimension_sptr

◆ MDImplicitFunction_sptr

◆ ObjCompAssembly_const_sptr

◆ ObjCompAssembly_sptr

◆ Parameter_sptr

◆ ParameterMap_const_sptr

◆ ParameterMap_sptr

◆ ParsedRationalNumber

◆ PeakShape_const_sptr