\(\renewcommand\AA{\unicode{x212B}}\)
CreateSimulationWorkspace v1¶
Enable screenshots using DOCS_SCREENSHOTS in CMake¶
Summary¶
Create a blank workspace for a given instrument.
Properties¶
Name |
Direction |
Type |
Default |
Description |
|---|---|---|---|---|
Instrument |
Input |
string |
Mandatory |
An instrument name or filename ( a full path or string containing an xml extension). |
BinParams |
Input |
dbl list |
Mandatory |
A comma separated list of first bin boundary, width, last bin boundary. See Rebin for more details |
OutputWorkspace |
Output |
Mandatory |
The new workspace |
|
UnitX |
Input |
string |
DeltaE |
The unit to assign to the X axis. Allowed values: [‘AtomicDistance’, ‘Degrees’, ‘DeltaE’, ‘DeltaE_inFrequency’, ‘DeltaE_inWavenumber’, ‘dSpacing’, ‘dSpacingPerpendicular’, ‘Empty’, ‘Energy’, ‘Energy_inWavenumber’, ‘Label’, ‘Momentum’, ‘MomentumTransfer’, ‘Phi’, ‘QSquared’, ‘SpinEchoLength’, ‘SpinEchoTime’, ‘Temperature’, ‘Time’, ‘TOF’, ‘Wavelength’] |
DetectorTableFilename |
Input |
string |
An optional filename (currently RAW or ISIS NeXus) that contains UDET & SPEC tables to access hardware grouping |
|
SetErrors |
Input |
boolean |
False |
Whether to set histogram bin errors to sqrt of intensity. |
Description¶
Creates a blank workspace for a given instrument with the option of pulling in detector tables from a RAW/NeXus data file. The histogram sizes are given by binning parameters, see Rebin v1, rather than explicit data arrays. There is also an option to set the X axis unit.
If the DetectorTableFilename property is blank then it is assumed that a 1:1 spectra-mapping is required and the workspace will have the same number of histograms as detectors in the instrument (not including monitors)
Categories: AlgorithmIndex | Utility\Workspaces
Source¶
C++ header: CreateSimulationWorkspace.h
C++ source: CreateSimulationWorkspace.cpp