OpenMS  3.0.0
ITransition.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-2022.
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 <vector>
38 #include <string>
39 #include <boost/shared_ptr.hpp>
40 
41 #include <OpenMS/OPENSWATHALGO/OpenSwathAlgoConfig.h>
42 
43 namespace OpenSwath
44 {
45  // Datastructures for Scoring
46  class OPENSWATHALGO_DLLAPI IFeature
47  {
48 public:
49  virtual ~IFeature(){}
50  virtual void getRT(std::vector<double>& rt) const = 0;
51  virtual void getIntensity(std::vector<double>& intens) const = 0;
52  virtual float getIntensity() const = 0;
53  virtual double getRT() const = 0;
54  };
55 
56  class OPENSWATHALGO_DLLAPI IMRMFeature
57  {
58 public:
59  virtual ~IMRMFeature(){}
60  virtual boost::shared_ptr<OpenSwath::IFeature> getFeature(std::string nativeID) = 0;
61  virtual boost::shared_ptr<OpenSwath::IFeature> getPrecursorFeature(std::string nativeID) = 0;
62  virtual std::vector<std::string> getNativeIDs() const = 0;
63  virtual std::vector<std::string> getPrecursorIDs() const = 0;
64  virtual float getIntensity() const = 0;
65  virtual double getRT() const = 0;
66  virtual size_t size() const = 0;
67  };
68 
69  struct OPENSWATHALGO_DLLAPI ITransitionGroup
70  {
71  virtual ~ITransitionGroup() {}
72  virtual std::size_t size() const = 0;
73  virtual std::vector<std::string> getNativeIDs() const = 0;
74  virtual void getLibraryIntensities(std::vector<double>& intensities) const = 0;
75  };
76 
77  struct OPENSWATHALGO_DLLAPI ISignalToNoise
78  {
79  virtual ~ISignalToNoise() {}
80  virtual double getValueAtRT(double RT) = 0; // cannot be const due to OpenMS implementation
81  };
82  typedef boost::shared_ptr<ISignalToNoise> ISignalToNoisePtr;
83 
84 
85 } //end Namespace OpenSwath
86 
OpenSwath::IFeature::~IFeature
virtual ~IFeature()
Definition: ITransition.h:49
OpenSwath
Definition: Scoring.h:43
OpenSwath::ISignalToNoise::~ISignalToNoise
virtual ~ISignalToNoise()
Definition: ITransition.h:79
OpenSwath::ITransitionGroup::~ITransitionGroup
virtual ~ITransitionGroup()
Definition: ITransition.h:71
OpenSwath::ISignalToNoisePtr
boost::shared_ptr< ISignalToNoise > ISignalToNoisePtr
Definition: ITransition.h:82
OpenSwath::IFeature
Definition: ITransition.h:46
OpenSwath::ITransitionGroup
Definition: ITransition.h:69
OpenSwath::ISignalToNoise
Definition: ITransition.h:77
OpenSwath::IMRMFeature::~IMRMFeature
virtual ~IMRMFeature()
Definition: ITransition.h:59
OpenSwath::IMRMFeature
Definition: ITransition.h:56