\(\renewcommand\AA{\unicode{x212B}}\)
LoadSNSspec v1¶
Enable screenshots using DOCS_SCREENSHOTS in CMake¶
Summary¶
Loads data from a text 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 text file to read, including its full or relative path. The file extension must be .txt or .dat. Allowed extensions: [‘.dat’, ‘.txt’] |
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]]. |
|
Unit |
Input |
string |
Energy |
The unit to assign to the X axis (anything known to the [[Unit Factory]] or “Dimensionless”) (default: Energy). 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’] |
Description¶
The LoadSNSspec algorithm reads in spectra data from a text file and stores it in a Workspace2D as data points. The data in the file must be organized by set of 3 columns (separated by any number of spaces). The first column has to be the X values, the second column the Y values and the third column the error values.
Here are two examples of such text files that can be loaded with LoadSNSspec:
Example 1:
#F norm: REF_M_2000.nxs
#F data: REF_M_2001.nxs
#E 1234567.80
...
#C SCL Version - 1.4.1
#S 1 Spectrum ID ('bank1',(0,127))
#L Lambda_T(Angstroms) Intensity(Counts/A) Sigma(Counts/A)
0.0 0.0 0.0
1.0 5.0 2.0
2.0 10.0 3.0
3.0 15.0 2.0
4.0 20.0 2.5
5.0 25.0 3.2
6.0 30.0 4.2
This will create a Workspace2D with 1 spectrum.
Example 2:
#F norm: REF_M_2000.nxs
#F data: REF_M_2001.nxs
#E 1234567.80
...
#C SCL Version - 1.4.1
#S 1 Spectrum ID ('bank1',(0,127))
#L Lambda_T(Angstroms) Intensity(Counts/A) Sigma(Counts/A)
0.0 0.0 0.0
1.0 5.0 2.0
2.0 10.0 3.0
3.0 15.0 4.0
#S 1 Spectrum ID ('bank1',(1,127))
#L Lambda_T(Angstroms) Intensity(Counts/A) Sigma(Counts/A)
0.0 10.0 0.0
1.0 15.0 2.0
2.0 110.0 3.0
3.0 115.0 4.0
#S 1 Spectrum ID ('bank1',(3,127))
#L Lambda_T(Angstroms) Intensity(Counts/A) Sigma(Counts/A)
0.0 20.0 0.0
1.0 25.0 2.0
2.0 210.0 3.0
3.0 215.0 4.0
This text file will create a Workspace2D with 3 spectra.
Categories: AlgorithmIndex | DataHandling\Text
Source¶
C++ header: LoadSNSspec.h
C++ source: LoadSNSspec.cpp