| OpenMS 2.5.0

MSDataTransformingConsumer.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: Hannes Roest $
32 // $Authors: Hannes Roest, Chris Bielow $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/INTERFACES/IMSDataConsumer.h>
38
39 #include <OpenMS/KERNEL/StandardTypes.h>
40 #include <OpenMS/KERNEL/MSSpectrum.h>
41 #include <OpenMS/KERNEL/MSChromatogram.h>
42 #include <OpenMS/KERNEL/Peak1D.h>
43 #include <OpenMS/KERNEL/ChromatogramPeak.h>
44
45 namespace OpenMS
46 {
47
58 class OPENMS_DLLAPI MSDataTransformingConsumer :
59 public Interfaces::IMSDataConsumer
60 {
61
62 public:
63
67 MSDataTransformingConsumer();
68
70 ~MSDataTransformingConsumer() override;
71
73 void setExpectedSize(Size /* expectedSpectra */, Size /* expectedChromatograms */) override;
74
75 void consumeSpectrum(SpectrumType& s) override;
76
84 virtual void setSpectraProcessingFunc( std::function<void (SpectrumType&)> f_spec );
85
86 void consumeChromatogram(ChromatogramType& c) override;
87
95 virtual void setChromatogramProcessingFunc( std::function<void (ChromatogramType&)> f_chrom );
96
104 virtual void setExperimentalSettingsFunc( std::function<void (const OpenMS::ExperimentalSettings&)> f_exp_settings );
105
107 void setExperimentalSettings(const OpenMS::ExperimentalSettings&) override;
108
109 protected:
110 std::function<void (SpectrumType&)> lambda_spec_;
111 std::function<void (ChromatogramType&)> lambda_chrom_;
112 std::function<void (const OpenMS::ExperimentalSettings&)> lambda_exp_settings_;
113 };
114
115 } //end namespace OpenMS
116
OpenMS::ExperimentalSettings
Description of the experimental settings.
Definition: ExperimentalSettings.h:59
OpenMS::MSDataTransformingConsumer::lambda_chrom_
std::function< void(ChromatogramType &)> lambda_chrom_
Definition: MSDataTransformingConsumer.h:111
OpenMS::MSDataTransformingConsumer::lambda_exp_settings_
std::function< void(const OpenMS::ExperimentalSettings &)> lambda_exp_settings_
Definition: MSDataTransformingConsumer.h:112
OpenMS::MSChromatogram
The representation of a chromatogram.
Definition: MSChromatogram.h:54
StandardTypes.h
Peak1D.h
OpenMS::MSDataTransformingConsumer::lambda_spec_
std::function< void(SpectrumType &)> lambda_spec_
Definition: MSDataTransformingConsumer.h:110
OpenMS::MSSpectrum
The representation of a 1D spectrum.
Definition: MSSpectrum.h:67
IMSDataConsumer.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::MSDataTransformingConsumer
Transforming consumer of MS data.
Definition: MSDataTransformingConsumer.h:58
OpenMS::Interfaces::IMSDataConsumer
The interface of a consumer of spectra and chromatograms.
Definition: IMSDataConsumer.h:69
MSSpectrum.h
OpenMS::Constants::c
const double c
MSChromatogram.h
ChromatogramPeak.h
OpenMS::Size
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:127