This a python binding to the C++ class Mantid::API::IMDHistoWorkspace.
bases: mantid.api.IMDWorkspace, mantid.api.MultipleExperimentInfos
Raises an exception This class cannot be instantiated from Python
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.
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)[Degrees, DeltaE, DeltaE_inWavenumber, dSpacing, Empty, Energy, Energy_inWavenumber, Label, Momentum, MomentumTransfer, QSquared, SpinEchoLength, SpinEchoTime, Time, 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://www.mantidproject.org/ConvertUnits).
Removes a workspace from memory.
Property descriptions:
Workspace(Input:req) Workspace Name of the workspace to delete.
Returns the visual normalization of the workspace.
For MDEventWorkspaces returns the visual normalization of dervied MDHistoWorkspaces.For all others returns the same as displayNormalization.
Return the squared-errors at the linear index
Returns a numpy array containing the width of the smallest bin in each dimension
Returns a VMD object defining the basis vector for the specified dimension
Return the position of the center of a bin at a given position
Returns the comment field on the workspace
Returns the description of the dimension at the given index (starts from 0). Raises RuntimeError if index is out of range.
Returns the index of the dimension with the given ID. Raises RuntimeError if the name does not exist.
Returns the index of the dimension with the given name. Raises RuntimeError if the name does not exist.
Returns the description of the dimension with the given id string. Raises ValueError if the string is not a known id.
Returns a read-only numpy array containing the square of the error values
Return the experiment info at the given index.
Returns an XML representation, as a string, of the geometry of the workspace
Return read-only access to the workspace history
Return the inverse of volume of EACH cell in the workspace.
Get the 1D linear index from the 2D array
Returns the memory footprint of the workspace in KB
Returns the total number of events, contributed to the workspace
Returns the total number of points within the workspace
Returns the name of the workspace. This could be an empty string
Returns the description objects of the non-integrated dimension as a python list of IMDDimension.
Returns the number of dimensions present
Returns a read-only numpy array containing the number of MD events in each bin
Return the number of experiment info objects,
Returns the number of transformations from original workspace coordinate systems
Returns the number of transformations to original workspace coordinate systems
Returns the vector of the origin (in the original workspace) that corresponds to 0,0,0... in this workspace
Returns the source workspace attached at the given index
Returns a read-only numpy array containing the signal values
Returns the special coordinate system of the workspace
Returns the dimension description mapped to time
Returns the title of the workspace
Returns the dimension description mapped to X
Returns the dimension description mapped to Y
Returns the dimension description mapped to Z
Returns True if there is a source workspace at the given index
The string ID of the class
True if the workspace has run more than n algorithms (Default=1)
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 An ArrayProperty containing a list of spectra to mask
DetectorList(Input) int list An ArrayProperty containing a list of detector ID’s to mask
WorkspaceIndexList(Input) unsigned int list An ArrayProperty containing 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.[]
StartWorkspaceIndex(Input) number The index of the first workspace index of input MaskedWorkspace to be included in the calculation. Default is 0.
EndWorkspaceIndex(Input) number The index number of the last workspace index of input MaskedWorkspace to be included in the calculation. Default is the last histogram.
The name of the object
Returns the number of source workspaces attached
Set the comment field of the workspace
Sets the square of the errors from a numpy array. The sizes must match the current workspace sizes. A ValueError is thrown if not
Sets the squared-error at the specified index.
Sets the signal from a numpy array. The sizes must match the current workspace sizes. A ValueError is thrown if not
Sets the signal at the specified index.
Set the title of the workspace
Sets all signals/errors in the workspace to the given values
Return a reference to the signal at the linear index
Returns true if the object can be accessed safely from multiple threads