TransformationModel Class Reference

Base class for transformation models. More...

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

Inheritance diagram for TransformationModel:

Public Types
typedef std::pair< double, double >	DataPoint
	Coordinate pair. More...
typedef std::vector< DataPoint >	DataPoints
	Vector of coordinate pairs. More...

Public Member Functions
	TransformationModel ()
	Constructor. More...
	TransformationModel (const TransformationModel::DataPoints &, const Param &)
virtual	~TransformationModel ()
	Destructor. More...
virtual double	evaluate (double value) const
	Evaluates the model at the given value. More...
const Param &	getParameters () 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...

Private Member Functions
	TransformationModel (const TransformationModel &)
	do not allow copy More...
const TransformationModel &	operator= (const TransformationModel &)
	do not allow assignment 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

DataPoint

typedef std::pair<double, double> DataPoint

Coordinate pair.

DataPoints

typedef std::vector<DataPoint> DataPoints

Vector of coordinate pairs.

Constructor & Destructor Documentation

TransformationModel() [1/3]

TransformationModel ( )

inline

Constructor.

TransformationModel() [2/3]

TransformationModel	(	const TransformationModel::DataPoints &	,
		const Param &
	)

Alternative constructor (derived classes should implement this one!) Both data and params must be provided, since some derived classes require both to create a model!

~TransformationModel()

virtual ~TransformationModel ( )

virtual

Destructor.

TransformationModel() [3/3]

TransformationModel ( const TransformationModel &  )

private

do not allow copy

Member Function Documentation

evaluate()

virtual double evaluate ( double  value ) const

virtual

Evaluates the model at the given value.

Reimplemented in TransformationModelInterpolated, TransformationModelLinear, TransformationModelBSpline, and TransformationModelLowess.

getDefaultParameters()

static void getDefaultParameters ( Param &  params )

static

Gets the default parameters.

getParameters()

const Param& getParameters

(

)

const

Gets the (actual) parameters.

Referenced by TransformationModelLowess::evaluate().

operator=()

const TransformationModel& operator= ( const TransformationModel &  )

private

do not allow assignment

Member Data Documentation

params_

Param params_

protected

Parameters.