OpenMS
Loading...
Searching...
No Matches
PeakMapExtractor.h
Go to the documentation of this file.
1// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
2// SPDX-License-Identifier: BSD-3-Clause
3//
4// --------------------------------------------------------------------------
5// $Maintainer: Justin Sing $
6// $Authors: Justin Sing $
7// --------------------------------------------------------------------------
8
9#pragma once
10
14
15#include <limits>
16#include <string>
17#include <vector>
18
19namespace OpenMS
20{
36 class OPENMS_DLLAPI PeakMapExtractor :
37 public ProgressLogger
38 {
39 public:
41
45 struct OPENMS_DLLAPI ExtractedPeakMap
46 {
47 std::string native_id;
48 double target_mz{0.0};
49 double target_rt{std::numeric_limits<double>::quiet_NaN()};
50 double target_ion_mobility{-1.0};
51 double rt_start{0.0};
52 double rt_end{-1.0};
53
54 std::vector<double> mz;
55 std::vector<double> rt;
56 std::vector<double> ion_mobility;
57 std::vector<double> intensity;
58 };
59
81 std::vector<ExtractedPeakMap>& output,
82 const std::vector<ExtractionCoordinates>& extraction_coordinates,
83 double mz_extraction_window,
84 bool ppm,
85 double im_extraction_window,
86 const std::string& filter = "tophat");
87
88 private:
89 int getFilterNr_(const std::string& filter) const;
90 };
91} // namespace OpenMS
Extract raw mz/RT/IM peak clouds for targeted OpenSWATH coordinates.
Definition PeakMapExtractor.h:38
void extractPeakMaps(const OpenSwath::SpectrumAccessPtr &input, std::vector< ExtractedPeakMap > &output, const std::vector< ExtractionCoordinates > &extraction_coordinates, double mz_extraction_window, bool ppm, double im_extraction_window, const std::string &filter="tophat")
Extract raw peak maps at the coordinates defined by extraction_coordinates.
std::vector< double > rt
Definition PeakMapExtractor.h:55
std::vector< double > mz
Definition PeakMapExtractor.h:54
std::string native_id
Definition PeakMapExtractor.h:47
std::vector< double > intensity
Definition PeakMapExtractor.h:57
std::vector< double > ion_mobility
Definition PeakMapExtractor.h:56
int getFilterNr_(const std::string &filter) const
One extracted targeted peak map.
Definition PeakMapExtractor.h:46
Base class for all classes that want to report their progress.
Definition ProgressLogger.h:27
Main OpenMS namespace.
Definition openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19
std::shared_ptr< ISpectrumAccess > SpectrumAccessPtr
Definition openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:131
Definition ChromatogramExtractorAlgorithm.h:39