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

PoseClusteringPairwiseMapMatcher Class Template Reference

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

Inheritance diagram for PoseClusteringPairwiseMapMatcher:

BasePairwiseMapMatcher FactoryProduct DefaultParamHandler

List of all members.


Detailed Description

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

This class represents a point matching algorithm.

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).

Therefore it first estimates the transformation, which maps one point map onto the other. This is done by a superimposer class (e.g. PoseClusteringShiftSuperimposer or the PoseClusteringAffineSuperimposer). Afterwards a pairfinder class (e.g. SimplePairFinder or DelaunayPairFinder) dewarps the data and searches for corresponding points in both maps.

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()!
PoseClusteringPairwiseMapMatcher Parameters are explained on a separate page.

Public Types

enum  Maps { MODEL = 0, SCENE = 1 }
typedef BasePairwiseMapMatcher
< MapT > 
Base
 Base.
typedef Base::PointMapType PointMapType
 Container for input elements.
typedef Base::ElementType ElementType
 Type of elements considered here.
typedef Base::PositionType PositionType
 Position.
typedef Base::CoordinateType CoordinateType
 Coordinate.
typedef
DPeakConstReferenceArray
< PointMapType
PeakConstReferenceMapType

Public Member Functions

 PoseClusteringPairwiseMapMatcher ()
 Constructor.
virtual ~PoseClusteringPairwiseMapMatcher ()
 Destructor.
virtual void run ()
 Estimates the transformation for each grid cell and searches for element pairs.

Static Public Member Functions

static BasePairwiseMapMatcher
< MapT > * 
create ()
 Returns an instance of this class.
static const String getProductName ()
 Returns the name of this module.

Protected Member Functions

virtual void updateMembers_ ()
 This method is used to update extra member variables at the end of the setParam() method.
void computeMatching_ (const PeakConstReferenceMapType &model_map, const std::vector< PeakConstReferenceMapType > &scene_grid_maps)
 Computes the matching between each grid cell in the scene map and the model map.
void buildGrid_ (const PeakConstReferenceMapType &scene_map, std::vector< PeakConstReferenceMapType > &scene_grid_maps)
 Initializes a peak pointer map for each grid cell of the scene (second) map.

Protected Attributes

BaseSuperimposer
< PeakConstReferenceMapType > * 
superimposer_
 This class computes the shift for the best mapping of one element map to another.
BasePairFinder
< PeakConstReferenceMapType > * 
pair_finder_
 Given the shift, the pair_finder_ searches for corresponding elements in the two maps.

Member Typedef Documentation

typedef BasePairwiseMapMatcher<MapT> Base

Base.

typedef Base::PointMapType PointMapType

Container for input elements.

Reimplemented from BasePairwiseMapMatcher.

typedef Base::ElementType ElementType

Type of elements considered here.

Reimplemented from BasePairwiseMapMatcher.

typedef Base::PositionType PositionType

Position.

Reimplemented from BasePairwiseMapMatcher.

typedef Base::CoordinateType CoordinateType

Coordinate.

Reimplemented from BasePairwiseMapMatcher.

typedef DPeakConstReferenceArray< PointMapType > PeakConstReferenceMapType


Member Enumeration Documentation

enum Maps

Symbolic names for indices of element maps etc. This should make things more understandable and maintainable.

Enumerator:
MODEL 
SCENE 


Constructor & Destructor Documentation

PoseClusteringPairwiseMapMatcher (  )  [inline]

Constructor.

virtual ~PoseClusteringPairwiseMapMatcher (  )  [inline, virtual]

Destructor.


Member Function Documentation

static BasePairwiseMapMatcher<MapT>* create (  )  [inline, static]

Returns an instance of this class.

static const String getProductName (  )  [inline, static]

Returns the name of this module.

virtual void run (  )  [inline, virtual]

Estimates the transformation for each grid cell and searches for element pairs.

Implements BasePairwiseMapMatcher.

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 BasePairwiseMapMatcher.

void computeMatching_ ( const PeakConstReferenceMapType model_map,
const std::vector< PeakConstReferenceMapType > &  scene_grid_maps 
) [inline, protected]

Computes the matching between each grid cell in the scene map and the model map.

void buildGrid_ ( const PeakConstReferenceMapType scene_map,
std::vector< PeakConstReferenceMapType > &  scene_grid_maps 
) [inline, protected]

Initializes a peak pointer map for each grid cell of the scene (second) map.


Member Data Documentation

BaseSuperimposer<PeakConstReferenceMapType>* superimposer_ [protected]

This class computes the shift for the best mapping of one element map to another.

BasePairFinder< PeakConstReferenceMapType >* pair_finder_ [protected]

Given the shift, the pair_finder_ searches for corresponding elements in the two maps.


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