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

ElementPair Class Template Reference

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

Inheritance diagram for ElementPair:

pair

List of all members.


Detailed Description

template<typename ElementType = Feature>
class OpenMS::ElementPair< ElementType >

A pair of element in two different maps.

The purpose of the mapmatching stage is to identify pairs of features in different map, to estimate a transformation that maps features in a specified range onto each other and to execute this transform (dewarping).

Public Types

typedef std::pair< ElementType,
ElementType > 
Base
typedef DoubleReal QualityType

Public Member Functions

ElementPairoperator= (const ElementPair &rhs)
 assignment operator
bool operator== (const ElementPair &rhs) const
bool operator!= (const ElementPair &rhs) const
Constructors and Destructor
 ElementPair ()
 Default constructor.
 ElementPair (const ElementPair &fp)
 Copy constructor.
 ElementPair (ElementType const &first, ElementType const &second, QualityType const &quality=QualityType(0))
virtual ~ElementPair ()
 Destructor.
Accessors
const ElementType & getFirst () const
 Non-mutable access to the first feature.
ElementType & getFirst ()
 Mutable access to the first feature.
void setFirst (const ElementType &frt)
 Non-mutable access to the first feature.
const ElementType & getSecond () const
 Non-mutable access to the second feature.
ElementType & getSecond ()
 Mutable access to the second feature.
void setSecond (const ElementType &sec)
 Non-mutable access to the second feature.
QualityType getQuality () const
 Non-mutable access to the quality of the pair.
QualityTypegetQuality ()
 Mutable access to the quality of the pair.
void setQuality (QualityType ql)
 Mutable access to the quality of the pair.

Protected Attributes

QualityType quality_
 quality of the pair (not individual features)


Member Typedef Documentation

typedef std::pair<ElementType,ElementType> Base

typedef DoubleReal QualityType


Constructor & Destructor Documentation

ElementPair (  )  [inline]

Default constructor.

ElementPair ( const ElementPair< ElementType > &  fp  )  [inline]

Copy constructor.

ElementPair ( ElementType const &  first,
ElementType const &  second,
QualityType const &  quality = QualityType(0) 
) [inline]

virtual ~ElementPair (  )  [inline, virtual]

Destructor.


Member Function Documentation

ElementPair& operator= ( const ElementPair< ElementType > &  rhs  )  [inline]

assignment operator

bool operator== ( const ElementPair< ElementType > &  rhs  )  const [inline]

bool operator!= ( const ElementPair< ElementType > &  rhs  )  const [inline]

const ElementType& getFirst (  )  const [inline]

Non-mutable access to the first feature.

ElementType& getFirst (  )  [inline]

Mutable access to the first feature.

void setFirst ( const ElementType &  frt  )  [inline]

Non-mutable access to the first feature.

const ElementType& getSecond (  )  const [inline]

Non-mutable access to the second feature.

ElementType& getSecond (  )  [inline]

Mutable access to the second feature.

void setSecond ( const ElementType &  sec  )  [inline]

Non-mutable access to the second feature.

QualityType getQuality (  )  const [inline]

Non-mutable access to the quality of the pair.

QualityType& getQuality (  )  [inline]

Mutable access to the quality of the pair.

void setQuality ( QualityType  ql  )  [inline]

Mutable access to the quality of the pair.


Member Data Documentation

QualityType quality_ [protected]

quality of the pair (not individual features)


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