Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

BaseMapMatcher Class Template Reference

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

Inheritance diagram for BaseMapMatcher:

MapMatcherRegression

List of all members.


Detailed Description

template<typename ElementT = Feature>
class OpenMS::BaseMapMatcher< ElementT >

The base class of the map matching algorithm.

This class defines the basic interface for all mapmatching algorithms. It expects a list of element pairs together with a quality value for each pair and the coordinates of a grid covering the map.

It then estimates the parameters of a transformation describing the shift in retention time and m/z between the two maps.

Public Types

typedef ElementT ElementType
 Element type.
typedef std::vector
< ElementPair< ElementType > > 
ElementPairVector
 The element pairs are computed by the element matching class.
typedef DoubleReal QualityType
 Quality type.

Public Member Functions

 BaseMapMatcher ()
 Constructor.
bool operator== (const BaseMapMatcher &rhs)
 Equality operator.
virtual ~BaseMapMatcher ()
 Destructor.
void setGrid (const Grid &g)
 Set grid.
GridgetGrid ()
 Get grid.
const GridgetGrid () const
 Get grid (non-mutable).
void setElementPairs (const ElementPairVector &plist)
 Set element pair list.
ElementPairVectorgetElementPairs ()
 Get element pair list.
const ElementPairVectorgetElementPairs () const
 Get element pair list (non-mutable).
void setMinQuality (QualityType qu)
 Set quality.
QualityTypegetMinQuality ()
 Get quality.
QualityType getMinQuality () const
 Get quality.
virtual void estimateTransform ()=0
 Estimates the transformation for each grid cell.

Protected Attributes

Grid grid_
 Vector of DRange instances defining a grid over the map.
ElementPairVector element_pairs_
 Vector of pairs of elements that have been identified by the element matcher.
QualityType min_quality_
 Minimum quality that we accept for element pairs, defined in param class.


Member Typedef Documentation

typedef ElementT ElementType

Element type.

Reimplemented in MapMatcherRegression.

typedef std::vector< ElementPair < ElementType > > ElementPairVector

The element pairs are computed by the element matching class.

Reimplemented in MapMatcherRegression.

typedef DoubleReal QualityType

Quality type.


Constructor & Destructor Documentation

BaseMapMatcher (  )  [inline]

Constructor.

virtual ~BaseMapMatcher (  )  [inline, virtual]

Destructor.


Member Function Documentation

bool operator== ( const BaseMapMatcher< ElementT > &  rhs  )  [inline]

Equality operator.

void setGrid ( const Grid g  )  [inline]

Set grid.

Grid& getGrid (  )  [inline]

Get grid.

const Grid& getGrid (  )  const [inline]

Get grid (non-mutable).

void setElementPairs ( const ElementPairVector plist  )  [inline]

Set element pair list.

ElementPairVector& getElementPairs (  )  [inline]

Get element pair list.

const ElementPairVector& getElementPairs (  )  const [inline]

Get element pair list (non-mutable).

void setMinQuality ( QualityType  qu  )  [inline]

Set quality.

QualityType& getMinQuality (  )  [inline]

Get quality.

QualityType getMinQuality (  )  const [inline]

Get quality.

virtual void estimateTransform (  )  [pure virtual]

Estimates the transformation for each grid cell.

Implemented in MapMatcherRegression.


Member Data Documentation

Grid grid_ [protected]

Vector of DRange instances defining a grid over the map.

ElementPairVector element_pairs_ [protected]

Vector of pairs of elements that have been identified by the element matcher.

QualityType min_quality_ [protected]

Minimum quality that we accept for element pairs, defined in param class.


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:41 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1