Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
ChromatogramExtractorAlgorithm.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: Hannes Roest $
32 // $Authors: Hannes Roest $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_ANALYSIS_OPENSWATH_CHROMATOGRAMEXTRACTORALGORITHM_H
36 #define OPENMS_ANALYSIS_OPENSWATH_CHROMATOGRAMEXTRACTORALGORITHM_H
37 
40 
41 namespace OpenMS
42 {
43 
59  class OPENMS_DLLAPI ChromatogramExtractorAlgorithm :
60  public ProgressLogger
61  {
62 
63 public:
64 
66  {
67  double mz;
68  double mz_precursor;
69  double rt_start;
70  double rt_end;
71  std::string id;
72 
76  {
77  return left.mz < right.mz;
78  }
82  {
83  return left.mz > right.mz;
84  }
85  };
86 
102  void extractChromatograms(const OpenSwath::SpectrumAccessPtr input,
103  std::vector< OpenSwath::ChromatogramPtr >& output,
104  std::vector<ExtractionCoordinates> extraction_coordinates, double mz_extraction_window,
105  bool ppm, String filter);
106 
123  void extract_value_tophat(const std::vector<double>::const_iterator& mz_start, std::vector<double>::const_iterator& mz_it,
124  const std::vector<double>::const_iterator& mz_end, std::vector<double>::const_iterator& int_it,
125  const double& mz, double& integrated_intensity, const double& mz_extraction_window, bool ppm);
126 
127 private:
128 
129  int getFilterNr_(String filter);
130 
131  };
132 
133 }
134 
135 #endif // OPENMS_ANALYSIS_OPENSWATH_CHROMATOGRAMEXTRACTORALGORITHM_H
136 
A more convenient string class.
Definition: String.h:57
The ChromatogramExtractorAlgorithm extracts chromatograms from a MS data.
Definition: ChromatogramExtractorAlgorithm.h:59
double mz_precursor
precursor m/z value (is currently ignored by the algorithm)
Definition: ChromatogramExtractorAlgorithm.h:68
boost::shared_ptr< ISpectrumAccess > SpectrumAccessPtr
Definition: openswathalgo/include/OpenMS/ANALYSIS/OPENSWATH/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:90
static bool SortExtractionCoordinatesReverseByMZ(const ChromatogramExtractorAlgorithm::ExtractionCoordinates &left, const ChromatogramExtractorAlgorithm::ExtractionCoordinates &right)
Definition: ChromatogramExtractorAlgorithm.h:79
double rt_end
rt end of extraction (in seconds)
Definition: ChromatogramExtractorAlgorithm.h:70
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
Definition: ChromatogramExtractorAlgorithm.h:65
double mz
m/z value around which should be extracted
Definition: ChromatogramExtractorAlgorithm.h:67
static bool SortExtractionCoordinatesByMZ(const ChromatogramExtractorAlgorithm::ExtractionCoordinates &left, const ChromatogramExtractorAlgorithm::ExtractionCoordinates &right)
Definition: ChromatogramExtractorAlgorithm.h:73
Base class for all classes that want to report their progress.
Definition: ProgressLogger.h:55
double rt_start
rt start of extraction (in seconds)
Definition: ChromatogramExtractorAlgorithm.h:69
std::string id
identifier
Definition: ChromatogramExtractorAlgorithm.h:71

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