OpenMS
PeakSpectrumCompareFunctor Class Referenceabstract

Base class for compare functors of spectra, that return a similarity value for two spectra. More...

#include <OpenMS/COMPARISON/SPECTRA/PeakSpectrumCompareFunctor.h>

Inheritance diagram for PeakSpectrumCompareFunctor:
[legend]
Collaboration diagram for PeakSpectrumCompareFunctor:
[legend]

Public Member Functions

 PeakSpectrumCompareFunctor ()
 default constructor More...
 
 PeakSpectrumCompareFunctor (const PeakSpectrumCompareFunctor &source)
 copy constructor More...
 
 ~PeakSpectrumCompareFunctor () override
 destructor More...
 
PeakSpectrumCompareFunctoroperator= (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...
 
DefaultParamHandleroperator= (const DefaultParamHandler &rhs)
 Assignment operator. More...
 
virtual bool operator== (const DefaultParamHandler &rhs) const
 Equality operator. More...
 
void setParameters (const Param &param)
 Sets the parameters. More...
 
const ParamgetParameters () const
 Non-mutable access to the parameters. More...
 
const ParamgetDefaults () const
 Non-mutable access to the default parameters. More...
 
const StringgetName () 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 ()
 
- Static Public Member Functions inherited from DefaultParamHandler
static void writeParametersToMetaValues (const Param &write_this, MetaInfoInterface &write_here, const String &key_prefix="")
 Writes all parameters to meta values. More...
 

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< Stringsubsections_
 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

Base class for compare functors of spectra, that return a similarity value for two spectra.

PeakSpectrumCompareFunctor classes return a similarity value for a pair of PeakSpectrum objects. The value should be greater equal 0.

Constructor & Destructor Documentation

◆ PeakSpectrumCompareFunctor() [1/2]

default constructor

◆ PeakSpectrumCompareFunctor() [2/2]

copy constructor

◆ ~PeakSpectrumCompareFunctor()

destructor

Member Function Documentation

◆ getProductName()

static const String getProductName ( )
inlinestatic

◆ operator()() [1/2]

virtual double operator() ( const PeakSpectrum a) const
pure virtual

◆ operator()() [2/2]

virtual double operator() ( const PeakSpectrum a,
const PeakSpectrum b 
) const
pure virtual

◆ operator=()

assignment operator

◆ registerChildren()

static void registerChildren ( )
static

registers all derived products