OpenMS
MissedCleavages.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-2023.
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: Swenja Wagner, Patricia Scheil $
33 // --------------------------------------------------------------------------
34 
35 
36 #pragma once
37 
41 #include <OpenMS/QC/QCBase.h>
42 #include <map>
43 #include <vector>
44 namespace OpenMS
45 {
46  class FeatureMap;
57  class OPENMS_DLLAPI MissedCleavages : public QCBase
58  {
59  private:
60  typedef std::map<UInt32, UInt32> MapU32;
63 
64  public:
66  MissedCleavages() = default;
67 
69  virtual ~MissedCleavages() = default;
70 
80  void compute(FeatureMap& fmap);
81  void compute(std::vector<ProteinIdentification>& prot_ids, std::vector<PeptideIdentification>& pep_ids);
82 
84  const String& getName() const override;
85 
87  const std::vector<std::map<UInt32, UInt32>>& getResults() const;
88 
93  QCBase::Status requirements() const override;
94 
95  private:
97  std::vector<std::map<UInt32, UInt32>> mc_result_;
98  };
99 } // namespace OpenMS
A container for features.
Definition: FeatureMap.h:106
Stores and handles combinations of enum values, e.g. a set of flags as bits flipped in an UInt64.
Definition: FlagSet.h:54
This class is a metric for the QualityControl TOPP Tool.
Definition: MissedCleavages.h:58
std::map< UInt32, UInt32 > MapU32
Definition: MissedCleavages.h:60
void compute(std::vector< ProteinIdentification > &prot_ids, std::vector< PeptideIdentification > &pep_ids)
std::vector< std::map< UInt32, UInt32 > > mc_result_
container that stores results
Definition: MissedCleavages.h:97
virtual ~MissedCleavages()=default
destructor
void compute(FeatureMap &fmap)
Counts the number of missed cleavages per PeptideIdentification.
const String & getName() const override
returns the name of the metric
QCBase::Status requirements() const override
Returns the input data requirements of the compute(...) function.
MissedCleavages()=default
constructor
const std::vector< std::map< UInt32, UInt32 > > & getResults() const
returns the result as maps of number of missed_cleavages to counts; one map for each call to compute(...
void get_missed_cleavages_from_peptide_identification_(const ProteaseDigestion &digestor, MapU32 &result, const UInt32 &max_mc, PeptideIdentification &pep_id)
collects number of missed cleavages from PeptideIdentification in a result map (missed cleavages: occ...
Represents the peptide hits for a spectrum.
Definition: PeptideIdentification.h:65
Class for the enzymatic digestion of proteins represented as AASequence or String.
Definition: ProteaseDigestion.h:60
This class serves as an abstract base class for all QC classes.
Definition: QCBase.h:55
A more convenient string class.
Definition: String.h:60
OPENMS_UINT32_TYPE UInt32
Unsigned integer type (32bit)
Definition: Types.h:63
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48