Holds a collection of detectors. More...

#include <DetectorGroup.h>

Inheritance diagram for Mantid::Geometry::DetectorGroup:

Public Member Functions
void	addDetector (const IDetector_const_sptr &det)
	Add a detector to the collection. More...

IDetector *	cloneParameterized (const ParameterMap *) const override
	Create a cloned instance with a parameter map applied. More...

	DetectorGroup ()
	Default constructor. More...

	DetectorGroup (const std::vector< IDetector_const_sptr > &dets)
	Constructor that takes a list of detectors to add. More...

void	getBoundingBox (BoundingBox &boundingBox) const override
	Get the bounding box for this component and store it in the given argument. More...

std::vector< detid_t >	getDetectorIDs () const
	What detectors are contained in the group? More...

std::vector< IDetector_const_sptr >	getDetectors () const
	What detectors are contained in the group? More...

double	getDistance (const IComponent &comp) const override
	Gives the average distance of a group of detectors from the given component. More...

detid_t	getID () const override
	Get the detector ID. More...

double	getPhi () const override
	Computes the average position and returns the phi value. More...

double	getPhiOffset (const double &offset) const override
	Computes the average position and returns the phi value. More...

int	getPointInObject (Kernel::V3D &point) const override
	Try to find a point that lies within (or on) the object. More...

Kernel::V3D	getPos () const override
	Returns the position of the DetectorGroup. More...

double	getSignedTwoTheta (const Kernel::V3D &observer, const Kernel::V3D &axis, const Kernel::V3D &instrumentUp) const override
	Gives the signed angle of this detector object with respect to an axis. More...

double	getTwoTheta (const Kernel::V3D &observer, const Kernel::V3D &axis) const override
	Gives the average angle of a group of detectors from the observation point, relative to the axis given. More...

bool	isOnSide (const Kernel::V3D &point) const override
	Does the point given lie on the surface of one of the detectors. More...

bool	isParametrized () const override
	Return true if any detector in the group is parametrized. More...

bool	isValid (const Kernel::V3D &point) const override
	isValid() is true if the point is inside any of the detectors, i.e. More...

std::size_t	nDets () const override
	Get the number of physical detectors this object represents. More...

double	solidAngle (const Kernel::V3D &observer) const override
	Gives the total solid angle subtended by a group of detectors by summing the contributions from the individual detectors. More...

Public Member Functions inherited from Mantid::Geometry::IDetector
virtual IDetector *	cloneParameterized (const ParameterMap *map) const =0
	Create a cloned instance with a parameter map applied. More...

double	getDistance (const IComponent &comp) const override=0
	Get the distance of this detector object from another Component. More...

virtual detid_t	getID () const =0
	Get the detector ID. More...

virtual double	getPhi () const =0
	Gives the phi of this detector object in radians. More...

virtual double	getPhiOffset (const double &offset) const =0
	Gives the phi of this detector offset from y=0 by offset. More...

virtual double	getSignedTwoTheta (const Kernel::V3D &observer, const Kernel::V3D &axis, const Kernel::V3D &instrumentUp) const =0
	Gives the signed angle of this detector object with respect to an axis. More...

virtual det_topology	getTopology (Kernel::V3D &center) const =0
	returns the geometry of detectors, meaningful for groups, rectangular for single; returns the centre of a detector More...

virtual double	getTwoTheta (const Kernel::V3D &observer, const Kernel::V3D &axis) const =0
	Gives the angle of this detector object with respect to an axis. More...

	IDetector ()
	(Empty) Constructor. More...

virtual size_t	index () const =0
	Helper for legacy access mode. Returns the index of the detector. More...

virtual std::size_t	nDets () const =0
	Get the number of physical detectors this object represents. More...

virtual const ParameterMap &	parameterMap () const =0
	Helper for legacy access mode. Returns a reference to the ParameterMap. More...

Public Member Functions inherited from Mantid::Geometry::IObjComponent
IComponent *	clone () const override=0
	Virtual Copy Constructor. More...

virtual void	draw () const =0
	Draws the objcomponent. More...

virtual void	drawObject () const =0
	Draws the Object. More...

