Detector

This is a Python binding to the C++ class Mantid::Geometry::Detector.

bases: mantid.geometry.IDetector, mantid.geometry.ObjComponent

class mantid.geometry.Detector

getBoolParameter((Component)self, (str)pname[, (bool)recursive=True]) → mantid.kernel._kernel.std_vector_bool

getDescription((Component)self) → str :

Return the description of current parameterized component

getDistance((IComponent)self, (IComponent)other) → float :

Returns the distance, in metres, between this and the given component

getFittingParameter((Component)self, (str)pname, (float)xvalue) → float :

Get fit parameter from the parameter map. The value of the parameter is determined from a look up table or a formula

getFullName((IComponent)self) → str :

Returns full path name of component (deprecated, use ComponentInfo.name)

getID((IDetector)self) → int :

Returns the detector ID (deprecated, use DetectorInfo.detectorIDs)

getIntParameter((Component)self, (str)pname[, (bool)recursive=True]) → mantid.kernel._kernel.std_vector_int

getName((IComponent)self) → str :

Returns the name of the component (deprecated, use ComponentInfo.name)

getNumberParameter((Component)self, (str)pname[, (bool)recursive=True]) → mantid.kernel._kernel.std_vector_dbl

getParamDescription((Component)self, (str)pname[, (bool)recursive=True]) → str

getParamShortDescription((Component)self, (str)pname[, (bool)recursive=True]) → str

getParameterNames((Component)self[, (bool)recursive=True]) → mantid.kernel._kernel.std_set_str

getParameterType((Component)self, (str)pname[, (bool)recursive=True]) → str

getPhi((IDetector)self) → float :

Returns the azimuthal angle of this detector (deprecated, use DetectorInfo.azimuthal)

getPos((IComponent)self) → mantid.kernel._kernel.V3D :

Returns the absolute position of the component (deprecated, use ComponentInfo.position)

getPositionParameter((Component)self, (str)pname[, (bool)recursive=True]) → mantid.kernel._kernel.std_vector_v3d

getRelativePos((Component)self) → mantid.kernel._kernel.V3D :

Returns the relative position as a V3D (deprecated, use ComponentInfo.relativePosition)

getRelativeRot((IComponent)self) → mantid.kernel._kernel.Quat :

Returns the relative rotation as a Quat (deprecated, use ComponentInfo.relativeRotation)

getRotation((Component)self) → mantid.kernel._kernel.Quat :

Returns the absolute rotation as a Quat (deprecated, use ComponentInfo.rotation)

getRotationParameter((Component)self, (str)pname[, (bool)recursive=True]) → mantid.kernel._kernel.std_vector_quat

getShortDescription((Component)self) → str :

Return the short description of current parameterized component

getStringParameter((Component)self, (str)pname[, (bool)recursive=True]) → mantid.kernel._kernel.std_vector_str

getTwoTheta((IDetector)self, (mantid.kernel._kernel.V3D)observer, (mantid.kernel._kernel.V3D)axis) → float :

Calculate the angle between this detector, another component and an axis (deprecated, use DetectorInfo.twoTheta)

hasParameter((Component)self, (str)name[, (bool)recursive=True]) → bool

isMasked((Detector)self) → bool :

Returns the value of the masked flag. True means ignore this detector

isMonitor((Detector)self) → bool :

Returns True if the detector is marked as a monitor in the IDF

setDescription((Component)self, (str)descr) → None :

Set component’s description, works only if the component is parameterized component

shape((IObjComponent)self) → IObject :

Get the object that represents the physical shape of this component (deprecated, use ComponentInfo.shape)

solidAngle((IDetector)self, (mantid.kernel._kernel.V3D)observer) → float :

Return the solid angle in steradians between this detector and an observer (deprecated, use ComponentInfo.solidAngle)

type((IComponent)self) → str :

Returns the type of the component represented as a string (deprecated, use ComponentInfo.componentType)