Instrument¶

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

bases: mantid.geometry.CompAssembly

class mantid.geometry.Instrument¶

__init__()¶

Raises an exception This class cannot be instantiated from Python

getBaseInstrument((Instrument)self) → Instrument :¶

Return reference to the base instrument

getBoolParameter((Component)self, (str)pname[, (bool)recursive=True]) → std_vector_bool¶

getComponentByName((Instrument)self, (str)cname[, (int)nlevels=0]) → IComponent :¶

Returns the named Component

getDescription((Component)self) → str :¶

Return the description of current parameterized component

getDetector((Instrument)self, (int)detector_id) → IDetector :¶

Returns the Detector with the given ID

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

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

getFullName((IComponent)self) → str :¶

Returns full path name of component

getIntParameter((Component)self, (str)pname[, (bool)recursive=True]) → std_vector_int¶

getName((IComponent)self) → str :¶

Returns the name of the component

getNumberParameter((Component)self, (str)pname[, (bool)recursive=True]) → 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]) → std_set_str¶

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

getPos((IComponent)self) → V3D :¶

Returns the absolute position of the component

getPositionParameter((Component)self, (str)pname[, (bool)recursive=True]) → std_vector_v3d¶

getReferenceFrame((Instrument)self) → ReferenceFrame :¶

Returns the ReferenceFrame attached that defines the instrument axes

getRelativePos((Component)self) → V3D¶

getRelativeRot((IComponent)self) → Quat :¶

Returns the relative rotation as a Quat

getRotation((Component)self) → Quat¶

getRotationParameter((Component)self, (str)pname[, (bool)recursive=True]) → std_vector_quat¶

getSample((Instrument)self) → IComponent :¶

Return the Component object that represents the sample

getShortDescription((Component)self) → str :¶

Return the short description of current parameterized component

getSource((Instrument)self) → IComponent :¶

Return the Component object that represents the source

getStringParameter((Component)self, (str)pname[, (bool)recursive=True]) → std_vector_str¶

getValidFromDate((Instrument)self) → DateAndTime :¶

Return the valid from DateAndTime of the instrument

getValidToDate((Instrument)self) → DateAndTime :¶

Return the valid to DateAndTime of the instrument

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

nelements((ICompAssembly)self) → int :¶

Returns the number of elements in the assembly

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

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

type((IComponent)self) → str :¶

Returns the type of the component represented as a string