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

ConsensusMap Class Template Reference
[Kernel]

#include <OpenMS/KERNEL/ConsensusMap.h>

Inheritance diagram for ConsensusMap:

DPeakArray< ConsensusElementT > PersistentObject

List of all members.


Detailed Description

template<typename ConsensusElementT = ConsensusFeature < FeatureMap< > >>
class OpenMS::ConsensusMap< ConsensusElementT >

A container for consensus elements.

A ConsensusMap is a container holding 2-dimensional consensus elements (ConsensusFeature or ConsensusPeak) which in turn represent combined elements of 2-dimensional experiments. The map is implemented as a vector of elements and have basically the same interface as an STL vector (model of Random Access Container and Back Insertion Sequence).

Improvement:
use STL list instead of vector, because of insertion and deletion of elements (Eva)

Public Types

typedef ConsensusElementT ConsensusElementType
 Consensus element type.
typedef
ConsensusElementType::Group::const_iterator 
ConsensusElementIterator
 Consensus element iterator.
typedef DPeakArray
< ConsensusElementType
Base
 Base class type.
typedef Base::iterator Iterator
 Mutable iterator.
typedef Base::const_iterator ConstIterator
 Non-mutable iterator.
typedef Base::reverse_iterator ReverseIterator
 Mutable reverse iterator.
typedef
Base::const_reverse_iterator 
ConstReverseIterator
 Non-mutable reverse iterator.

Public Member Functions

 ConsensusMap ()
 Constructor.
 ConsensusMap (const ConsensusMap &source)
 Copy constructor.
 ~ConsensusMap ()
 Destructor.
 ConsensusMap (typename Base::size_type n)
 Creates a ConsensusMap with n elements.
ConsensusMapoperator= (const ConsensusMap &source)
 Assignment operator.
const std::vector< typename
ConsensusElementType::ElementContainerType * > & 
getMapVector () const
 Non-mutable access to the maps.
std::vector< typename
ConsensusElementType::ElementContainerType * > & 
getMapVector ()
 Mutable access to the maps.
void setMapVector (const std::vector< typename ConsensusElementType::ElementContainerType * > &map_vector)
 Mutable access to the maps.
const std::vector< String > & getFilenames () const
 Non-mutable access to the filenames.
std::vector< String > & getFilenames ()
 Mutable access to the filenames.
void setFilenames (const std::vector< String > &filenames)
 Mutable access to filenames.
void merge (ConsensusMap< ConsensusElementT > &new_map)
 Merge overlapping consensus elements.

Protected Attributes

std::vector< typename
ConsensusElementType::ElementContainerType * > 
map_vector_
 Vector of element maps.
std::vector< Stringfilenames_
 Vector of element map filenames.

Member Typedef Documentation

typedef ConsensusElementT ConsensusElementType

Consensus element type.

typedef ConsensusElementType::Group::const_iterator ConsensusElementIterator

Consensus element iterator.

typedef DPeakArray<ConsensusElementType > Base

Base class type.

Reimplemented from DPeakArray< ConsensusElementT >.

typedef Base::iterator Iterator

Mutable iterator.

Reimplemented from DPeakArray< ConsensusElementT >.

typedef Base::const_iterator ConstIterator

Non-mutable iterator.

Reimplemented from DPeakArray< ConsensusElementT >.

typedef Base::reverse_iterator ReverseIterator

Mutable reverse iterator.

Reimplemented from DPeakArray< ConsensusElementT >.

typedef Base::const_reverse_iterator ConstReverseIterator

Non-mutable reverse iterator.

Reimplemented from DPeakArray< ConsensusElementT >.


Constructor & Destructor Documentation

ConsensusMap (  )  [inline]

Constructor.

ConsensusMap ( const ConsensusMap< ConsensusElementT > &  source  )  [inline]

Copy constructor.

~ConsensusMap (  )  [inline]

Destructor.

ConsensusMap ( typename Base::size_type  n  )  [inline]

Creates a ConsensusMap with n elements.


Member Function Documentation

ConsensusMap& operator= ( const ConsensusMap< ConsensusElementT > &  source  )  [inline]

Assignment operator.

const std::vector< typename ConsensusElementType::ElementContainerType* >& getMapVector (  )  const [inline]

Non-mutable access to the maps.

std::vector< typename ConsensusElementType::ElementContainerType* >& getMapVector (  )  [inline]

Mutable access to the maps.

void setMapVector ( const std::vector< typename ConsensusElementType::ElementContainerType * > &  map_vector  )  [inline]

Mutable access to the maps.

const std::vector< String >& getFilenames (  )  const [inline]

Non-mutable access to the filenames.

std::vector< String >& getFilenames (  )  [inline]

Mutable access to the filenames.

void setFilenames ( const std::vector< String > &  filenames  )  [inline]

Mutable access to filenames.

void merge ( ConsensusMap< ConsensusElementT > &  new_map  )  [inline]

Merge overlapping consensus elements.


Member Data Documentation

std::vector< typename ConsensusElementType::ElementContainerType* > map_vector_ [protected]

Vector of element maps.

std::vector< String > filenames_ [protected]

Vector of element map filenames.


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