OpenMS
DetectabilitySimulation.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: Timo Sachsenberg$
32 // $Authors: Stephan Aiche, Chris Bielow$
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
39 
40 namespace OpenMS
41 {
52  class OPENMS_DLLAPI DetectabilitySimulation :
53  public DefaultParamHandler
54  {
55 
56 public:
62 
65 
69 
72 
82 
83 
84  void predictDetectabilities(std::vector<String>& peptides_vector, std::vector<double>& labels,
85  std::vector<double>& detectabilities);
86 private:
89 
91  void updateMembers_() override;
92 
94  double min_detect_;
95 
98 
99 protected:
102 
105 
106  };
107 
108 }
109 
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:92
Simulates peptide detectability.
Definition: DetectabilitySimulation.h:54
void filterDetectability(SimTypes::FeatureMapSim &features)
Filters the given peptide features for detectability.
DetectabilitySimulation(const DetectabilitySimulation &source)
Copy constructor.
void setDefaultParams_()
Set default parameters.
void noFilter_(SimTypes::FeatureMapSim &)
Do not filter the feature map, just set the detectability to a default value.
void svmFilter_(SimTypes::FeatureMapSim &)
Filter the feature map using a svm model.
double min_detect_
Minimum allowed detectability likelihood of a peptide.
Definition: DetectabilitySimulation.h:94
void predictDetectabilities(std::vector< String > &peptides_vector, std::vector< double > &labels, std::vector< double > &detectabilities)
DetectabilitySimulation()
Constructor taking a random generator.
DetectabilitySimulation & operator=(const DetectabilitySimulation &source)
Assignment operator.
~DetectabilitySimulation() override
Destructor.
void updateMembers_() override
Synchronize members with param class.
OpenMS::String dt_model_file_
Name of the svm model file.
Definition: DetectabilitySimulation.h:97
A container for features.
Definition: FeatureMap.h:106
A more convenient string class.
Definition: String.h:60
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48