| OpenMS 2.5.0

Ms2IdentificationRate.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: Chris Bielow$
32 // $Authors: Patricia Scheil, Swenja Wagner$
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/CONCEPT/Types.h>
38 #include "OpenMS/QC/QCBase.h"
39 #include <string>
40 #include <vector>
41
42 namespace OpenMS
43 {
44 class FeatureMap;
45 class MSExperiment;
53 class OPENMS_DLLAPI Ms2IdentificationRate : public QCBase
54 {
55 public:
57 struct IdentificationRateData
58 {
59 UInt64 num_peptide_identification;
60 UInt64 num_ms2_spectra;
61 double identification_rate;
62 };
63
64 private:
66 const String name_ = "Ms2IdentificationRate";
67
69 std::vector<IdentificationRateData> rate_result_;
70
71 public:
73 Ms2IdentificationRate() = default;
74
76 virtual ~Ms2IdentificationRate() = default;
77
92 void compute(const FeatureMap& feature_map, const MSExperiment& exp, bool force_fdr = false);
93
95 const String& getName() const override;
96
98 const std::vector<IdentificationRateData>& getResults() const;
99
104 QCBase::Status requires() const override;
105 };
106
107 } // namespace OpenMS
OpenMS::Ms2IdentificationRate
This class is a metric for the QualityControl-ToppTool.
Definition: Ms2IdentificationRate.h:53
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::QCBase
This class serves as an abstract base class for all QC classes.
Definition: QCBase.h:52
OpenMS::UInt64
OPENMS_UINT64_TYPE UInt64
Unsigned integer type (64bit)
Definition: Types.h:77
OpenMS::Ms2IdentificationRate::IdentificationRateData::num_peptide_identification
UInt64 num_peptide_identification
Definition: Ms2IdentificationRate.h:59
OpenMS::MSExperiment
In-Memory representation of a mass spectrometry experiment.
Definition: MSExperiment.h:77
OpenMS::QCBase::Status
Storing a status of available/needed inputs (i.e. a set of Requires) as UInt64.
Definition: QCBase.h:118
OpenMS::Ms2IdentificationRate::IdentificationRateData::num_ms2_spectra
UInt64 num_ms2_spectra
Definition: Ms2IdentificationRate.h:60
OpenMS::FeatureMap
A container for features.
Definition: FeatureMap.h:95
OpenMS::Ms2IdentificationRate::rate_result_
std::vector< IdentificationRateData > rate_result_
container that stores results
Definition: Ms2IdentificationRate.h:69
Types.h
OpenMS::Ms2IdentificationRate::IdentificationRateData
Structure for storing results.
Definition: Ms2IdentificationRate.h:57
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
QCBase.h
OpenMS::Ms2IdentificationRate::IdentificationRateData::identification_rate
double identification_rate
Definition: Ms2IdentificationRate.h:61