Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
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-2017.
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 #ifndef OPENMS_DATASTRUCTURES_CONVEXHULL2D_H
36 #define OPENMS_DATASTRUCTURES_CONVEXHULL2D_H
37 
38 #include <OpenMS/CONCEPT/Types.h>
41 #include <OpenMS/OpenMSConfig.h>
43 
44 #include <vector>
45 
46 namespace OpenMS
47 {
73  class OPENMS_DLLAPI ConvexHull2D
74  {
75 public:
77  typedef std::vector<PointType> PointArrayType;
78  typedef PointArrayType::size_type SizeType;
79  typedef PointArrayType::const_iterator PointArrayTypeConstIterator;
80 
82 
84  ConvexHull2D();
85 
87  ConvexHull2D& operator=(const ConvexHull2D& rhs);
88 
90  bool operator==(const ConvexHull2D& rhs) const;
91 
93  void clear();
94 
96  const PointArrayType& getHullPoints() const;
97 
99  void setHullPoints(const PointArrayType& points);
100 
102  DBoundingBox<2> getBoundingBox() const;
103 
106  bool addPoint(const PointType& point);
107 
110  void addPoints(const PointArrayType& points);
111 
124  Size compress();
125 
134  void expandToBoundingBox();
135 
136 
146  bool encloses(const PointType& point) const;
147 
148 protected:
150  HullPointType map_points_;
151 
153  mutable PointArrayType outer_points_;
154 
155  };
156 } // namespace OPENMS
157 
158 #endif // OPENMS_DATASTRUCTURES_DCONVEXHULL_H
DPosition< 2 > PointType
Definition: ConvexHull2D.h:76
PointArrayType outer_points_
just the list of points of the outer hull (derived from map_points_ or given by user) ...
Definition: ConvexHull2D.h:153
std::vector< PointType > PointArrayType
Definition: ConvexHull2D.h:77
PointArrayType::const_iterator PointArrayTypeConstIterator
Definition: ConvexHull2D.h:79
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
A 2-dimensional hull representation in [counter]clockwise direction - depending on axis labelling...
Definition: ConvexHull2D.h:73
PointArrayType::size_type SizeType
Definition: ConvexHull2D.h:78
HullPointType map_points_
internal structure maintaining the hull and enabling queries to encloses()
Definition: ConvexHull2D.h:150
Map< PointType::CoordinateType, DBoundingBox< 1 > > HullPointType
Definition: ConvexHull2D.h:81
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:128
Map class based on the STL map (containing several convenience functions)
Definition: Map.h:51

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:21:59 using doxygen 1.8.13