\(\renewcommand\AA{\unicode{x212B}}\)
Table of Contents
Name | Direction | Type | Default | Description |
---|---|---|---|---|
InputWorkspace | Input | IPeaksWorkspace | Mandatory | The input workspace |
OutputWorkspace | Output | IPeaksWorkspace | Mandatory | The filtered workspace |
FilterVariable | Input | string | h+k+l | The variable on which to filter the peaks. Allowed values: [‘h+k+l’, ‘h^2+k^2+l^2’, ‘Intensity’, ‘Signal/Noise’, ‘QMod’, ‘Wavelength’, ‘DSpacing’, ‘TOF’, ‘RunNumber’] |
FilterValue | Input | number | Optional | The value of the FilterVariable to compare each peak to |
Operator | Input | string | < | Allowed values: [‘<’, ‘>’, ‘=’, ‘!=’, ‘<=’, ‘>=’] |
Criterion | Input | string | = | Allowed values: [‘=’, ‘!=’] |
BankName | Input | string | Selected bank name, empty means skip selection. Applicable only to PeaksWorkspace |
Filters a PeaksWorkspace using a set number of queries. Outputs a filtered PeaksWorkspace.
Categories: AlgorithmIndex | Crystal\Peaks
C++ header: FilterPeaks.h (last modified: 2021-03-31)
C++ source: FilterPeaks.cpp (last modified: 2021-04-01)