| OpenMS 2.5.0

IsobaricQuantifier.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: Stephan Aiche, Chris Bielow $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/DATASTRUCTURES/DefaultParamHandler.h>
38 #include <OpenMS/ANALYSIS/QUANTITATION/IsobaricQuantifierStatistics.h>
39
40 namespace OpenMS
41 {
42 class IsobaricQuantitationMethod;
43 class ConsensusMap;
44
51 class OPENMS_DLLAPI IsobaricQuantifier :
52 public DefaultParamHandler
53 {
54 public:
60 explicit IsobaricQuantifier(const IsobaricQuantitationMethod* const quant_method);
61
63 IsobaricQuantifier(const IsobaricQuantifier& other);
64
66 IsobaricQuantifier& operator=(const IsobaricQuantifier& rhs);
67
77 void quantify(const ConsensusMap& consensus_map_in, ConsensusMap& consensus_map_out);
78
79 protected:
81 void setDefaultParams_();
82
84 void updateMembers_() override;
85
86 private:
88 IsobaricQuantifierStatistics stats_;
89
91 const IsobaricQuantitationMethod* quant_method_;
92
94 bool isotope_correction_enabled_;
95
97 bool normalization_enabled_;
98
100 void computeLabelingStatistics_(ConsensusMap& consensus_map_out);
101 };
102 } // namespace
103
OpenMS::IsobaricQuantifier::stats_
IsobaricQuantifierStatistics stats_
Stats of current quantitation run.
Definition: IsobaricQuantifier.h:88
OpenMS::DefaultParamHandler
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:91
OpenMS::IsobaricQuantitationMethod
Abstract base class describing an isobaric quantitation method in terms of the used channels and an i...
Definition: IsobaricQuantitationMethod.h:54
OpenMS::IsobaricQuantifier::normalization_enabled_
bool normalization_enabled_
Is true if normalization is enabled, false otherwise.
Definition: IsobaricQuantifier.h:97
OpenMS::IsobaricQuantifier::isotope_correction_enabled_
bool isotope_correction_enabled_
Is true if isotope correction is enabled, false otherwise.
Definition: IsobaricQuantifier.h:94
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
DefaultParamHandler.h
OpenMS::IsobaricQuantifierStatistics
Statistics for quantitation performance and comparison of NNLS vs. naive method (aka matrix inversion...
Definition: IsobaricQuantifierStatistics.h:48
OpenMS::IsobaricQuantifier::quant_method_
const IsobaricQuantitationMethod * quant_method_
The quantification method used for the dataset to be analyzed.
Definition: IsobaricQuantifier.h:91
OpenMS::ConsensusMap
A container for consensus elements.
Definition: ConsensusMap.h:79
OpenMS::IsobaricQuantifier
Given the extracted channel intensities the IsobaricQuantifier corrects and normalizes the intensitie...
Definition: IsobaricQuantifier.h:51
IsobaricQuantifierStatistics.h