| OpenMS 2.5.0

RawTandemMSSignalSimulation.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, Chris Bielow, Sandro Andreotti $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/DATASTRUCTURES/DefaultParamHandler.h>
38 #include <OpenMS/SIMULATION/SimTypes.h>
39
40 namespace OpenMS
41 {
42
53 class OPENMS_DLLAPI RawTandemMSSignalSimulation :
54 public DefaultParamHandler
55 {
56 public:
57
61
63 RawTandemMSSignalSimulation();
64
66 explicit RawTandemMSSignalSimulation(SimTypes::MutableSimRandomNumberGeneratorPtr rng);
67
69 RawTandemMSSignalSimulation(const RawTandemMSSignalSimulation& source);
70
72 ~RawTandemMSSignalSimulation() override;
74
75 RawTandemMSSignalSimulation& operator=(const RawTandemMSSignalSimulation& source);
76
77
81 void generateRawTandemSignals(const SimTypes::FeatureMapSim&, SimTypes::MSSimExperiment&, SimTypes::MSSimExperiment&);
82
83
84 protected:
85
87 void initParam_();
88
89 void generateMSESpectra_(const SimTypes::FeatureMapSim& features, const SimTypes::MSSimExperiment& experiment, SimTypes::MSSimExperiment& ms2);
90
91 void generatePrecursorSpectra_(const SimTypes::FeatureMapSim& features, const SimTypes::MSSimExperiment& experiment, SimTypes::MSSimExperiment& ms2);
92
94 SimTypes::MutableSimRandomNumberGeneratorPtr rnd_gen_;
95 };
96
97 }
98
OpenMS::DefaultParamHandler
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:91
SimTypes.h
OpenMS::MSExperiment
In-Memory representation of a mass spectrometry experiment.
Definition: MSExperiment.h:77
OpenMS::RawTandemMSSignalSimulation::rnd_gen_
SimTypes::MutableSimRandomNumberGeneratorPtr rnd_gen_
Random number generator.
Definition: RawTandemMSSignalSimulation.h:94
OpenMS::FeatureMap
A container for features.
Definition: FeatureMap.h:95
OpenMS::RawTandemMSSignalSimulation
Simulates tandem MS signals for a given set of peptides.
Definition: RawTandemMSSignalSimulation.h:53
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
DefaultParamHandler.h
OpenMS::SimTypes::MutableSimRandomNumberGeneratorPtr
boost::shared_ptr< SimRandomNumberGenerator > MutableSimRandomNumberGeneratorPtr
Definition: SimTypes.h:174