Lowess (non-linear) model for transformations. More...

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

Inheritance diagram for TransformationModelLowess:

Collaboration diagram for TransformationModelLowess:

Public Member Functions
	TransformationModelLowess (const DataPoints &data, const Param &params)
	Constructor.

	~TransformationModelLowess () override
	Destructor.

double	evaluate (double value) const override
	Evaluates the model at the given value.

const Param &	getParameters () const
	Gets the (actual) parameters.

Public Member Functions inherited from TransformationModel
	TransformationModel ()
	Constructor.

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

virtual	~TransformationModel ()
	Destructor.

virtual void	weightData (DataPoints &data)
	Weight the data by the given weight function.

virtual void	unWeightData (DataPoints &data)
	Unweight the data by the given weight function.

bool	checkValidWeight (const String &weight, const std::vector< String > &valid_weights) const
	Check for a valid weighting function string.

double	checkDatumRange (const double &datum, const double &datum_min, const double &datum_max)
	Check that the datum is within the valid min and max bounds.

double	weightDatum (const double &datum, const String &weight) const
	Weight the data according to the weighting function.

double	unWeightDatum (const double &datum, const String &weight) const
	Apply the reverse of the weighting function to the data.

const Param &	getParameters () const
	Gets the (actual) parameters.

std::vector< String >	getValidXWeights () const
	Returns a list of valid x weight function strings.

std::vector< String >	getValidYWeights () const
	Returns a list of valid y weight function strings.

Static Public Member Functions
static void	getDefaultParameters (Param &params)
	Gets the default parameters.

Static Public Member Functions inherited from TransformationModel
static void	getDefaultParameters (Param &params)
	Gets the default parameters.

Protected Attributes
TransformationModelInterpolated *	model_
	Pointer to the underlying interpolation.

Protected Attributes inherited from TransformationModel
Param	params_
	Parameters.

String	x_weight_
	x weighting

double	x_datum_min_

double	x_datum_max_

String	y_weight_
	y weighting

double	y_datum_min_

double	y_datum_max_

bool	weighting_

Additional Inherited Members
Public Types inherited from TransformationModel
typedef std::vector< DataPoint >	DataPoints
	Vector of coordinate pairs.

Detailed Description

Lowess (non-linear) model for transformations.

Constructor & Destructor Documentation

◆ TransformationModelLowess()

TransformationModelLowess	(	const DataPoints &	data,
		const Param &	params
	)

Constructor.

Exceptions

Exception::IllegalArgument is thrown if too few data points are provided.

◆ ~TransformationModelLowess()

~TransformationModelLowess ( )

override

Destructor.

Member Function Documentation

◆ evaluate()

double evaluate ( double value ) const

inlineoverridevirtual

Evaluates the model at the given value.

Reimplemented from TransformationModel.

◆ getDefaultParameters()

static void getDefaultParameters ( Param & params )

static

Gets the default parameters.

◆ getParameters()

const Param & getParameters ( ) const

Gets the (actual) parameters.

Member Data Documentation

◆ model_

TransformationModelInterpolated* model_

protected

Pointer to the underlying interpolation.

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members