LoadDAE
From MantidProject
Contents |
Summary
Loads data from the ISIS DATA acquisition system and stores it in a 2D workspace (Workspace2D class).
Properties
| Order | Name | Direction | Type | Default | Description |
|---|---|---|---|---|---|
| 1 | DAEname | Input | string | Mandatory | The name of and path to the input DAE host. |
| 2 | OutputWorkspace | Output | Workspace2D | Mandatory | The name of the workspace that will be created, filled with the read-in data and stored in the Analysis Data Service. If the input data contain multiple periods higher periods will be stored in separate workspaces called OutputWorkspace_PeriodNo. |
| 3 | spectrum_min | Input | integer | Optional | The number of the first spectrum to read. Only used if spectrum_max is set. Not available for multiperiod data files. |
| 4 | spectrum_max | Input | integer | Optional | The number of the last spectrum to read. Only used if explicitly set. Not available for multiperiod data files. |
| 5 | spectrum_list | Input | integer list | Optional | A comma-separated list of individual spectra to read. Only used if explicitly set. Not available for multiperiod data files. |
Note that it is possible to use both of the optional 'spectrum' properties (i.e. a range and a list) together if so desired.
Description
The LoadRaw algorithm reads data from the DAE in a Workspace2D, which will naturally contain histogram data with each spectrum going into a separate histogram. The time bin boundaries (X values) will be common to all histograms and will have their units set to time-of-flight. The Y values will contain the counts and will be unit-less (i.e. no division by bin width or normalisation of any kind). The errors, currently assumed Gaussian, will be set to be the square root of the number of counts in the bin.
Optional properties
If only a portion of the data is required, then the optional 'spectrum' properties can be set before execution of the algorithm. Prior to loading of the data the values provided are checked and the algorithm will fail if they are found to be outside the limits of the dataset.
Multiperiod data
If the data have multiple periods this will be detected and the different periods will be output as separate workspaces, which after the first one will have the period number appended (e.g. OutputWorkspace_period). Each workspace will share the same Instrument, SpectraToDetectorMap and Sample objects. If the optional 'spectrum' properties are set for a multiperiod dataset, then they will ignored.
Source Code
Header LoadDAE.h
Source LoadDAE.cpp