virtual int	getPointInObject (Kernel::V3D &point) const =0
	Try to find a point that lies within (or on) the object. More...

GeometryHandler *	Handle () const
	Gets the GeometryHandler. More...

virtual void	initDraw () const =0
	Initializes the ObjComponent for rendering, this function should be called before rendering. More...

virtual int	interceptSurface (Track &track) const =0
	Checks whether the track given will pass through this Component. More...

	IObjComponent ()

	IObjComponent (const IObjComponent &)
	Copy constructor. More...

	IObjComponent (GeometryHandler *the_handler)
	Constructor, specifying the GeometryHandler (renderer engine) for this IObjComponent. More...

virtual bool	isOnSide (const Kernel::V3D &point) const =0
	Does the point given lie on the surface of this object component? More...

virtual bool	isValid (const Kernel::V3D &point) const =0
	Does the point given lie within this object component? More...

virtual const Kernel::Material	material () const =0
	Returns the material of the Object. More...

IObjComponent &	operator= (const IObjComponent &rhs)
	Assignment operator. More...

virtual const std::shared_ptr< const IObject >	shape () const =0
	Returns the shape of the Object. More...

virtual double	solidAngle (const Kernel::V3D &observer) const =0
	Finds the approximate solid angle covered by the component when viewed from the point given. More...

std::string	type () const override
	type string More...

	~IObjComponent () override

Public Member Functions inherited from Mantid::Geometry::IComponent
virtual IComponent *	clone () const =0
	Return a clone to the current object. More...

virtual std::vector< std::shared_ptr< const IComponent > >	getAncestors () const =0
	Return an array of all ancestors, the nearest first. More...

virtual const IComponent *	getBareParent () const =0
	Returns the bare pointer to the IComponent parent. More...

virtual IComponent const *	getBaseComponent () const =0
	Returns const pointer to base component if this component is parametrized. More...

virtual void	getBoundingBox (BoundingBox &boundingBox) const =0
	Get the bounding box for this component and store it in the given argument. More...

virtual ComponentID	getComponentID () const =0
	Returns the ComponentID - a unique identifier of the component. More...

virtual double	getDistance (const IComponent &) const =0
	Get the distance to another IComponent. More...

virtual std::string	getFullName () const =0
	Get the IComponent full path name. More...

virtual std::string	getName () const =0
	Get the IComponent name. More...

virtual std::shared_ptr< const IComponent >	getParent () const =0
	Return a pointer to the current parent. More...

virtual Kernel::V3D	getPos () const =0
	Get the position of the IComponent. Tree structure is traverse through the. More...

virtual Kernel::V3D	getRelativePos () const =0
	Get the position relative to the parent IComponent (absolute if no parent) More...

virtual Kernel::Quat	getRelativeRot () const =0
	Get the relative Orientation. More...

virtual Kernel::Quat	getRotation () const =0
	Get the absolute orientation of the IComponent. More...

virtual Kernel::V3D	getScaleFactor () const
	Gets the scaling factor of the object for the Object Component. More...

virtual void	rotate (const Kernel::Quat &)=0
	Rotate the IComponent. This is relative to parent. More...

virtual void	rotate (double, const Kernel::V3D &)=0
	Rotate the IComponent by an angle in degrees with respect to an axis. More...

virtual void	setName (const std::string &)=0
	Set the IComponent name. More...

virtual void	setParent (IComponent *)=0
	Assign a parent IComponent. Previous parent link is lost. More...

virtual void	setPos (const Kernel::V3D &)=0
	Set the position of the component The position is with respect to the parent component. More...

virtual void	setPos (double, double, double)=0
	Set the IComponent position, x, y, z respective to parent (if present) More...

virtual void	setRot (const Kernel::Quat &)=0
	Set the orientation Kernel::Quaternion relative to parent (if present) More...

virtual void	translate (const Kernel::V3D &)=0
	Copy the Rotation from another IComponent. More...

virtual void	translate (double, double, double)=0
	Translate the IComponent (x,y,z form). This is relative to parent if. More...

virtual std::string	type () const
	Returns a string representation of the IComponent type. More...

virtual	~IComponent ()=default
	Destructor. More...

