Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
IsobaricQuantitationMethod.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-2013.
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: Stephan Aiche $
32 // $Authors: Stephan Aiche $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_ANALYSIS_QUANTITATION_ISOBARICQUANTITATIONMETHOD_H
36 #define OPENMS_ANALYSIS_QUANTITATION_ISOBARICQUANTITATIONMETHOD_H
37 
41 
42 #include <OpenMS/KERNEL/Peak2D.h>
43 
44 #include <vector>
45 
46 namespace OpenMS
47 {
51  class OPENMS_DLLAPI IsobaricQuantitationMethod :
52  public DefaultParamHandler
53  {
54 public:
55 
60  {
69 
71  IsobaricChannelInformation(const Int name, const Int id, const String& description, const Peak2D::CoordinateType& center) :
72  name(name),
73  id(id),
74  description(description),
75  center(center)
76  {
77  }
78 
79  };
80 
83 
85  virtual ~IsobaricQuantitationMethod();
86 
87  typedef std::vector<IsobaricChannelInformation> IsobaricChannelList;
88 
94  virtual const String& getName() const = 0;
95 
101  virtual const IsobaricChannelList& getChannelInformation() const = 0;
102 
108  virtual Size getNumberOfChannels() const = 0;
109 
113  virtual Matrix<double> getIsotopeCorrectionMatrix() const = 0;
114 
118  virtual Size getReferenceChannel() const = 0;
119 
120 protected:
127  Matrix<double> stringListToIsotopCorrectionMatrix_(const StringList& stringlist) const;
128  };
129 } // namespace
130 
131 #endif // OPENMS_ANALYSIS_QUANTITATION_ISOBARICQUANTITATIONMETHOD_H
A more convenient string class.
Definition: String.h:56
Summary of an isobaric quantitation channel.
Definition: IsobaricQuantitationMethod.h:59
IsobaricChannelInformation(const Int name, const Int id, const String &description, const Peak2D::CoordinateType &center)
C&#39;tor.
Definition: IsobaricQuantitationMethod.h:71
Int id
The id of the channel.
Definition: IsobaricQuantitationMethod.h:64
Int name
The name of the channel.
Definition: IsobaricQuantitationMethod.h:62
String description
Optional description of the channel.
Definition: IsobaricQuantitationMethod.h:66
Peak2D::CoordinateType center
The expected centroid position of the channel peak in m/z.
Definition: IsobaricQuantitationMethod.h:68
String list.
Definition: StringList.h:56
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:144
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:90
Abstract base class describing an isobaric quantitation method in terms of the used channels and an i...
Definition: IsobaricQuantitationMethod.h:51
std::vector< IsobaricChannelInformation > IsobaricChannelList
Definition: IsobaricQuantitationMethod.h:87
int Int
Signed integer type.
Definition: Types.h:100

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:15 using doxygen 1.8.5