Base class for compare functors of spectra, that return a similiarity value for two spectra. More...
#include <OpenMS/COMPARISON/SPECTRA/PeakSpectrumCompareFunctor.h>
 
  
 | Public Member Functions | |
| PeakSpectrumCompareFunctor () | |
| default constructor  More... | |
| PeakSpectrumCompareFunctor (const PeakSpectrumCompareFunctor &source) | |
| copy constructor  More... | |
| virtual | ~PeakSpectrumCompareFunctor () | 
| destructor  More... | |
| PeakSpectrumCompareFunctor & | operator= (const PeakSpectrumCompareFunctor &source) | 
| assignment operator  More... | |
| virtual double | operator() (const PeakSpectrum &a, const PeakSpectrum &b) const =0 | 
| function call operator, calculates the similarity  More... | |
| virtual double | operator() (const PeakSpectrum &a) const =0 | 
| calculates self similarity  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... | |
| Static Public Member Functions | |
| static void | registerChildren () | 
| registers all derived products  More... | |
| static const String | getProductName () | 
| Additional Inherited Members | |
|  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... | |
Base class for compare functors of spectra, that return a similiarity value for two spectra.
PeakSpectrumCompareFunctor classes return a similarity value for a pair of PeakSpectrum objects. The value should be greater equal 0.
default constructor
| PeakSpectrumCompareFunctor | ( | const PeakSpectrumCompareFunctor & | source | ) | 
copy constructor
| 
 | virtual | 
destructor
| 
 | inlinestatic | 
| 
 | pure virtual | 
function call operator, calculates the similarity
Implemented in CompareFouriertransform, SteinScottImproveScore, SpectrumAlignmentScore, SpectraSTSimilarityScore, SpectrumCheapDPCorr, ZhangSimilarityScore, PeakAlignment, and SpectrumPrecursorComparator.
| 
 | pure virtual | 
calculates self similarity
Implemented in CompareFouriertransform, SteinScottImproveScore, SpectraSTSimilarityScore, SpectrumAlignmentScore, SpectrumCheapDPCorr, ZhangSimilarityScore, PeakAlignment, and SpectrumPrecursorComparator.
| PeakSpectrumCompareFunctor& operator= | ( | const PeakSpectrumCompareFunctor & | source | ) | 
assignment operator
| 
 | static | 
registers all derived products
| OpenMS / TOPP release 1.11.1 | Documentation generated on Thu Nov 14 2013 11:19:28 using doxygen 1.8.5 |