ParameterMap access
using	DetCollection = std::map< int, IDetector_const_sptr >
	The type of collection used for the detectors. More...

int	m_id
	The ID of this effective detector. More...

DetCollection	m_detectors
	The collection of grouped detectors. More...

det_topology	group_topology
	the parameter describes the topology of the detector's group namely if detectors form a box or a ring. More...

Kernel::V3D	groupCentre
	group centre is the geometrical centre of the detectors group calculated when the calculate group topology is invoked More...

std::set< std::string >	getParameterNames (bool recursive=true) const override
	Return the parameter names. More...

std::map< std::string, ComponentID >	getParameterNamesByComponent () const override
	return the parameter names and the component they are from More...

bool	hasParameter (const std::string &name, bool recursive=true) const override
	Returns a boolean indicating whether the parameter exists or not. More...

std::string	getParameterType (const std::string &name, bool recursive=true) const override
	Detectors group assumed to be non-parameterized. More...

std::vector< double >	getNumberParameter (const std::string &pname, bool recursive=true) const override
	Get a parameter defined as a double. More...

std::vector< Kernel::V3D >	getPositionParameter (const std::string &pname, bool recursive=true) const override
	Get a parameter defined as a Kernel::V3D. More...

std::vector< Kernel::Quat >	getRotationParameter (const std::string &pname, bool recursive=true) const override
	Get a parameter defined as a Kernel::Quaternion. More...

std::vector< std::string >	getStringParameter (const std::string &pname, bool recursive=true) const override
	Get a parameter defined as a string. More...

std::vector< int >	getIntParameter (const std::string &pname, bool recursive=true) const override
	Get a parameter defined as an integer. More...

std::vector< bool >	getBoolParameter (const std::string &pname, bool recursive=true) const override
	Get a parameter defined as an integer. More...

std::string	getParameterAsString (const std::string &pname, bool recursive=true) const override
	Get a string representation of a parameter. More...

bool	getParameterVisible (const std::string &pname, bool recursive=true) const override
	Get a visibility attribute of a parameter. More...

det_topology	getTopology (Kernel::V3D &center) const override
	returns the detector's group topology if it has been calculated before or invokes the procedure of calculating such topology if it was not More...

std::string	getNameSeparator () const
	Return separator for list of names of detectors. More...

IComponent const *	getBaseComponent () const override
	Returns const pointer to itself. More...

const ParameterMap &	parameterMap () const override
	Helper for legacy access mode. Always throws for DetectorGroup. More...

size_t	index () const override
	Helper for legacy access mode. Always throws for DetectorGroup. More...

virtual size_t	registerContents (class ComponentVisitor &visitor) const override

Component *	clone () const override
	Virtual Copy Constructor. More...

ComponentID	getComponentID () const override
	Returns the ComponentID - a unique identifier of the component. More...

std::shared_ptr< const IComponent >	getParent () const override
	Return a pointer to the current parent. More...

const IComponent *	getBareParent () const override
	Returns the bare pointer to the IComponent parent. More...

std::vector< std::shared_ptr< const IComponent > >	getAncestors () const override
	Return an array of all ancestors, the nearest first. More...

std::string	getName () const override
	Get the IComponent name. More...

std::string	getFullName () const override
	Get the IComponent full path name. More...

void	setParent (IComponent *) override
	Assign a parent IComponent. Previous parent link is lost. More...

void	setName (const std::string &) override
	Set the IComponent name. More...

void	setPos (double, double, double) override
	Set the IComponent position, x, y, z respective to parent (if present) More...

void	setPos (const Kernel::V3D &) override
	Set the position of the component The position is with respect to the parent component. More...

void	setRot (const Kernel::Quat &) override
	Set the orientation Kernel::Quaternion relative to parent (if present) More...

void	copyRot (const IComponent &)

int	interceptSurface (Track &) const override
	Checks whether the track given will pass through this Component. More...

void	translate (const Kernel::V3D &) override
	Copy the Rotation from another IComponent. More...

void	translate (double, double, double) override
	Translate the IComponent (x,y,z form). This is relative to parent if. More...

