Instrument

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

bases: mantid.geometry.CompAssembly

class mantid.geometry.Instrument

findGridDetectors((Instrument)self) → std_vector_grid_detector :

Return a list of grid detectors.

findRectDetectors((Instrument)self) → std_vector_rectangular_detector :

Return a list of rectangular detectors.

getBaseInstrument((Instrument)self) → Instrument :

Return reference to the base instrument

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

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

Returns the named Component

getDefaultView((Instrument)self) → str :

Return the name of the preferred view in instrument view.

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

getFilename((Instrument)self) → str :

Return the name of the file that the original IDF was from

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

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

getName((IComponent)self) → str :

Returns the name of the component

getNumberDetectors((Instrument)self[, (bool)skipMonitors=False]) → int

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

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

Returns the absolute position of the component

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

getReferenceFrame((Instrument)self) → ReferenceFrame :

Returns the ReferenceFrame attached that defines the instrument axes

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

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

Returns the relative rotation as a Quat

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

getRotationParameter((Component)self, (str)pname[, (bool)recursive=True]) → mantid.kernel._kernel.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]) → mantid.kernel._kernel.std_vector_str

getValidFromDate((Instrument)self) → mantid.kernel._kernel.DateAndTime :

Return the valid from DateAndTime of the instrument

getValidToDate((Instrument)self) → mantid.kernel._kernel.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

setFilename((Instrument)self, (str)filename) → None :

Set the name of the file that the original IDF was from

type((IComponent)self) → str :

Returns the type of the component represented as a string