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

LoadRawSpectrum0 v1

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Loads spectrum zero from ISIS raw file and stores it in a 2D workspace (Workspace2D class).

See Also

LoadRawBin0, LoadRaw

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	Workspace	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.

Description

The LoadRawSpectrum0 algorithm stores spectrum zero data from the selected RAW file in a Workspace2D.

Usage

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.

Example - Only for .Raw Files

#Spectrum 0 contains any data from detectors not mapped to spectra
wsOut = LoadRawSpectrum0('HRP39180.RAW')

wsIntegral = Integration(wsOut)
print("Spectrum0 contained {:.0f} counts".format(wsIntegral.readY(0)[0]))

Output:

Spectrum0 contained 0 counts

Categories: AlgorithmIndex | Diagnostics\Raw | DataHandling\Raw

Source

C++ header: LoadRawSpectrum0.h

C++ source: LoadRawSpectrum0.cpp