void	rotate (const Kernel::Quat &) override
	Rotate the IComponent. This is relative to parent. More...

void	rotate (double, const Kernel::V3D &) override
	Rotate the IComponent by an angle in degrees with respect to an axis. More...

Kernel::V3D	getRelativePos () const override
	Get the position relative to the parent IComponent (absolute if no parent) More...

Kernel::Quat	getRelativeRot () const override
	Get the relative Orientation. More...

Kernel::Quat	getRotation () const override
	Get the absolute orientation of the IComponent. More...

void	printSelf (std::ostream &) const override
	Prints a text representation of itself. More...

void	getBoundingBox (double &, double &, double &, double &, double &, double &) const

void	draw () const override
	Draws the objcomponent. More...

void	drawObject () const override
	Draws the Object. More...

void	initDraw () const override
	Initializes the ObjComponent for rendering, this function should be called before rendering. More...

const std::shared_ptr< const IObject >	shape () const override
	Returns the shape of the Object. More...

const Kernel::Material	material () const override
	Returns the material of the Object. More...

	DetectorGroup (const DetectorGroup &)
	Private, unimplemented copy constructor. More...

DetectorGroup &	operator= (const DetectorGroup &)
	Private, unimplemented copy assignment operator. More...

void	calculateGroupTopology () const
	function calculates the detectors arrangement (topology) More...

Additional Inherited Members
Protected Member Functions inherited from Mantid::Geometry::IObjComponent
void	setGeometryHandler (GeometryHandler *h)
	Reset the current geometry handler. More...

Detailed Description

Holds a collection of detectors.

Responds to IDetector methods as though it were a single detector. Currently, detectors in a group are treated as pointlike (or at least) homogenous entities. This means that it's up to the use to make only sensible groupings of similar detectors since no weighting according to solid angle size takes place and the DetectorGroup's position is just a simple average of its constituents.

Author: Russell Taylor, Tessella Support Services plc

Date: 08/04/2008

Definition at line 28 of file DetectorGroup.h.

Member Typedef Documentation

◆ DetCollection

using Mantid::Geometry::DetectorGroup::DetCollection = std::map<int, IDetector_const_sptr>

protected

The type of collection used for the detectors.

a map of detector pointers with the detector ID as the key

Definition at line 166 of file DetectorGroup.h.

Constructor & Destructor Documentation

◆ DetectorGroup() [1/3]

Mantid::Geometry::DetectorGroup::DetectorGroup ( )

Default constructor.

Definition at line 28 of file DetectorGroup.cpp.

◆ DetectorGroup() [2/3]

Mantid::Geometry::DetectorGroup::DetectorGroup ( const std::vector< IDetector_const_sptr > & dets )

Constructor that takes a list of detectors to add.

Parameters

dets	:: The vector of IDetector pointers that this virtual detector will hold

Exceptions

std::invalid_argument If an empty vector is passed as argument

Definition at line 35 of file DetectorGroup.cpp.

References addDetector(), Mantid::Kernel::Logger::error(), and Mantid::Geometry::g_log.

◆ DetectorGroup() [3/3]

Mantid::Geometry::DetectorGroup::DetectorGroup ( const DetectorGroup & )

private

Private, unimplemented copy constructor.

Member Function Documentation

◆ addDetector()

void Mantid::Geometry::DetectorGroup::addDetector ( const IDetector_const_sptr & det )

Add a detector to the collection.

Parameters

det	:: A pointer to the detector to add

Definition at line 50 of file DetectorGroup.cpp.

References group_topology, m_detectors, m_id, and Mantid::Geometry::undef.

Referenced by DetectorGroup().

◆ calculateGroupTopology()

void Mantid::Geometry::DetectorGroup::calculateGroupTopology ( ) const

private

function calculates the detectors arrangement (topology)

the private function calculates the topology of the detector's group, namely if the detectors arranged into a ring or into a rectangle.

Uses assumption that a ring has hole inside, so geometrical centre of the shape does not belong to a ring but does belong to a rectangle

Definition at line 381 of file DetectorGroup.cpp.

