| OpenMS 2.5.0

SpectrumAccessTransforming.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 $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/config.h>
38 #include <OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h>
39
40 namespace OpenMS
41 {
42
47 class OPENMS_DLLAPI SpectrumAccessTransforming :
48 public OpenSwath::ISpectrumAccess
49 {
50 public:
51
52 explicit SpectrumAccessTransforming(OpenSwath::SpectrumAccessPtr sptr);
53
54 ~SpectrumAccessTransforming() override = 0;
55
56 boost::shared_ptr<ISpectrumAccess> lightClone() const override = 0;
57
58 OpenSwath::SpectrumPtr getSpectrumById(int id) override;
59
60 OpenSwath::SpectrumMeta getSpectrumMetaById(int id) const override;
61
62 std::vector<std::size_t> getSpectraByRT(double RT, double deltaRT) const override;
63
64 size_t getNrSpectra() const override;
65
66 OpenSwath::ChromatogramPtr getChromatogramById(int id) override;
67
68 size_t getNrChromatograms() const override;
69
70 std::string getChromatogramNativeID(int id) const override;
71
72 protected:
73 OpenSwath::SpectrumAccessPtr sptr_;
74
75 };
76
77 }
78
79
OpenSwath::OSSpectrumMeta
Identifying information for a spectrum.
Definition: openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/DataStructures.h:175
OpenMS::SpectrumAccessTransforming
An abstract base class implementing a transforming wrapper around spectrum access.
Definition: SpectrumAccessTransforming.h:47
OpenSwath::SpectrumAccessPtr
boost::shared_ptr< ISpectrumAccess > SpectrumAccessPtr
Definition: openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:89
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenSwath::ISpectrumAccess
The interface of a mass spectrometry experiment.
Definition: openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:50
OpenSwath::SpectrumPtr
boost::shared_ptr< Spectrum > SpectrumPtr
Definition: openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/DataStructures.h:292
OpenMS::SpectrumAccessTransforming::sptr_
OpenSwath::SpectrumAccessPtr sptr_
Definition: SpectrumAccessTransforming.h:73
ISpectrumAccess.h
OpenSwath::ChromatogramPtr
boost::shared_ptr< Chromatogram > ChromatogramPtr
Definition: openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/DataStructures.h:172