OpenMS: BaseGroupFinder.h Source File

| OpenMS 2.5.0

BaseGroupFinder.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: Timo Sachsenberg $
32 // $Authors: Clemens Groepl, Marc Sturm $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/KERNEL/ConsensusMap.h>
38 #include <OpenMS/CONCEPT/ProgressLogger.h>
39 #include <OpenMS/DATASTRUCTURES/DefaultParamHandler.h>
40
41 #include <utility>
42 #include <fstream>
43
44 namespace OpenMS
45 {
46
61 class OPENMS_DLLAPI BaseGroupFinder :
62 public DefaultParamHandler,
63 public ProgressLogger
64 {
65 public:
67 BaseGroupFinder();
68
70 ~BaseGroupFinder() override;
71
77 virtual void run(const std::vector<ConsensusMap> & input, ConsensusMap & result) = 0;
78
80 static void registerChildren();
81
82 protected:
83
89 void checkIds_(const std::vector<ConsensusMap> & maps) const;
90
91 private:
92
94 BaseGroupFinder(const BaseGroupFinder &);
95
97 BaseGroupFinder & operator=(const BaseGroupFinder &);
98
99 };
100
101 } // namespace OpenMS
102
DefaultParamHandler.h
ConsensusMap.h
ProgressLogger.h
OpenMS::BaseGroupFinder
The base class of all element group finding algorithms.
Definition: BaseGroupFinder.h:61
OpenMS::ProgressLogger
Base class for all classes that want to report their progress.
Definition: ProgressLogger.h:54
OpenMS::ConsensusMap
A container for consensus elements.
Definition: ConsensusMap.h:79
OpenMS::DefaultParamHandler
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:91
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46