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-2013.
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: Stephan Aiche$
32 // $Authors: Marc Sturm, Chris Bielow $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_DATASTRUCTURES_CONVEXHULL2D_H
36 #define OPENMS_DATASTRUCTURES_CONVEXHULL2D_H
37 
38 #include <OpenMS/config.h>
39 #include <OpenMS/CONCEPT/Types.h>
43 
44 #include <vector>
45 
46 
47 
48 namespace OpenMS
49 {
75  class OPENMS_DLLAPI ConvexHull2D
76  {
77 public:
79  typedef std::vector<PointType> PointArrayType;
80  typedef PointArrayType::size_type SizeType;
81  typedef PointArrayType::const_iterator PointArrayTypeConstIterator;
82 
84 
86  ConvexHull2D();
87 
89  ConvexHull2D & operator=(const ConvexHull2D & rhs);
90 
92  bool operator==(const ConvexHull2D & rhs) const;
93 
95  void clear();
96 
98  const PointArrayType & getHullPoints() const;
99 
101  void setHullPoints(const PointArrayType & points);
102 
104  DBoundingBox<2> getBoundingBox() const;
105 
108  bool addPoint(const PointType & point);
109 
112  void addPoints(const PointArrayType & points);
113 
126  Size compress();
127 
136  void expandToBoundingBox();
137 
138 
148  bool encloses(const PointType & point) const;
149 
150 protected:
153 
156 
157  };
158 } // namespace OPENMS
159 
160 #endif // OPENMS_DATASTRUCTURES_DCONVEXHULL_H
DPosition< 2 > PointType
Definition: ConvexHull2D.h:78
PointArrayType outer_points_
just the list of points of the outer hull (derived from map_points_ or given by user) ...
Definition: ConvexHull2D.h:155
std::vector< PointType > PointArrayType
Definition: ConvexHull2D.h:79
PointArrayType::const_iterator PointArrayTypeConstIterator
Definition: ConvexHull2D.h:81
A 2-dimensional hull representation in [counter]clockwise direction - depending on axis labelling...
Definition: ConvexHull2D.h:75
PointArrayType::size_type SizeType
Definition: ConvexHull2D.h:80
HullPointType map_points_
internal structure maintaining the hull and enabling queries to encloses()
Definition: ConvexHull2D.h:152
Map< PointType::CoordinateType, DBoundingBox< 1 > > HullPointType
Definition: ConvexHull2D.h:83
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:144
A D-dimensional bounding box.
Definition: DBoundingBox.h:51
Map class based on the STL map (containing serveral convenience functions)
Definition: Map.h:50

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:12 using doxygen 1.8.5