OpenMS  2.6.0
DBSuitability.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: Tom Waschischeck $
32 // $Authors: Tom Waschischeck $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 #include <OpenMS/CONCEPT/Types.h>
39 
40 #include <cfloat>
41 #include <map>
42 #include <vector>
43 
44 namespace OpenMS
45 {
46  class PeptideIdentification;
47  class PeptideHit;
48 
66  class OPENMS_DLLAPI DBSuitability:
67  public DefaultParamHandler
68  {
69  public:
72  {
74  Size num_top_novo = 0;
75 
77  Size num_top_db = 0;
78 
80  Size num_interest = 0;
81 
84  Size num_re_ranked = 0;
85 
88  double cut_off = DBL_MAX;
89 
99  double suitability = 0;
100  };
101 
105  DBSuitability();
106 
108  ~DBSuitability() = default;
109 
139  void compute(std::vector<PeptideIdentification> pep_ids);
140 
150  const std::vector<SuitabilityData>& getResults() const;
151 
152  private:
154  std::vector<SuitabilityData> results_;
155 
167  double getDecoyDiff_(const PeptideIdentification& pep_id);
168 
183  double getDecoyCutOff_(const std::vector<PeptideIdentification>& pep_ids, double reranking_cutoff_percentile);
184 
195  bool isNovoHit_(const PeptideHit& hit);
196 
206  bool passesFDR_(const PeptideHit& hit, double FDR);
207  };
208 }
209 
DefaultParamHandler.h
Types.h
OpenMS::DBSuitability::results_
std::vector< SuitabilityData > results_
result vector
Definition: DBSuitability.h:154
OpenMS::Size
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:127
OpenMS::DBSuitability
This class holds the functionality of calculating the database suitability.
Definition: DBSuitability.h:66
OpenMS::DefaultParamHandler
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:92
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::DBSuitability::SuitabilityData
struct to store results
Definition: DBSuitability.h:71
OpenMS::PeptideIdentification
Represents the peptide hits for a spectrum.
Definition: PeptideIdentification.h:62
OpenMS::PeptideHit
Representation of a peptide hit.
Definition: PeptideHit.h:55