References Mantid::Geometry::cyl, getPos(), group_topology, groupCentre, isValid(), m_detectors, Mantid::Geometry::rect, Mantid::Geometry::undef, and Mantid::Geometry::BoundingBox::width().

Referenced by getTopology().

◆ clone()

Component * Mantid::Geometry::DetectorGroup::clone ( ) const

inlineoverrideprotectedvirtual

Virtual Copy Constructor.

Returns: A pointer to a copy of the input ObjComponent

Implements Mantid::Geometry::IObjComponent.

Definition at line 179 of file DetectorGroup.h.

◆ cloneParameterized()

IDetector * Mantid::Geometry::DetectorGroup::cloneParameterized ( const ParameterMap * map ) const

inlineoverridevirtual

Create a cloned instance with a parameter map applied.

Implements Mantid::Geometry::IDetector.

Definition at line 36 of file DetectorGroup.h.

◆ copyRot()

void Mantid::Geometry::DetectorGroup::copyRot ( const IComponent & )

inlineprotected

Definition at line 194 of file DetectorGroup.h.

◆ draw()

void Mantid::Geometry::DetectorGroup::draw ( ) const

inlineoverrideprotectedvirtual

Draws the objcomponent.

Implements Mantid::Geometry::IObjComponent.

Definition at line 213 of file DetectorGroup.h.

◆ drawObject()

void Mantid::Geometry::DetectorGroup::drawObject ( ) const

inlineoverrideprotectedvirtual

Draws the Object.

Implements Mantid::Geometry::IObjComponent.

Definition at line 214 of file DetectorGroup.h.

◆ getAncestors()

std::vector< std::shared_ptr< const IComponent > > Mantid::Geometry::DetectorGroup::getAncestors ( ) const

inlineoverrideprotectedvirtual

Return an array of all ancestors, the nearest first.

pname	:: The name of the parameter
recursive	:: If true the search will walk up through the parent components

observer	:: The point to calculate the angle relative to (typically the sample position)
axis	:: The axis to which the required angle is relative
instrumentUp	:: Direction corresponding to the instrument up direction. Used to determine signs.

name	:: The name of the parameter
recursive	:: If true the parent components will also be searched (Default: true)

Public Member Functions

ParameterMap access

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ DetCollection

Constructor & Destructor Documentation

◆ DetectorGroup() [1/3]

◆ DetectorGroup() [2/3]

◆ DetectorGroup() [3/3]

Member Function Documentation

◆ addDetector()

◆ calculateGroupTopology()

◆ clone()

◆ cloneParameterized()

◆ copyRot()

◆ draw()

◆ drawObject()

◆ getAncestors()

◆ getBareParent()

◆ getBaseComponent()

◆ getBoolParameter()

◆ getBoundingBox() [1/2]

◆ getBoundingBox() [2/2]

◆ getComponentID()

◆ getDetectorIDs()

◆ getDetectors()

◆ getDistance()

◆ getFullName()

◆ getID()

◆ getIntParameter()

◆ getName()

◆ getNameSeparator()

◆ getNumberParameter()

◆ getParameterAsString()

◆ getParameterNames()

◆ getParameterNamesByComponent()

◆ getParameterType()

◆ getParameterVisible()

◆ getParent()

◆ getPhi()

◆ getPhiOffset()

◆ getPointInObject()

◆ getPos()

◆ getPositionParameter()

◆ getRelativePos()

◆ getRelativeRot()

◆ getRotation()

◆ getRotationParameter()

◆ getSignedTwoTheta()

◆ getStringParameter()

◆ getTopology()

◆ getTwoTheta()

◆ hasParameter()

◆ index()

◆ initDraw()

◆ interceptSurface()

◆ isOnSide()

◆ isParametrized()

◆ isValid()

◆ material()

◆ nDets()

◆ operator=()

◆ parameterMap()

◆ printSelf()

◆ registerContents()

◆ rotate() [1/2]

◆ rotate() [2/2]

◆ setName()

◆ setParent()

◆ setPos() [1/2]

◆ setPos() [2/2]

◆ setRot()

◆ shape()

◆ solidAngle()

◆ translate() [1/2]

◆ translate() [2/2]

Member Data Documentation

◆ group_topology

◆ groupCentre