ComplementMarker marks peak pairs which could represent y - b ion pairs. More...
#include <OpenMS/FILTERING/TRANSFORMERS/ComplementMarker.h>
Inheritance diagram for ComplementMarker:
Public Member Functions | |
| ComplementMarker () | |
| standard constructor More... | |
| ComplementMarker (const ComplementMarker &source) | |
| copy constructor More... | |
| virtual | ~ComplementMarker () |
| destructor More... | |
| ComplementMarker & | operator= (const ComplementMarker &source) |
| assignment operator More... | |
 Public Member Functions inherited from PeakMarker | |
| PeakMarker () | |
| default constructor More... | |
| PeakMarker (const PeakMarker &source) | |
| copy constructor More... | |
| virtual | ~PeakMarker () |
| destructor More... | |
| PeakMarker & | operator= (const PeakMarker &source) |
| assignment operator More... | |
| template<typename SpectrumType > | |
| void | apply (std::map< double, bool > &, SpectrumType &) |
| method to mark peaks More... | |
| Public Member Functions inherited from DefaultParamHandler | |
| DefaultParamHandler (const String &name) | |
| Constructor with name that is displayed in error messages. More... | |
| DefaultParamHandler (const DefaultParamHandler &rhs) | |
| Copy constructor. More... | |
| virtual | ~DefaultParamHandler () |
| Destructor. More... | |
| virtual DefaultParamHandler & | operator= (const DefaultParamHandler &rhs) |
| Assignment operator. More... | |
| virtual bool | operator== (const DefaultParamHandler &rhs) const |
| Equality operator. More... | |
| void | setParameters (const Param ¶m) |
| Sets the parameters. More... | |
| const Param & | getParameters () const |
| Non-mutable access to the parameters. More... | |
| const Param & | getDefaults () const |
| Non-mutable access to the default parameters. More... | |
| const String & | getName () const |
| Non-mutable access to the name. More... | |
| void | setName (const String &name) |
| Mutable access to the name. More... | |
| const std::vector< String > & | getSubsections () const |
| Non-mutable access to the registered subsections. More... | |
| template<typename SpectrumType > | |
| void | apply (std::map< double, bool > marked, SpectrumType &spectrum) |
| static PeakMarker * | create () |
| static const String | getProductName () |
| returns the name to register at the factory More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from PeakMarker | |
| static const String | getProductName () |
| Protected Member Functions inherited from DefaultParamHandler | |
| virtual void | updateMembers_ () |
| This method is used to update extra member variables at the end of the setParameters() method. More... | |
| void | defaultsToParam_ () |
| Updates the parameters after the defaults have been set in the constructor. More... | |
| Protected Attributes inherited from DefaultParamHandler | |
| Param | param_ |
| Container for current parameters. More... | |
| Param | defaults_ |
| Container for default parameters. This member should be filled in the constructor of derived classes! More... | |
| std::vector< String > | subsections_ |
| Container for registered subsections. This member should be filled in the constructor of derived classes! More... | |
| String | error_name_ |
| Name that is displayed in error messages during the parameter checking. More... | |
| bool | check_defaults_ |
| If this member is set to false no checking if parameters in done;. More... | |
| bool | warn_empty_defaults_ |
| If this member is set to false no warning is emitted when defaults are empty;. More... | |
Detailed Description
ComplementMarker marks peak pairs which could represent y - b ion pairs.
Parameters of this class are:| Name | Type | Default | Restrictions | Description |
|---|---|---|---|---|
| tolerance | float | 1 | Tolerance value as defined by Bern et al. | |
| marks | int | 1 | How often a peak needs to be marked to be returned |
Note:
- If a section name is documented, the documentation is displayed as tooltip.
- Advanced parameter names are italic.
Constructor & Destructor Documentation
◆ ComplementMarker() [1/2]
| ComplementMarker | ( | ) |
standard constructor
◆ ComplementMarker() [2/2]
| ComplementMarker | ( | const ComplementMarker & | source | ) |
copy constructor
◆ ~ComplementMarker()
|
virtual |
destructor
Member Function Documentation
◆ apply()
|
inline |
References SpectrumSettings::getPrecursors(), and MSSpectrum::sortByPosition().
◆ create()
|
inlinestatic |
◆ getProductName()
|
inlinestatic |
returns the name to register at the factory
◆ operator=()
| ComplementMarker& operator= | ( | const ComplementMarker & | source | ) |
assignment operator