\(\renewcommand\AA{\unicode{x212B}}\)
FilterPeaks dialog.
Table of Contents
| Name | Direction | Type | Default | Description |
|---|---|---|---|---|
| InputWorkspace | Input | PeaksWorkspace | Mandatory | The input workspace |
| OutputWorkspace | Output | PeaksWorkspace | Mandatory | The filtered workspace |
| FilterVariable | Input | string | Mandatory | 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 | Mandatory | The value of the FilterVariable to compare each peak to |
| Operator | Input | string | < | Allowed values: [‘<’, ‘>’, ‘=’, ‘!=’, ‘<=’, ‘>=’] |
Filters a PeaksWorkspace using a set number of queries. Outputs a filtered PeaksWorkspace.
Categories: AlgorithmIndex | Crystal\Peaks
C++ header: FilterPeaks.h (last modified: 2020-03-20)
C++ source: FilterPeaks.cpp (last modified: 2020-04-07)