Instrument¶

This 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)arg1) → Instrument :¶

Return reference to the base instrument

getBoolParameter((Component)arg1, (str)arg2[, (bool)arg3]) → std_vector_bool¶

getComponentByName((Instrument)arg1, (str)arg2) → IComponent :¶

Returns the named component

getDescription((Component)arg1) → str :¶

Return the description of current parameterized component

getDetector((Instrument)arg1, (int)arg2) → IDetector :¶

Returns the detector with the given ID

getDistance((IComponent)arg1, (IComponent)arg2) → float :¶

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

getFullName((IComponent)arg1) → str :¶

Returns full path name of component

getIntParameter((Component)arg1, (str)arg2[, (bool)arg3]) → std_vector_int¶

getName((IComponent)arg1) → str :¶

Returns the name of the component

getNumberParameter((Component)arg1, (str)arg2[, (bool)arg3]) → std_vector_dbl¶

getParamDescription((Component)arg1, (str)arg2[, (bool)arg3]) → str¶

getParamShortDescription((Component)arg1, (str)arg2[, (bool)arg3]) → str¶

getParameterNames((Component)arg1[, (bool)arg2]) → std_set_str¶

getParameterType((Component)arg1, (str)arg2[, (bool)arg3]) → str¶

getPos((IComponent)arg1) → V3D :¶

Returns the absolute position of the component

getPositionParameter((Component)arg1, (str)arg2[, (bool)arg3]) → std_vector_v3d¶

getReferenceFrame((Instrument)arg1) → ReferenceFrame :¶

Returns the reference frame attached that defines the instrument axes

getRelativePos((Component)arg1) → V3D¶

getRelativeRot((IComponent)arg1) → Quat :¶

Returns the relative rotation as a Quat

getRotation((Component)arg1) → Quat¶

getRotationParameter((Component)arg1, (str)arg2[, (bool)arg3]) → std_vector_quat¶

getSample((Instrument)arg1) → IComponent :¶

Return the object that represents the sample

getShortDescription((Component)arg1) → str :¶

Return the short description of current parameterized component

getSource((Instrument)arg1) → IComponent :¶

Return the object that represents the source

getStringParameter((Component)arg1, (str)arg2[, (bool)arg3]) → std_vector_str¶

getValidFromDate((Instrument)arg1) → DateAndTime :¶

Return the valid from date of the instrument

getValidToDate((Instrument)arg1) → DateAndTime :¶

Return the valid to date of the instrument

hasParameter((Component)arg1, (str)arg2[, (bool)arg3]) → bool¶

nelements((ICompAssembly)arg1) → int :¶

Returns the number of elements in the assembly

setDescription((Component)arg1, (str)arg2) → None :¶

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

type((IComponent)arg1) → str :¶

Returns the type of the component represented as a string