OpenMS  2.8.0
MassDecompositionAlgorithm.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-2021.
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: Timo Sachsenberg $
32 // $Authors: Andreas Bertsch $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
39 
40 // ims includes
41 #ifdef OPENMS_COMPILER_MSVC
42 #pragma warning( push )
43 #pragma warning( disable : 4290 4267)
44 #endif
45 
49 #ifdef OPENMS_COMPILER_MSVC
50 #pragma warning( pop )
51 #endif
52 
53 #include <vector>
54 
55 namespace OpenMS
56 {
68  class OPENMS_DLLAPI MassDecompositionAlgorithm :
69  public DefaultParamHandler
70  {
71 public:
72 
79 
83 
89  void getDecompositions(std::vector<MassDecomposition> & decomps, double weight);
91 
92 protected:
93 
94  void updateMembers_() override;
95 
97 
99 
100 private:
101 
102  // will not be implemented
105 
108  };
109 
110 } // namespace OpenMS
111 
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:93
Mass decomposition algorithm, given a mass it suggests possible compositions.
Definition: MassDecompositionAlgorithm.h:70
void getDecompositions(std::vector< MassDecomposition > &decomps, double weight)
returns the possible decompositions given the weight
MassDecompositionAlgorithm(const MassDecompositionAlgorithm &deco)
Copy constructor.
~MassDecompositionAlgorithm() override
Destructor.
ims::IMSAlphabet * alphabet_
Definition: MassDecompositionAlgorithm.h:96
MassDecompositionAlgorithm()
Default constructor.
void updateMembers_() override
This method is used to update extra member variables at the end of the setParameters() method.
MassDecompositionAlgorithm & operator=(const MassDecompositionAlgorithm &rhs)
assignment operator
ims::RealMassDecomposer * decomposer_
Definition: MassDecompositionAlgorithm.h:98
Holds an indexed list of bio-chemical elements.
Definition: IMSAlphabet.h:82
Handles decomposing of non-integer values/masses over a set of non-integer weights with an error allo...
Definition: RealMassDecomposer.h:68
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47