| OpenMS 2.5.0

ConvexHull2D.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: Marc Sturm, Chris Bielow $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/CONCEPT/Types.h>
38 #include <OpenMS/DATASTRUCTURES/DBoundingBox.h>
39 #include <OpenMS/DATASTRUCTURES/DPosition.h>
40 #include <OpenMS/OpenMSConfig.h>
41 #include <OpenMS/DATASTRUCTURES/Map.h>
42
43 #include <vector>
44
45 namespace OpenMS
46 {
72 class OPENMS_DLLAPI ConvexHull2D
73 {
74 public:
75 typedef DPosition<2> PointType;
76 typedef std::vector<PointType> PointArrayType;
77 typedef PointArrayType::size_type SizeType;
78 typedef PointArrayType::const_iterator PointArrayTypeConstIterator;
79
80 typedef Map<PointType::CoordinateType, DBoundingBox<1> > HullPointType;
81
83 ConvexHull2D();
84
86 ConvexHull2D(const ConvexHull2D&) = default;
87
89 ConvexHull2D(ConvexHull2D&&) = default;
90
92 ConvexHull2D& operator=(const ConvexHull2D& rhs);
93
95 ConvexHull2D& operator=(ConvexHull2D&&) & = default;
96
98 bool operator==(const ConvexHull2D& rhs) const;
99
101 void clear();
102
104 const PointArrayType& getHullPoints() const;
105
107 void setHullPoints(const PointArrayType& points);
108
110 DBoundingBox<2> getBoundingBox() const;
111
114 bool addPoint(const PointType& point);
115
118 void addPoints(const PointArrayType& points);
119
132 Size compress();
133
142 void expandToBoundingBox();
143
144
154 bool encloses(const PointType& point) const;
155
156 protected:
158 HullPointType map_points_;
159
161 mutable PointArrayType outer_points_;
162
163 };
164 } // namespace OPENMS
165
OpenMS::ConvexHull2D::SizeType
PointArrayType::size_type SizeType
Definition: ConvexHull2D.h:77
OpenMS::ConvexHull2D::PointArrayTypeConstIterator
PointArrayType::const_iterator PointArrayTypeConstIterator
Definition: ConvexHull2D.h:78
OpenMS::ConvexHull2D::PointArrayType
std::vector< PointType > PointArrayType
Definition: ConvexHull2D.h:76
OpenMS::ConvexHull2D::map_points_
HullPointType map_points_
internal structure maintaining the hull and enabling queries to encloses()
Definition: ConvexHull2D.h:158
Types.h
OpenMS::ConvexHull2D::PointType
DPosition< 2 > PointType
Definition: ConvexHull2D.h:75
OpenMS::DBoundingBox< 2 >
OpenMS::Map
Map class based on the STL map (containing several convenience functions)
Definition: Map.h:50
DPosition.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
Map.h
OpenMS::ConvexHull2D::HullPointType
Map< PointType::CoordinateType, DBoundingBox< 1 > > HullPointType
Definition: ConvexHull2D.h:80
OpenMS::ConvexHull2D::outer_points_
PointArrayType outer_points_
just the list of points of the outer hull (derived from map_points_ or given by user) ...
Definition: ConvexHull2D.h:161
OpenMS::DPosition< 2 >
DBoundingBox.h
OpenMS::Size
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:127
OpenMS::ConvexHull2D
A 2-dimensional hull representation in [counter]clockwise direction - depending on axis labelling...
Definition: ConvexHull2D.h:72
KDTree::operator==
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806