OpenMS  2.7.0
MultiplexFilteredMSExperiment.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-2021.
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: Lars Nilse $
32 // $Authors: Lars Nilse $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
39 
40 #include <vector>
41 #include <algorithm>
42 #include <iostream>
43 
44 namespace OpenMS
45 {
52  class OPENMS_DLLAPI MultiplexFilteredMSExperiment
53  {
54  public:
59 
63  void addPeak(const MultiplexFilteredPeak& peak);
64 
68  MultiplexFilteredPeak getPeak(size_t i) const;
69 
73  double getMZ(size_t i) const;
74 
78  std::vector<double> getMZ() const;
79 
83  double getRT(size_t i) const;
84 
88  std::vector<double> getRT() const;
89 
93  size_t size() const;
94 
101  void writeDebugOutput(const MSExperiment& exp_picked, String debug_out) const;
102 
103  private:
107  std::vector<MultiplexFilteredPeak> result_;
108 
109  };
110 
111 }
112 
In-Memory representation of a mass spectrometry experiment.
Definition: MSExperiment.h:80
data structure storing all peaks (and optionally their raw data points) of an experiment correspondin...
Definition: MultiplexFilteredMSExperiment.h:53
void addPeak(const MultiplexFilteredPeak &peak)
adds a single peak to the results
double getRT(size_t i) const
returns RT of a single peak
std::vector< MultiplexFilteredPeak > result_
peaks which passed the peak pattern filter
Definition: MultiplexFilteredMSExperiment.h:107
size_t size() const
returns number of peaks in the result
MultiplexFilteredPeak getPeak(size_t i) const
returns a single peak from the results
double getMZ(size_t i) const
returns m/z of a single peak
std::vector< double > getRT() const
returns RT of all peaks
std::vector< double > getMZ() const
returns m/z positions of all peaks
void writeDebugOutput(const MSExperiment &exp_picked, String debug_out) const
write all peaks to a consensusXML file
data structure storing a single peak that passed all filters
Definition: MultiplexFilteredPeak.h:71
A more convenient string class.
Definition: String.h:61
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47