\(\renewcommand\AA{\unicode{x212B}}\)
LoadRawBin0 v1¶
Summary¶
Loads bin zero from ISIS raw file and stores it in a 2D workspace (Workspace2D class).
See Also¶
Properties¶
Name |
Direction |
Type |
Default |
Description |
|---|---|---|---|---|
Filename |
Input |
string |
Mandatory |
The name of the RAW file to read, including its full or relative path. The file extension must be .raw or .RAW (N.B. case sensitive if running on Linux). Allowed extensions: [‘.raw’, ‘.s*’, ‘.add’] |
OutputWorkspace |
Output |
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 RAW file contains multiple periods higher periods will be stored in separate workspaces called OutputWorkspace_PeriodNo. |
|
Cache |
Input |
string |
If Slow |
An option allowing the algorithm to cache a remote file on the local drive before loading. When “If Slow” is set the download speed is estimated and if is deemed as slow the file is cached. “Always” means always cache a remote file and “Never” - never cache. Allowed values: [‘If Slow’, ‘Always’, ‘Never’] |
LoadLogFiles |
Input |
boolean |
True |
Boolean option to load or skip log files. If this option is set all the log files associated with the selected raw file are loaded into workspace and can be displayed using right click menu item Sample Logs…on the selected workspace. Note: If the log files contain motor positions, etc. that would affect the instrument geometry this option must be set to true for these adjustments to be applied to the instrument geometry. |
SpectrumMin |
Input |
number |
1 |
The number of the first spectrum to read. |
SpectrumMax |
Input |
number |
Optional |
The number of the last spectrum to read. |
SpectrumList |
Input |
int list |
A comma-separated list of individual spectra to read. Only used if explicitly set. |
Description¶
Loads just bin0 for all spectra from the given ISIS RAW file and stores it in a 2D workspace. You may optionally specify certain spectra to read in.
Usage¶
Example - Loading in Bin0 Data
Note
To run these usage examples please first download the usage data, and add these to your path. In Mantid this is done using Manage User Directories.
#Bin 0 contains any data outside of the time range.
bin_zeroes = LoadRawBin0("IRS21360.raw")
total = SumSpectra(bin_zeroes)
print("Bin0 contained {:.0f} counts.".format(total.readY(0)[0]))
Output:
Bin0 contained 55 counts.
Categories: AlgorithmIndex | Diagnostics\Raw | DataHandling\Raw
Source¶
C++ header: LoadRawBin0.h
C++ source: LoadRawBin0.cpp