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

BasePairwiseMapMatcher Class Template Reference

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

Inheritance diagram for BasePairwiseMapMatcher:

FactoryProduct DefaultParamHandler PoseClusteringPairwiseMapMatcher

List of all members.


Detailed Description

template<typename MapT = FeatureMap< >>
class OpenMS::BasePairwiseMapMatcher< MapT >

The base class of all pairwise point matching algorithms.

This class defines the basic interface for all point matching algorithms. It works on two point maps and computes a vector of corresponding points in both maps (given by a point pairs vector). A point can be a DPeak, a DFeature, a ConsensusPeak or ConsensusFeature (wheras DFeature is the default element type).

The point pairs created by the algorithm solve a (bipartite) matching problem between two point maps. Therefore first a transformation is estimated, that maps the one map (the so called scene map) onto the other map (the so called model map). Given the transformation correspoinding elements in the two maps are determined.

Note:
If a piecewise transformation is assumed, the user can define a grid by setting the number of buckets in the RT as well as the MZ dimension. Call initGridTransformation() before run()!

Public Types

typedef MapT PointMapType
 Container for input elements.
typedef PointMapType::value_type ElementType
 Type of elements considered here.
typedef ElementPair< ElementTypeElementPairType
 Type of element pairs.
typedef std::vector
< ElementPairType
ElementPairVectorType
 Container for generated element pairs.
typedef DPosition< 2 > PositionType
 Position.
typedef DBoundingBox< 2 > PositionBoundingBoxType
typedef DoubleReal CoordinateType
 Coordinate.

Public Member Functions

 BasePairwiseMapMatcher ()
 Constructor.
virtual ~BasePairwiseMapMatcher ()
 Destructor.
void setElementMap (UInt const index, const PointMapType &element_map)
 Set element map.
const PointMapTypegetElementMap (UInt index) const
 Get element map.
const ElementPairVectorTypegetElementPairs () const
 Get element pair list.
const GridgetGrid () const
 Get grid.
void setNumberBuckets (UInt dim, UInt number)
 Set number of buckets in dimension dim.
UInt getNumberBuckets (UInt index) const
 Get number of buckets in dimension index.
virtual void run ()=0
 Determine corresponding elements (element pairs).
void initGridTransformation (const PointMapType &scene_map)
 Initializes the grid for the scene map given the number of buckets in rt and mz. This method has to be called before run()!

Static Public Member Functions

static void registerChildren ()
 Register all derived classes here.

Protected Member Functions

virtual void updateMembers_ ()
 This method is used to update extra member variables at the end of the setParam() method.

Protected Attributes

PointMapType const * element_map_ [2]
 Two maps of elements to be matched.
ElementPairVectorType all_element_pairs_
 Each element of the vector corresponds to all element pairs of one gridcell.
Grid grid_
 The estimated transformation between the two element maps.
PositionBoundingBoxType bounding_box_scene_map_
 Bounding box of the second map.
PositionType box_size_
 UInt of the grid cells.
UInt number_buckets_ [2]
 Number of buckets in each dimension.

Member Typedef Documentation

typedef MapT PointMapType

Container for input elements.

Reimplemented in PoseClusteringPairwiseMapMatcher.

typedef PointMapType::value_type ElementType

Type of elements considered here.

Reimplemented in PoseClusteringPairwiseMapMatcher.

typedef ElementPair< ElementType > ElementPairType

Type of element pairs.

typedef std::vector< ElementPairType > ElementPairVectorType

Container for generated element pairs.

typedef DPosition< 2 > PositionType

Position.

Reimplemented in PoseClusteringPairwiseMapMatcher.

typedef DBoundingBox< 2> PositionBoundingBoxType

typedef DoubleReal CoordinateType

Coordinate.

Reimplemented in PoseClusteringPairwiseMapMatcher.


Constructor & Destructor Documentation

BasePairwiseMapMatcher (  )  [inline]

Constructor.

virtual ~BasePairwiseMapMatcher (  )  [inline, virtual]

Destructor.


Member Function Documentation

void setElementMap ( UInt const   index,
const PointMapType element_map 
) [inline]

Set element map.

const PointMapType& getElementMap ( UInt  index  )  const [inline]

Get element map.

const ElementPairVectorType& getElementPairs (  )  const [inline]

Get element pair list.

const Grid& getGrid (  )  const [inline]

Get grid.

void setNumberBuckets ( UInt  dim,
UInt  number 
) [inline]

Set number of buckets in dimension dim.

UInt getNumberBuckets ( UInt  index  )  const [inline]

Get number of buckets in dimension index.

void registerChildren (  )  [inline, static]

Register all derived classes here.

virtual void run (  )  [pure virtual]

Determine corresponding elements (element pairs).

Implemented in PoseClusteringPairwiseMapMatcher.

void initGridTransformation ( const PointMapType scene_map  )  [inline]

Initializes the grid for the scene map given the number of buckets in rt and mz. This method has to be called before run()!

virtual void updateMembers_ (  )  [inline, protected, virtual]

This method is used to update extra member variables at the end of the setParam() method.

Also call it at the end of the derived classes' copy constructor and assignment operator.

The default implementation is empty.

Reimplemented from DefaultParamHandler.

Reimplemented in PoseClusteringPairwiseMapMatcher.


Member Data Documentation

PointMapType const* element_map_[2] [protected]

Two maps of elements to be matched.

ElementPairVectorType all_element_pairs_ [protected]

Each element of the vector corresponds to all element pairs of one gridcell.

Grid grid_ [protected]

The estimated transformation between the two element maps.

PositionBoundingBoxType bounding_box_scene_map_ [protected]

Bounding box of the second map.

PositionType box_size_ [protected]

UInt of the grid cells.

UInt number_buckets_[2] [protected]

Number of buckets in each dimension.


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