OpenMS  2.7.0
FIAMSDataProcessor.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-2018.
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: Svetlana Kutuzova, Douglas McCloskey $
32 // $Authors: Svetlana Kutuzova, Douglas McCloskey $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
38 #include <OpenMS/FORMAT/MzTab.h>
40 #include <OpenMS/FORMAT/MzMLFile.h>
41 
42 namespace OpenMS
43 {
59  class OPENMS_DLLAPI FIAMSDataProcessor :
60  public DefaultParamHandler
61  {
62 public:
65 
67  ~FIAMSDataProcessor() = default;
68 
70  FIAMSDataProcessor(const FIAMSDataProcessor& cp) = default;
71 
74 
95  bool run(const MSExperiment& experiment, const float n_seconds, OpenMS::MzTab& output, const bool load_cached_spectrum = true);
96 
104  void cutForTime(const MSExperiment& experiment, const float n_seconds, std::vector<MSSpectrum>& output);
105 
116  MSSpectrum mergeAlongTime(const std::vector<OpenMS::MSSpectrum>& input);
117 
125 
135 
145 
155 
159  const std::vector<float>& getMZs();
160 
164  const std::vector<float>& getBinSizes();
165 
166 protected:
167  void updateMembers_() override;
168 
169 private:
173  void storeSpectrum_(const MSSpectrum& input, String filename);
174 
175  std::vector<float> mzs_;
176  std::vector<float> bin_sizes_;
179  };
180 } // namespace OpenMS
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:93
Data processing for FIA-MS data.
Definition: FIAMSDataProcessor.h:61
std::vector< float > bin_sizes_
Definition: FIAMSDataProcessor.h:176
~FIAMSDataProcessor()=default
Default destructor.
MSSpectrum mergeAlongTime(const std::vector< OpenMS::MSSpectrum > &input)
Sum the spectra with different retention times into one.
SavitzkyGolayFilter sgfilter_
Definition: FIAMSDataProcessor.h:177
void cutForTime(const MSExperiment &experiment, const float n_seconds, std::vector< MSSpectrum > &output)
Cut the time axis of the experiment from 0 to @n_seconds.
void storeSpectrum_(const MSSpectrum &input, String filename)
Store the spectrum to the given filepath.
MSSpectrum extractPeaks(const MSSpectrum &input)
Pick peaks from the summed spectrum.
PeakPickerHiRes picker_
Definition: FIAMSDataProcessor.h:178
MSSpectrum trackNoise(const MSSpectrum &input)
Estimate noise for each peak.
const std::vector< float > & getMZs()
Get mass-to-charge ratios to base the summing the spectra along the time axis upon.
bool run(const MSExperiment &experiment, const float n_seconds, OpenMS::MzTab &output, const bool load_cached_spectrum=true)
Run the full analysis for the experiment for the given time interval.
FIAMSDataProcessor & operator=(const FIAMSDataProcessor &fdp)=default
Assignment.
void updateMembers_() override
This method is used to update extra member variables at the end of the setParameters() method.
FIAMSDataProcessor()
Constructor.
void runAccurateMassSearch(FeatureMap &input, OpenMS::MzTab &output)
Perform accurate mass search.
std::vector< float > mzs_
Definition: FIAMSDataProcessor.h:175
FIAMSDataProcessor(const FIAMSDataProcessor &cp)=default
Copy constructor.
const std::vector< float > & getBinSizes()
Get the sliding bin sizes for summing the spectra along the time axis.
FeatureMap convertToFeatureMap(const MSSpectrum &input)
Convert a spectrum to a feature map with the corresponding polarity.
A container for features.
Definition: FeatureMap.h:105
In-Memory representation of a mass spectrometry experiment.
Definition: MSExperiment.h:80
The representation of a 1D spectrum.
Definition: MSSpectrum.h:71
Data model of MzTab files. Please see the official MzTab specification at https://code....
Definition: MzTab.h:809
This class implements a fast peak-picking algorithm best suited for high resolution MS data (FT-ICR-M...
Definition: PeakPickerHiRes.h:76
Computes the Savitzky-Golay filter coefficients using QR decomposition.
Definition: SavitzkyGolayFilter.h:104
A more convenient string class.
Definition: String.h:61
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47