| OpenMS 2.5.0

MapAlignmentEvaluationAlgorithmPrecision.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-2020.
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: Timo Sachsenberg $
32 // $Authors: Katharina Albers $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/ANALYSIS/MAPMATCHING/MapAlignmentEvaluationAlgorithm.h>
38
39 namespace OpenMS
40 {
48 class OPENMS_DLLAPI MapAlignmentEvaluationAlgorithmPrecision :
49 public MapAlignmentEvaluationAlgorithm
50 {
51 public:
53 MapAlignmentEvaluationAlgorithmPrecision();
54
56 ~MapAlignmentEvaluationAlgorithmPrecision() override;
57
61 void evaluate(const ConsensusMap & consensus_map_in, const ConsensusMap & consensus_map_gt, const double & rt_dev, const double & mz_dev, const Peak2D::IntensityType & int_dev, const bool use_charge, double & out) override;
62
64 static MapAlignmentEvaluationAlgorithm * create()
65 {
66 return new MapAlignmentEvaluationAlgorithmPrecision();
67 }
68
70 static String getProductName()
71 {
72 return "precision";
73 }
74
75 private:
76
78 MapAlignmentEvaluationAlgorithmPrecision(const MapAlignmentEvaluationAlgorithmPrecision &);
80 MapAlignmentEvaluationAlgorithmPrecision & operator=(const MapAlignmentEvaluationAlgorithmPrecision &);
81
82 };
83
84 } // namespace OpenMS
85
OpenMS::MapAlignmentEvaluationAlgorithmPrecision::create
static MapAlignmentEvaluationAlgorithm * create()
Creates a new instance of this class (for Factory)
Definition: MapAlignmentEvaluationAlgorithmPrecision.h:64
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::MapAlignmentEvaluationAlgorithmPrecision::getProductName
static String getProductName()
Returns the product name (for the Factory)
Definition: MapAlignmentEvaluationAlgorithmPrecision.h:70
MapAlignmentEvaluationAlgorithm.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::MapAlignmentEvaluationAlgorithm
Base class for all Caap evaluation algorithms.
Definition: MapAlignmentEvaluationAlgorithm.h:47
float
OpenMS::ConsensusMap
A container for consensus elements.
Definition: ConsensusMap.h:79
OpenMS::MapAlignmentEvaluationAlgorithmPrecision
Caap evaluation algorithm to obtain a precision value.
Definition: MapAlignmentEvaluationAlgorithmPrecision.h:48