Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
MapAlignmentAlgorithm.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: Marc Sturm, Clemens Groepl $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_ANALYSIS_MAPMATCHING_MAPALIGNMENTALGORITHM_H
36 #define OPENMS_ANALYSIS_MAPMATCHING_MAPALIGNMENTALGORITHM_H
37 
45 
46 namespace OpenMS
47 {
48 
58  class OPENMS_DLLAPI MapAlignmentAlgorithm :
59  public DefaultParamHandler,
60  public ProgressLogger
61  {
62 public:
65 
67  virtual ~MapAlignmentAlgorithm();
68 
74  virtual void alignPeakMaps(std::vector<MSExperiment<> > &, std::vector<TransformationDescription> &);
75 
81  virtual void alignCompactFeatureMaps(std::vector<std::vector<Peak2D> > &, std::vector<TransformationDescription> &);
82 
88  virtual void alignFeatureMaps(std::vector<FeatureMap > &, std::vector<TransformationDescription> &);
89 
95  virtual void alignConsensusMaps(std::vector<ConsensusMap> &, std::vector<TransformationDescription> &);
96 
102  virtual void alignPeptideIdentifications(std::vector<std::vector<PeptideIdentification> > &, std::vector<TransformationDescription> &);
103 
112  virtual void setReference(Size reference_index = 0, const String & reference_file = "");
113 
119  static void fitModel(const String & model_type, const Param & params, std::vector<TransformationDescription> & trafos);
120 
122  static void registerChildren();
123 
124 private:
128  MapAlignmentAlgorithm & operator=(const MapAlignmentAlgorithm &);
129 
130  };
131 
132 } // namespace OpenMS
133 
134 #endif // OPENMS_ANALYSIS_MAPMATCHING_MAPALIGNMENTALGORITHM_H
A more convenient string class.
Definition: String.h:57
Base class for all map-alignment algorithms.
Definition: MapAlignmentAlgorithm.h:58
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
Management and storage of parameters / INI files.
Definition: Param.h:75
Base class for all classes that want to report their progress.
Definition: ProgressLogger.h:55
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:92

OpenMS / TOPP release 2.0.0 Documentation generated on Wed Mar 30 2016 12:49:23 using doxygen 1.8.11