FilterPeaks v1

../_images/FilterPeaks-v1_dlg.png

FilterPeaks dialog.

Summary

Filters the peaks in a peaks workspace based upon the valur of a chosen variable.

Properties

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: [‘<’, ‘>’, ‘=’, ‘!=’, ‘<=’, ‘>=’]

Description

Filters a PeaksWorkspace using a set number of queries. Outputs a filtered PeaksWorkspace.

Categories: AlgorithmIndex | Crystal\Peaks

Source

C++ source: FilterPeaks.cpp (last modified: 2019-06-04)

C++ header: FilterPeaks.h (last modified: 2018-10-05)