OpenMS
FeatureGroupingAlgorithmQT.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-2023.
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: Hendrik Weisser $
32 // $Authors: Steffen Sass, Hendrik Weisser $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 
39 namespace OpenMS
40 {
52  class OPENMS_DLLAPI FeatureGroupingAlgorithmQT :
54  {
55 public:
58 
61 
69  void group(const std::vector<FeatureMap>& maps, ConsensusMap& out) override;
70 
78  void group(const std::vector<ConsensusMap>& maps,
79  ConsensusMap& out) override;
80 
83  {
84  return new FeatureGroupingAlgorithmQT();
85  }
86 
89  {
90  return "unlabeled_qt";
91  }
92 
93 private:
94 
97 
100 
108  template <typename MapType>
109  void group_(const std::vector<MapType>& maps, ConsensusMap& out);
110  };
111 
112 } // namespace OpenMS
113 
A container for consensus elements.
Definition: ConsensusMap.h:92
A feature grouping algorithm for unlabeled data.
Definition: FeatureGroupingAlgorithmQT.h:54
void group_(const std::vector< MapType > &maps, ConsensusMap &out)
Applies the algorithm to feature or consensus maps.
~FeatureGroupingAlgorithmQT() override
Destructor.
FeatureGroupingAlgorithmQT & operator=(const FeatureGroupingAlgorithmQT &)
Assignment operator intentionally not implemented -> private.
static String getProductName()
Returns the product name (for the Factory)
Definition: FeatureGroupingAlgorithmQT.h:88
FeatureGroupingAlgorithmQT()
Default constructor.
FeatureGroupingAlgorithmQT(const FeatureGroupingAlgorithmQT &)
Copy constructor intentionally not implemented -> private.
void group(const std::vector< ConsensusMap > &maps, ConsensusMap &out) override
Applies the algorithm to consensus maps.
static FeatureGroupingAlgorithm * create()
Creates a new instance of this class (for Factory)
Definition: FeatureGroupingAlgorithmQT.h:82
void group(const std::vector< FeatureMap > &maps, ConsensusMap &out) override
Applies the algorithm to feature maps.
Base class for all feature grouping algorithms.
Definition: FeatureGroupingAlgorithm.h:51
A more convenient string class.
Definition: String.h:60
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48