\(\renewcommand\AA{\unicode{x212B}}\)
AlignAndFocusPowderSlim v1¶
Warning
This algorithm is currently for the VULCAN instrument testing purposes
Summary¶
VULCAN ONLY Algorithm to focus powder diffraction data into a number of histograms according to a grouping scheme defined in a CalFile.
See Also¶
Properties¶
Name |
Direction |
Type |
Default |
Description |
|---|---|---|---|---|
Filename |
Input |
string |
Mandatory |
The name of the Event NeXus file to read, including its full or relative path. The file name is typically of the form INST_####_event.nxs. Allowed extensions: [‘.nxs.h5’, ‘.nxs’, ‘_event.nxs’] |
FilterByTimeStart |
Input |
number |
Optional |
To only include events after the provided start time, in seconds (relative to the start of the run). |
FilterByTimeStop |
Input |
number |
Optional |
To only include events before the provided stop time, in seconds (relative to the start of the run). |
CalFileName |
Input |
string |
The .cal file containing the position correction factors. Either this or OffsetsWorkspace needs to be specified. Allowed extensions: [‘.h5’, ‘.hd5’, ‘.hdf’, ‘.cal’] |
|
XMin |
Input |
number |
10 |
Minimum x-value for the output binning |
XDelta |
Input |
number |
0.0016 |
Bin size for output data |
XMax |
Input |
number |
16667 |
Minimum x-value for the output binning |
BinningMode |
Input |
string |
Logarithmic |
Specify binning behavior (‘Logorithmic’). Allowed values: [‘Logarithmic’, ‘Linear’] |
OutputWorkspace |
Output |
Mandatory |
An output workspace. |
|
ReadBanksInThread |
Input |
number |
1 |
Number of banks to read in a single thread. Lower means more parallelization. |
ReadSizeFromDisk |
Input |
number |
100000000 |
Number of elements of time-of-flight or detector-id to read at a time. This is a maximum |
EventsPerThread |
Input |
number |
2000 |
Number of events to read in a single thread. Higher means less threads are created. |
Description¶
This is a simplified version of AlignAndFocusPowderFromFiles v1 which uses very few child algorithms. The main feature is that this reads the events, filters and adjusts their time-of-flight, then increments the correct bin in the output workspace. As a result, there is a significantly smaller memory usage and the processing is significantly faster.
Current limitations compared to AlignAndFocusPowderFromFiles
only supports the VULCAN instrument
hard coded for 6 particular groups
common binning across all output spectra
only specify binning in time-of-flight
does not support event filtering
does not support copping data
does not support removing prompt pulse
does not support removing bad pulses
Child algorithms used are
Categories: AlgorithmIndex | Workflow\Diffraction
Source¶
C++ header: AlignAndFocusPowderSlim.h
C++ source: AlignAndFocusPowderSlim.cpp