\(\renewcommand\AA{\unicode{x212B}}\)

WorkspaceGroup

This is a Python binding to the C++ class Mantid::API::WorkspaceGroup.

bases: mantid.api.Workspace

class mantid.api.WorkspaceGroup

add((WorkspaceGroup)self, (str)workspace_name) → None :

Add a name to the group

addWorkspace((WorkspaceGroup)self, (object)workspace) → None :

Add a workspace to the group.

clone(InputWorkspace)

Copies an existing workspace into a new one.

Property descriptions:

InputWorkspace(Input:req) Workspace Name of the input workspace. Must be a MatrixWorkspace (2D or EventWorkspace), a PeaksWorkspace or a MDEventWorkspace.

OutputWorkspace(Output:req) Workspace Name of the newly created cloned workspace.

contains((WorkspaceGroup)self, (str)workspace) → bool :

Returns true if the given name is in the group

convertUnits(InputWorkspace, Target, EMode=None, EFixed=None, AlignBins=None, ConvertFromPointData=None)

Performs a unit change on the X values of a workspace

Property descriptions:

InputWorkspace(Input:req) MatrixWorkspace Name of the input workspace

OutputWorkspace(Output:req) MatrixWorkspace Name of the output workspace, can be the same as the input

Target(Input:req) string The name of the units to convert to (must be one of those registered in the Unit Factory)[DeltaE, DeltaE_inFrequency, DeltaE_inWavenumber, dSpacing, dSpacingPerpendicular, Energy, Energy_inWavenumber, Momentum, MomentumTransfer, QSquared, SpinEchoLength, SpinEchoTime, TOF, Wavelength]

EMode(Input) string The energy mode (default: elastic)[Elastic, Direct, Indirect]

EFixed(Input) number Value of fixed energy in meV : EI (EMode=’Direct’) or EF (EMode=’Indirect’) . Must be set if the target unit requires it (e.g. DeltaE)

AlignBins(Input) boolean If true (default is false), rebins after conversion to ensure that all spectra in the output workspace have identical bin boundaries. This option is not recommended (see http://docs.mantidproject.org/algorithms/ConvertUnits).

ConvertFromPointData(Input) boolean When checked, if the Input Workspace contains Points the algorithm ConvertToHistogram will be run to convert the Points to Bins. The Output Workspace will contains Bins.

delete(Workspace)

Removes a workspace from memory.

Property descriptions:

Workspace(Input:req) Workspace Name of the workspace to delete.

getComment((Workspace)self) → str :

Returns the comment field on the workspace

getHistory((Workspace)self) → WorkspaceHistory :

Return read-only access to the WorkspaceHistory

getItem((WorkspaceGroup)self, (int)index) → object :

Returns the item at the given index

getMemorySize((Workspace)self) → int :

Returns the memory footprint of the workspace in KB

getName((Workspace)self) → str :

Returns the name of the workspace. This could be an empty string

getNames((WorkspaceGroup)self) → std_vector_str :

Returns the names of the entries in the group

getNumberOfEntries((WorkspaceGroup)self) → int :

Returns the number of entries in the group

getTitle((Workspace)self) → str :

Returns the title of the workspace

id((DataItem)self) → str :

The string ID of the class

isDirty((Workspace)self[, (int)n]) → bool :

True if the workspace has run more than n algorithms (Default=1)

isGroup((Workspace)self) → bool :

Returns if it is a group workspace

isMultiPeriod((WorkspaceGroup)self) → bool :

Returns true if the workspace group is multi-period

maskDetectors(Workspace, SpectraList=None, DetectorList=None, WorkspaceIndexList=None, MaskedWorkspace=None, ForceInstrumentMasking=None, StartWorkspaceIndex=None, EndWorkspaceIndex=None, ComponentList=None)

An algorithm to mask a detector, or set of detectors, as not to be used. The workspace spectra associated with those detectors are zeroed.

Property descriptions:

Workspace(InOut:req) Workspace The name of the input and output workspace on which to perform the algorithm.

SpectraList(Input) int list A list of spectra to mask

DetectorList(Input) int list A list of detector ID’s to mask

WorkspaceIndexList(Input) unsigned int list A list of the workspace indices to mask

MaskedWorkspace(Input) MatrixWorkspace If given but not as a SpecialWorkspace2D, the masking from this workspace will be copied. If given as a SpecialWorkspace2D, the masking is read from its Y values.[]

ForceInstrumentMasking(Input) boolean Works when ‘MaskedWorkspace’ is provided and forces to use spectra-detector mapping even in case when number of spectra in ‘Workspace’ and ‘MaskedWorkspace’ are equal

StartWorkspaceIndex(Input) number If other masks fields are provided, it’s the first index of the target workspace to be allowed to be masked from by these masks, if not, its the first index of the target workspace to mask. Default value is 0 if other masking is present or ignored if not.

EndWorkspaceIndex(Input) number If other masks are provided, it’s the last index of the target workspace allowed to be masked to by these masks, if not, its the last index of the target workspace to mask. Default is number of histograms in target workspace if other masks are present or ignored if not.

ComponentList(Input) str list A list names of components to mask

name((DataItem)self) → str :

The name of the object

readLock((DataItem)self) → None :

Acquires a read lock on the data item.

remove((WorkspaceGroup)self, (str)workspace_name) → None :

Remove a name from the group

setComment((Workspace)self, (str)comment) → None :

Set the comment field of the workspace

setTitle((Workspace)self, (str)title) → None :

Set the title of the workspace

size((WorkspaceGroup)self) → int :

Returns the number of workspaces contained in the group

sortByName((WorkspaceGroup)self) → None :

Sort members by name

threadSafe((DataItem)self) → bool :

Returns true if the object can be accessed safely from multiple threads

unlock((DataItem)self) → None :

Unlocks a read or write lock on the data item.