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

BaseSuperimposer Class Reference

The base class of all superimposer algorithms. More...

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

Inheritance diagram for BaseSuperimposer:
DefaultParamHandler ProgressLogger PoseClusteringAffineSuperimposer PoseClusteringShiftSuperimposer

List of all members.

Public Member Functions

 BaseSuperimposer ()
 Constructor.
virtual ~BaseSuperimposer ()
 Destructor.
virtual void run (const ConsensusMap &map_model, const ConsensusMap &map_scene, TransformationDescription &transformation)=0
 Estimates the transformation between input maps and returns the estimated transformations.

Static Public Member Functions

static void registerChildren ()
 Register all derived classes here.

Private Member Functions

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

Detailed Description

The base class of all superimposer algorithms.

This class defines the basic interface for all superimposer algorithms. It works on several element maps and computes transformations that map the elements of the maps as near as possible to each other.


Constructor & Destructor Documentation

BaseSuperimposer (  )  [inline]

Constructor.

virtual ~BaseSuperimposer (  )  [inline, virtual]

Destructor.

BaseSuperimposer ( const BaseSuperimposer  )  [private]

Copy constructor intentionally not implemented.


Member Function Documentation

BaseSuperimposer& operator= ( const BaseSuperimposer  )  [private]

Assignment operator intentionally not implemented.

static void registerChildren (  )  [static]

Register all derived classes here.

virtual void run ( const ConsensusMap map_model,
const ConsensusMap map_scene,
TransformationDescription transformation 
) [pure virtual]

Estimates the transformation between input maps and returns the estimated transformations.

Exceptions:
IllegalArgument is thrown if the input maps are invalid.

Implemented in PoseClusteringAffineSuperimposer, and PoseClusteringShiftSuperimposer.


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