| OpenMS 2.5.0

ClusterFunctor.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: Mathias Walzer $
32 // $Authors: $
33 // --------------------------------------------------------------------------
34 //
35 #pragma once
36
37 #include <OpenMS/DATASTRUCTURES/DistanceMatrix.h>
38 #include <OpenMS/CONCEPT/Exception.h>
39 #include <OpenMS/COMPARISON/CLUSTERING/ClusterAnalyzer.h>
40
41 #include <vector>
42
43 namespace OpenMS
44 {
45
53 class OPENMS_DLLAPI ClusterFunctor
54 {
55
56 public:
57
64 class OPENMS_DLLAPI InsufficientInput :
65 public Exception::BaseException
66 {
67 public:
68 InsufficientInput(const char * file, int line, const char * function, const char * message = "not enough data points to cluster anything") throw();
69 ~InsufficientInput() throw() override;
70 };
71
72
74 ClusterFunctor();
75
77 ClusterFunctor(const ClusterFunctor & source);
78
80 virtual ~ClusterFunctor();
81
83 ClusterFunctor & operator=(const ClusterFunctor & source);
84
97 virtual void operator()(DistanceMatrix<float> & original_distance, std::vector<BinaryTreeNode> & cluster_tree, const float threshold = 1) const = 0;
98
100 static void registerChildren();
101
102 };
103
104 }
OpenMS::Exception::BaseException
Exception base class.
Definition: Exception.h:89
OpenMS::ClusterFunctor
Base class for cluster functors.
Definition: ClusterFunctor.h:53
Exception.h
OpenMS::DistanceMatrix
A two-dimensional distance matrix, similar to OpenMS::Matrix.
Definition: DistanceMatrix.h:67
DistanceMatrix.h
OpenMS::ClusterFunctor::InsufficientInput
Exception thrown if not enough data (<2) is used.
Definition: ClusterFunctor.h:64
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
ClusterAnalyzer.h