Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
MapAlignmentAlgorithmPoseClustering.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2015.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Clemens Groepl $
32 // $Authors: Eva Lange, Clemens Groepl $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_ANALYSIS_MAPMATCHING_MAPALIGNMENTALGORITHMPOSECLUSTERING_H
36 #define OPENMS_ANALYSIS_MAPMATCHING_MAPALIGNMENTALGORITHMPOSECLUSTERING_H
37 
43 
45 
46 namespace OpenMS
47 {
69  {
70 public:
73 
76 
77  void align(const FeatureMap & map, TransformationDescription & trafo);
78  void align(const MSExperiment<> & map, TransformationDescription & trafo);
79  void align(const ConsensusMap & map, TransformationDescription & trafo);
80 
81  template <typename MapType>
82  void setReference(const MapType & map)
83  {
84  MapType map2 = map; // todo: avoid copy (MSExperiment version of convert() demands non-const version)
85  MapConversion::convert(0, map2, reference_, max_num_peaks_considered_);
86  }
87 
90  {
92  }
93 
96  {
97  return "pose_clustering";
98  }
99 
100 protected:
101 
102  virtual void updateMembers_();
103 
105 
107 
109 
111 
112 private:
113 
118  };
119 } // namespace OpenMS
120 
121 #endif // OPENMS_ANALYSIS_MAPMATCHING_MAPALIGNMENTALGORITHMPOSECLUSTERING_H
PoseClusteringAffineSuperimposer superimposer_
Definition: MapAlignmentAlgorithmPoseClustering.h:104
StablePairFinder pairfinder_
Definition: MapAlignmentAlgorithmPoseClustering.h:106
This class implements a pair finding algorithm for consensus features.
Definition: StablePairFinder.h:109
void setReference(const MapType &map)
Definition: MapAlignmentAlgorithmPoseClustering.h:82
A more convenient string class.
Definition: String.h:57
A container for features.
Definition: FeatureMap.h:93
Base class for all map-alignment algorithms.
Definition: MapAlignmentAlgorithm.h:58
A container for consensus elements.
Definition: ConsensusMap.h:72
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
A map alignment algorithm based on pose clustering.
Definition: MapAlignmentAlgorithmPoseClustering.h:67
Int max_num_peaks_considered_
Definition: MapAlignmentAlgorithmPoseClustering.h:110
static String getProductName()
Returns the product name (for the Factory)
Definition: MapAlignmentAlgorithmPoseClustering.h:95
static void convert(UInt64 const input_map_index, MSExperiment<> &input_map, ConsensusMap &output_map, Size n=-1)
Similar to convert for FeatureMaps.
Generic description of a coordinate transformation.
Definition: TransformationDescription.h:58
static MapAlignmentAlgorithm * create()
Creates a new instance of this class (for Factory)
Definition: MapAlignmentAlgorithmPoseClustering.h:89
A superimposer that uses a voting scheme, also known as pose clustering, to find a good affine transf...
Definition: PoseClusteringAffineSuperimposer.h:65
int Int
Signed integer type.
Definition: Types.h:96
ConsensusMap reference_
Definition: MapAlignmentAlgorithmPoseClustering.h:108

OpenMS / TOPP release 2.0.0 Documentation generated on Sat May 16 2015 16:13:23 using doxygen 1.8.9.1