Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions

BaseGroupFinder Class Reference

The base class of all element group finding algorithms. More...

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

Inheritance diagram for BaseGroupFinder:
DefaultParamHandler ProgressLogger LabeledPairFinder QTClusterFinder SimplePairFinder StablePairFinder

List of all members.

Public Member Functions

 BaseGroupFinder ()
 Default constructor.
virtual ~BaseGroupFinder ()
 Destructor.
virtual void run (const std::vector< ConsensusMap > &input, ConsensusMap &result)=0
 Run the algorithm.

Static Public Member Functions

static void registerChildren ()
 Register all derived classes here.

Protected Member Functions

void checkIds_ (const std::vector< ConsensusMap > &maps) const
 Checks if all file descriptions have disjoint map identifiers.

Private Member Functions

 BaseGroupFinder (const BaseGroupFinder &)
 Copy constructor intentionally not implemented.
BaseGroupFinder & operator= (const BaseGroupFinder &)
 Assignment operator intentionally not implemented.

Detailed Description

The base class of all element group finding algorithms.

This class defines the basic interface for all element group finding algorithms.

All derived algorithms take one or several consensus maps and find corresponding features across the maps (or within one map). They return one consensus map containing the found consensus features.

The element indices of the result consensus features are the container access indices of the input maps. The map indices of the result consensus features are are the indices in the input map vector.

Constructor & Destructor Documentation

BaseGroupFinder (  ) 

Default constructor.

virtual ~BaseGroupFinder (  )  [virtual]

Destructor.

BaseGroupFinder ( const BaseGroupFinder &   )  [private]

Copy constructor intentionally not implemented.

Member Function Documentation

void checkIds_ ( const std::vector< ConsensusMap > &  maps  )  const [protected]

Checks if all file descriptions have disjoint map identifiers.

Exceptions:
Exception::IllegalArgument Is thrown if a file id is found twice
BaseGroupFinder& operator= ( const BaseGroupFinder &   )  [private]

Assignment operator intentionally not implemented.

static void registerChildren (  )  [static]

Register all derived classes here.

virtual void run ( const std::vector< ConsensusMap > &  input,
ConsensusMap &  result 
) [pure virtual]

Run the algorithm.

Exceptions:
Exception::IllegalArgument is thrown if the input data is not valid.

Implemented in LabeledPairFinder, QTClusterFinder, SimplePairFinder, and StablePairFinder.

OpenMS / TOPP release 1.10.0 Documentation generated on Thu Mar 7 2013 09:42:49 using doxygen 1.7.1