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

RawFileInfo v1

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Extract run parameters from a RAW file as output properties.

See Also

LoadRaw

Properties

Name	Direction	Type	Default	Description
Filename	Input	string	Mandatory	The name of the [[RAW_File | RAW]] file from which to extract the parameters. Allowed extensions: [‘.raw’, ‘.s*’]
GetRunParameters	Input	boolean	False	If this is true, the parameters from the RPB struct are placed into a TableWorkspace called Raw_RPB
GetSampleParameters	Input	boolean	False	If this is true, the parameters from the SPB struct are placed into a TableWorkspace called Raw_SPB.
RunTitle	Output	string		The run title from the HDR struct
RunHeader	Output	string		The run header
SpectraCount	Output	number		The number of spectra
TimeChannelCount	Output	number		The number of time channels
PeriodCount	Output	number		The number of periods

Description

Extracts run parameters from the RAW file given as an input property. If the GetRunParameters argument is True then a TableWorkspace is created that contains a column for each value of the RPB_STRUCT, i.e. column names such as r_dur, r_goodfrm etc. If the GetSampleParameters argument is True then a TableWorkspace is created that contains a column for each value of the SPB_STRUCT, i.e. column names such as e_geom, e_width, etc. This is Mantid’s version of the Get routine in Open Genie.

Categories: AlgorithmIndex | DataHandling\Raw

Source

C++ header: RawFileInfo.h

C++ source: RawFileInfo.cpp