TransformationDescription#

class pyopenms.TransformationDescription#

Bases: object

Cython implementation of _TransformationDescription

Original C++ documentation is available here

__init__()#

Overload:

__init__(self) → None

Overload:

__init__(self, in_0: TransformationDescription) → None

Methods

__init__

Overload:

apply(self, in_0)

Applies the transformation to value

fitModel

Overload:

getDataPoints(self)

Returns the data points

getDeviations(self, diffs, do_apply, do_sort)

Get the deviations between the data pairs

getModelParameters(self)

Returns the model parameters

getModelType(self)

Gets the type of the fitted model

getModelTypes

__static_TransformationDescription_getModelTypes(result: List[bytes] ) -> None

getStatistics(self)

invert(self)

Computes an (approximate) inverse of the transformation

setDataPoints

Overload:
apply(self, in_0: float) → float#

Applies the transformation to value

fitModel()#

Overload:

fitModel(self, model_type: bytes | str | String, params: Param) → None

Fits a model to the data

Overload:

fitModel(self, model_type: bytes | str | String) → None

Fits a model to the data

getDataPoints(self) → List[TM_DataPoint]#

Returns the data points

getDeviations(self, diffs: List[float], do_apply: bool, do_sort: bool) → None#

Get the deviations between the data pairs

Parameters:

  • diffs – Output

  • do_apply – Get deviations after applying the model?

  • do_sort – Sort diffs before returning?

getModelParameters(self) → Param#

Returns the model parameters

getModelType(self) → bytes | str | String#

Gets the type of the fitted model

getModelTypes()#

__static_TransformationDescription_getModelTypes(result: List[bytes] ) -> None

getStatistics(self) → TransformationStatistics#
invert(self) → None#

Computes an (approximate) inverse of the transformation

setDataPoints()#

Overload:

setDataPoints(self, data: List[TM_DataPoint]) → None

Sets the data points. Removes the model that was previously fitted to the data (if any)

Overload:

setDataPoints(self, data: List[List[float, float]]) → None

Sets the data points (backwards-compatible overload). Removes the model that was previously fitted to the data (if any)