NLargest removes all but the n largest peaks. More...
#include <OpenMS/FILTERING/TRANSFORMERS/NLargest.h>
Inheritance diagram for NLargest:
Public Member Functions | |
| template<typename SpectrumType > | |
| void | filterSpectrum (SpectrumType &spectrum) |
| void | filterPeakSpectrum (PeakSpectrum &spectrum) |
| void | filterPeakMap (PeakMap &exp) |
| NLargest () | |
| default constructor | |
| NLargest (UInt n) | |
| detailed constructor | |
| virtual | ~NLargest () |
| destructor | |
| NLargest (const NLargest &source) | |
| copy constructor | |
| NLargest & | operator= (const NLargest &source) |
| assignment operator | |
Protected Member Functions | |
| void | updateMembers_ () |
| This method is used to update extra member variables at the end of the setParameters() method. | |
| void | init_ () |
| handles the initialization of the default parameters for the 2 constructors | |
Protected Attributes | |
| UInt | peakcount_ |
Detailed Description
NLargest removes all but the n largest peaks.
Parameters of this class are:| Name | Type | Default | Restrictions | Description |
|---|---|---|---|---|
| n | int | 200 | The number of peaks to keep |
Note:
- If a section name is documented, the documentation is displayed as tooltip.
- Advanced parameter names are italic.
Constructor & Destructor Documentation
| NLargest | ( | ) |
default constructor
| virtual ~NLargest | ( | ) | [virtual] |
destructor
Member Function Documentation
| void filterPeakMap | ( | PeakMap & | exp | ) |
| void filterPeakSpectrum | ( | PeakSpectrum & | spectrum | ) |
| void filterSpectrum | ( | SpectrumType & | spectrum | ) | [inline] |
| void init_ | ( | ) | [protected] |
handles the initialization of the default parameters for the 2 constructors
| void updateMembers_ | ( | ) | [protected, virtual] |
This method is used to update extra member variables at the end of the setParameters() method.
Also call it at the end of the derived classes' copy constructor and assignment operator.
The default implementation is empty.
Reimplemented from DefaultParamHandler.
Member Data Documentation
UInt peakcount_ [protected] |
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:53 using doxygen 1.7.1 |