Generic description of a coordinate transformation. More...
#include <OpenMS/ANALYSIS/MAPMATCHING/TransformationDescription.h>
| Public Types | |
| typedef TransformationModel::DataPoint | DataPoint | 
| Coordinate pair.  More... | |
| typedef TransformationModel::DataPoints | DataPoints | 
| Vector of coordinate pairs.  More... | |
| Public Member Functions | |
| TransformationDescription () | |
| Default constructor.  More... | |
| TransformationDescription (const DataPoints &data) | |
| Constructor from data.  More... | |
| ~TransformationDescription () | |
| Destructor.  More... | |
| TransformationDescription (const TransformationDescription &rhs) | |
| Copy constructor.  More... | |
| TransformationDescription & | operator= (const TransformationDescription &rhs) | 
| Assignment operator.  More... | |
| void | fitModel (const String &model_type, const Param ¶ms=Param()) | 
| Fits a model to the data.  More... | |
| DoubleReal | apply (DoubleReal value) const | 
| Applies the transformation to value.  More... | |
| const String & | getModelType () const | 
| Gets the type of the fitted model.  More... | |
| void | setDataPoints (const DataPoints &data) | 
| Sets the data points.  More... | |
| const DataPoints & | getDataPoints () const | 
| Returns the data points.  More... | |
| void | getModelParameters (Param ¶ms) const | 
| Non-mutable access to the model parameters.  More... | |
| void | invert () | 
| Computes an (approximate) inverse of the transformation.  More... | |
| Static Public Member Functions | |
| static void | getModelTypes (StringList &result) | 
| Gets the possible types of models.  More... | |
| Protected Attributes | |
| DataPoints | data_ | 
| Data points.  More... | |
| String | model_type_ | 
| Type of model.  More... | |
| TransformationModel * | model_ | 
| Pointer to model.  More... | |
Generic description of a coordinate transformation.
This description primarily stores data points (coordinate pairs) from which a transformation model can be estimated. Applying the transformation to a coordinate (via apply) then means evaluating the model at that coordinate.
The following models are available:
none (TransformationModel):  (identity)
 (identity)identity: Same as none, but intended for reference files (used to indicate that no other model should be fit, because the identity is already optimal).linear (TransformationModelLinear): 
interpolated (TransformationModelInterpolated): Interpolation between pairs, extrapolation using first and last pair. Supports different interpolation types.b_spline (TransformationModelBSpline): Smoothing cubic B-spline.Coordinate pair.
Vector of coordinate pairs.
Default constructor.
| TransformationDescription | ( | const DataPoints & | data | ) | 
Constructor from data.
Destructor.
| TransformationDescription | ( | const TransformationDescription & | rhs | ) | 
Copy constructor.
| DoubleReal apply | ( | DoubleReal | value | ) | const | 
Applies the transformation to value. 
Returns the result of evaluating the fitted model at value. Returns value unchanged if no model was fitted. 
Referenced by InternalCalibration::calibrateMapGlobally(), InternalCalibration::calibrateMapSpectrumwise(), ChromatogramExtractor::outsideExtractionWindow_(), and MRMFeatureFinderScoring::scorePeakgroups_().
Fits a model to the data.
| const DataPoints& getDataPoints | ( | ) | const | 
Returns the data points.
| void getModelParameters | ( | Param & | params | ) | const | 
Non-mutable access to the model parameters.
| const String& getModelType | ( | ) | const | 
Gets the type of the fitted model.
| 
 | static | 
Gets the possible types of models.
| void invert | ( | ) | 
Computes an (approximate) inverse of the transformation.
Referenced by ChromatogramExtractor::extractChromatograms(), and MRMFeatureFinderScoring::scorePeakgroups_().
| TransformationDescription& operator= | ( | const TransformationDescription & | rhs | ) | 
Assignment operator.
| void setDataPoints | ( | const DataPoints & | data | ) | 
Sets the data points.
Removes the model that was previously fitted to the data (if any).
| 
 | protected | 
Data points.
| 
 | protected | 
Pointer to model.
| 
 | protected | 
Type of model.
| OpenMS / TOPP release 1.11.1 | Documentation generated on Thu Nov 14 2013 11:19:26 using doxygen 1.8.5 |