Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
TransformationModel Class Reference

Base class for transformation models. More...

#include <OpenMS/ANALYSIS/MAPMATCHING/TransformationModel.h>

Inheritance diagram for TransformationModel:
TransformationModelBSpline TransformationModelInterpolated TransformationModelLinear

Public Types

typedef std::pair< double, doubleDataPoint
 Coordinate pair. More...
 
typedef std::vector< DataPointDataPoints
 Vector of coordinate pairs. More...
 

Public Member Functions

 TransformationModel ()
 Constructor. More...
 
 TransformationModel (const TransformationModel::DataPoints &, const Param &)
 Alternative constructor (derived classes should implement this one!) More...
 
virtual ~TransformationModel ()
 Destructor. More...
 
virtual double evaluate (double value) const
 Evaluates the model at the given value. More...
 
const ParamgetParameters () const
 Gets the (actual) parameters. More...
 

Static Public Member Functions

static void getDefaultParameters (Param &params)
 Gets the default parameters. More...
 

Protected Attributes

Param params_
 Parameters. More...
 

Detailed Description

Base class for transformation models.

Implements the identity (no transformation). Parameters and data are ignored.

Note that this class and its derived classes do not allow copying/assignment, due to the need for internal memory management associated with some of the transformation models.

Member Typedef Documentation

typedef std::pair<double, double> DataPoint

Coordinate pair.

typedef std::vector<DataPoint> DataPoints

Vector of coordinate pairs.

Constructor & Destructor Documentation

TransformationModel ( )
inline

Constructor.

Alternative constructor (derived classes should implement this one!)

virtual ~TransformationModel ( )
virtual

Destructor.

Member Function Documentation

virtual double evaluate ( double  value) const
virtual

Evaluates the model at the given value.

Reimplemented in TransformationModelInterpolated, TransformationModelLinear, and TransformationModelBSpline.

static void getDefaultParameters ( Param params)
static

Gets the default parameters.

const Param& getParameters ( ) const

Gets the (actual) parameters.

Member Data Documentation

Param params_
protected

Parameters.


OpenMS / TOPP release 2.0.0 Documentation generated on Thu Aug 20 2015 01:44:41 using doxygen 1.8.9.1