Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
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-2017.
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 #ifndef OPENMS_SIMULATION_LABELING_LABELFREELABELER_H
36 #define OPENMS_SIMULATION_LABELING_LABELFREELABELER_H
37 
39 
40 namespace OpenMS
41 {
42 
46  class OPENMS_DLLAPI LabelFreeLabeler :
47  public BaseLabeler
48  {
49 public:
50 
53 
55  virtual ~LabelFreeLabeler();
56 
58  static BaseLabeler* create()
59  {
60  return new LabelFreeLabeler();
61  }
62 
64  static const String getProductName()
65  {
66  return "labelfree";
67  }
68 
69  // redeclaration of virtual methods
70  void preCheck(Param& param) const;
71 
72  void setUpHook(SimTypes::FeatureMapSimVector& /* channels */);
73 
74  void postDigestHook(SimTypes::FeatureMapSimVector& /* features_to_simulate */);
75 
76  void postRTHook(SimTypes::FeatureMapSimVector& /* features_to_simulate */);
77 
78  void postDetectabilityHook(SimTypes::FeatureMapSimVector& /* features_to_simulate */);
79 
80  void postIonizationHook(SimTypes::FeatureMapSimVector& /* features_to_simulate */);
81 
82  void postRawMSHook(SimTypes::FeatureMapSimVector& /* features_to_simulate */);
83 
84  void postRawTandemMSHook(SimTypes::FeatureMapSimVector& /* features_to_simulate */, SimTypes::MSSimExperiment& /* simulated map */);
85  };
86 } // namespace OpenMS
87 
88 #endif //#ifndef OPENMS_SIMULATION_LABELING_LABELFREELABELER_H
A more convenient string class.
Definition: String.h:57
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
Management and storage of parameters / INI files.
Definition: Param.h:75
In-Memory representation of a mass spectrometry experiment.
Definition: MSExperiment.h:82
std::vector< FeatureMapSim > FeatureMapSimVector
Sim FeatureMap Vector.
Definition: SimTypes.h:100
static const String getProductName()
name of the model (needed by Factory)
Definition: LabelFreeLabeler.h:64
Abstract base class for all kinds of labeling techniques.
Definition: LabelFreeLabeler.h:46
Abstract base class for all kinds of labeling techniques.
Definition: BaseLabeler.h:50
static BaseLabeler * create()
create new GaussModel object (needed by Factory)
Definition: LabelFreeLabeler.h:58

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:22:01 using doxygen 1.8.13