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

MapAlignmentAlgorithmPoseClustering Class Reference
[MapAlignment]

A map alignment algorithm based on pose clustering. More...

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

Inheritance diagram for MapAlignmentAlgorithmPoseClustering:
MapAlignmentAlgorithm DefaultParamHandler ProgressLogger

List of all members.

Public Member Functions

 MapAlignmentAlgorithmPoseClustering ()
 Default constructor.
virtual ~MapAlignmentAlgorithmPoseClustering ()
 Destructor.
void align (const FeatureMap<> &map, TransformationDescription &trafo)
void align (const MSExperiment<> &map, TransformationDescription &trafo)
void align (const ConsensusMap &map, TransformationDescription &trafo)
template<typename MapType >
void setReference (const MapType &map)

Static Public Member Functions

static MapAlignmentAlgorithmcreate ()
 Creates a new instance of this class (for Factory).
static String getProductName ()
 Returns the product name (for the Factory).

Protected Member Functions

virtual void updateMembers_ ()

Protected Attributes

PoseClusteringAffineSuperimposer superimposer_
StablePairFinder pairfinder_
ConsensusMap reference_
Int max_num_peaks_considered_

Private Member Functions

 MapAlignmentAlgorithmPoseClustering (const MapAlignmentAlgorithmPoseClustering &)
 Copy constructor intentionally not implemented -> private.
MapAlignmentAlgorithmPoseClusteringoperator= (const MapAlignmentAlgorithmPoseClustering &)
 Assignment operator intentionally not implemented -> private.

Detailed Description

A map alignment algorithm based on pose clustering.

Pose clustering analyzes pair distances to find the most probable transformation of retention times. The algorithm choses the x most intensity peaks/features per map. This is modeled via the parameter 'max_num_peaks_considered', which in turn influences the runtime and stability of the results. Bigger values prolong computation, smaller values might lead to no or unstable trafos. Set to -1 to use all features (might take very long for large maps).

For further details see:
Eva Lange et.al
A Geometric Approach for the Alignment of Liquid Chromatography-Mass Spectrometry Data
ISMB/ECCB 2007

Parameters of this class are:

NameTypeDefaultRestrictionsDescription
max_num_peaks_considered int1000 min: -1The maximal number of peaks/features to be considered per map. To use all, set to '-1'.
superimposer:mz_pair_max_distance float0.5 min: 0Maximum of m/z deviation of corresponding elements in different maps. This condition applies to the pairs considered in hashing.
superimposer:rt_pair_distance_fraction float0.1 min: 0 max: 1Within each of the two maps, the pairs considered for pose clustering must be separated by at least this fraction of the total elution time interval (i.e., max - min).
superimposer:num_used_points int2000 min: -1Maximum number of elements considered in each map (selected by intensity). Use this to reduce the running time and to disregard weak signals during alignment. For using all points, set this to -1.
superimposer:scaling_bucket_size float0.005 min: 0The scaling of the retention time interval is being hashed into buckets of this size during pose clustering. A good choice for this would be a bit smaller than the error you would expect from repeated runs.
superimposer:shift_bucket_size float3 min: 0The shift at the lower (respectively, higher) end of the retention time interval is being hashed into buckets of this size during pose clustering. A good choice for this would be about the time between consecutive MS scans.
superimposer:max_shift float1000 min: 0Maximal shift which is considered during histogramming. This applies for both directions.
superimposer:max_scaling float2 min: 1Maximal scaling which is considered during histogramming. The minimal scaling is the reciprocal of this.
superimposer:dump_buckets string  [DEBUG] If non-empty, base filename where hash table buckets will be dumped to. A serial number for each invocation will be appended automatically.
superimposer:dump_pairs string  [DEBUG] If non-empty, base filename where the individual hashed pairs will be dumped to (large!). A serial number for each invocation will be appended automatically.
pairfinder:second_nearest_gap float2 min: 1The distance to the second nearest neighbors must be larger by this factor than the distance to the matching element itself.
pairfinder:use_identifications stringfalse true, falseNever link features that are annotated with different peptides (only the best hit per peptide identification is taken into account).
pairfinder:ignore_charge stringfalse true, falseCompare features normally even if their charge states are different
pairfinder:distance_RT:max_difference float100 min: 0Maximum allowed difference in RT in seconds
pairfinder:distance_RT:exponent float1 min: 0Normalized RT differences are raised to this power (using 1 or 2 will be fast, everything else is REALLY slow)
pairfinder:distance_RT:weight float1 min: 0RT distances are weighted by this factor
pairfinder:distance_MZ:max_difference float0.3 min: 0Maximum allowed difference in m/z (unit defined by 'unit')
pairfinder:distance_MZ:unit stringDa Da, ppmUnit of the 'max_difference' parameter
pairfinder:distance_MZ:exponent float2 min: 0Normalized m/z differences are raised to this power (using 1 or 2 will be fast, everything else is REALLY slow)
pairfinder:distance_MZ:weight float1 min: 0m/z distances are weighted by this factor
pairfinder:distance_intensity:exponent float1 min: 0Differences in relative intensity are raised to this power (using 1 or 2 will be fast, everything else is REALLY slow)
pairfinder:distance_intensity:weight float0 min: 0Distances based on relative intensity are weighted by this factor

Note:

Constructor & Destructor Documentation

Default constructor.

virtual ~MapAlignmentAlgorithmPoseClustering (  )  [virtual]

Destructor.

Copy constructor intentionally not implemented -> private.


Member Function Documentation

void align ( const FeatureMap<> &  map,
TransformationDescription trafo 
)
void align ( const MSExperiment<> &  map,
TransformationDescription trafo 
)
void align ( const ConsensusMap map,
TransformationDescription trafo 
)
static MapAlignmentAlgorithm* create (  )  [inline, static]

Creates a new instance of this class (for Factory).

static String getProductName (  )  [inline, static]

Returns the product name (for the Factory).

Assignment operator intentionally not implemented -> private.

void setReference ( const MapType &  map  )  [inline]
virtual void updateMembers_ (  )  [protected, virtual]

Member Data Documentation

ConsensusMap reference_ [protected]

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