| OpenMS 2.5.0

LabelFreeLabeler.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$
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/SIMULATION/LABELING/BaseLabeler.h>
38
39 namespace OpenMS
40 {
41
45 class OPENMS_DLLAPI LabelFreeLabeler :
46 public BaseLabeler
47 {
48 public:
49
51 LabelFreeLabeler();
52
54 ~LabelFreeLabeler() override;
55
57 static BaseLabeler* create()
58 {
59 return new LabelFreeLabeler();
60 }
61
63 static const String getProductName()
64 {
65 return "labelfree";
66 }
67
68 // redeclaration of virtual methods
69 void preCheck(Param& param) const override;
70
71 void setUpHook(SimTypes::FeatureMapSimVector& /* channels */) override;
72
73 void postDigestHook(SimTypes::FeatureMapSimVector& /* features_to_simulate */) override;
74
75 void postRTHook(SimTypes::FeatureMapSimVector& /* features_to_simulate */) override;
76
77 void postDetectabilityHook(SimTypes::FeatureMapSimVector& /* features_to_simulate */) override;
78
79 void postIonizationHook(SimTypes::FeatureMapSimVector& /* features_to_simulate */) override;
80
81 void postRawMSHook(SimTypes::FeatureMapSimVector& /* features_to_simulate */) override;
82
83 void postRawTandemMSHook(SimTypes::FeatureMapSimVector& /* features_to_simulate */, SimTypes::MSSimExperiment& /* simulated map */) override;
84 };
85 } // namespace OpenMS
86
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::SimTypes::FeatureMapSimVector
std::vector< FeatureMapSim > FeatureMapSimVector
Sim FeatureMap Vector.
Definition: SimTypes.h:99
OpenMS::MSExperiment
In-Memory representation of a mass spectrometry experiment.
Definition: MSExperiment.h:77
OpenMS::LabelFreeLabeler::getProductName
static const String getProductName()
name of the model (needed by Factory)
Definition: LabelFreeLabeler.h:63
OpenMS::LabelFreeLabeler
Abstract base class for all kinds of labeling techniques.
Definition: LabelFreeLabeler.h:45
OpenMS::BaseLabeler
Abstract base class for all kinds of labeling techniques.
Definition: BaseLabeler.h:49
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::LabelFreeLabeler::create
static BaseLabeler * create()
create new GaussModel object (needed by Factory)
Definition: LabelFreeLabeler.h:57
OpenMS::Param
Management and storage of parameters / INI files.
Definition: Param.h:73
BaseLabeler.h