OpenMS  2.7.0
Public Member Functions | Protected Attributes | List of all members
SpectraMerger::SpectraDistance_ Class Reference

#include <OpenMS/FILTERING/TRANSFORMERS/SpectraMerger.h>

Inheritance diagram for SpectraMerger::SpectraDistance_:
[legend]
Collaboration diagram for SpectraMerger::SpectraDistance_:
[legend]

Public Member Functions

 SpectraDistance_ ()
 
void updateMembers_ () override
 This method is used to update extra member variables at the end of the setParameters() method. More...
 
double getSimilarity (const double d_rt, const double d_mz) const
 
double operator() (const BaseFeature &first, const BaseFeature &second) const
 
- 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 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...
 

Protected Attributes

double rt_max_
 
double mz_max_
 
- 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from DefaultParamHandler
static void writeParametersToMetaValues (const Param &write_this, MetaInfoInterface &write_here, const String &prefix="")
 Writes all parameters to meta values. More...
 
- Protected Member Functions inherited from DefaultParamHandler
void defaultsToParam_ ()
 Updates the parameters after the defaults have been set in the constructor. More...
 

Constructor & Destructor Documentation

◆ SpectraDistance_()

SpectraDistance_ ( )
inline

Member Function Documentation

◆ getSimilarity()

double getSimilarity ( const double  d_rt,
const double  d_mz 
) const
inline

◆ operator()()

double operator() ( const BaseFeature first,
const BaseFeature second 
) const
inline

References Peak2D::getMZ(), and Peak2D::getRT().

◆ updateMembers_()

void updateMembers_ ( )
inlineoverridevirtual

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

◆ mz_max_

double mz_max_
protected

◆ rt_max_

double rt_max_
protected