CGAL 6.2 - 2D Snap Rounding
Loading...
Searching...
No Matches
Reference Manual

Eli Packer
Snap Rounding is a well known method for converting arbitrary-precision arrangements of segments into a fixed-precision representation. In the study of robust geometric computing, it can be classified as a finite precision approximation technique. Iterated Snap Rounding is a modification of Snap Rounding in which each vertex is at least half-the-width-of-a-pixel away from any non-incident edge. This package supports both methods.
Introduced in: CGAL 3.1
Depends on: 2D Arrangements
BibTeX: cgal:p-sr2-26a
License: GPL
Windows Demo: 2D Snap Rounding

Modules

 Concepts
 

Classes

class  CGAL::Snap_rounding_traits_2< Kernel >
 The class Snap_rounding_traits_2<Kernel> is a model of the SnapRoundingTraits_2 concept, and is the only traits class supplied with the package. More...
 
struct  CGAL::Float_snap_rounding_traits_2< Input_Kernel, Exact_Kernel >
 The class Float_snap_rounding_traits_2<Kernel> is a model of the FloatSnapRoundingTraits_2 concept, and is the only traits class supplied with the package. More...
 

Functions

template<class Traits , class InputIterator , class OutputContainer >
void CGAL::snap_rounding_2 (InputIterator begin, InputIterator end, OutputContainer &output_container, typename Traits::FT pixel_size, bool do_isr=true, bool int_output=true, unsigned int number_of_kd_trees=1)
 
template<class InputIterator , class OutputContainer , class NamedParameters = parameters::Default_named_parameters>
OutputContainer CGAL::double_snap_rounding_2 (InputIterator begin, InputIterator end, OutputContainer out, const NamedParameters &np=parameters::default_values())
 Subdivides and rounded a set of segments so that they are pairwise disjoint in their interiors.
 
template<class InputIterator , class OutputIterator , class NamedParameters = parameters::Default_named_parameters>
OutputIterator CGAL::compute_snapped_subcurves_2 (InputIterator begin, InputIterator end, OutputIterator out, const NamedParameters &np=parameters::default_values())
 Given a range of segments, compute rounded subsegments that are pairwise disjoint in their interior, as induced by the input curves.
 
template<class InputIterator , class OutputIterator , class NamedParameters = parameters::Default_named_parameters>
void CGAL::compute_snapped_polygons_2 (InputIterator begin, InputIterator end, OutputIterator out, const NamedParameters &np=parameters::default_values())
 Given a range of Polygon_2, compute rounded polygons such that their segments are either equal either disjoint in their interior, as induced by the input polygons.
 
template<class Polygon_2 , class NamedParameters = parameters::Default_named_parameters>
void CGAL::compute_snapped_polygon_2 (const Polygon_2 &P, Polygon_2 &out, const NamedParameters &np=parameters::default_values())
 Given a Polygon_2, compute rounded segments that are pairwise disjoint in their interior, as induced by the input polygon.
 

Function Documentation

◆ compute_snapped_polygon_2()

template<class Polygon_2 , class NamedParameters = parameters::Default_named_parameters>
void CGAL::compute_snapped_polygon_2 ( const Polygon_2 &  P,
Polygon_2 &  out,
const NamedParameters &  np = parameters::default_values() 
)

#include <CGAL/Float_snap_rounding_2.h>

Given a Polygon_2, compute rounded segments that are pairwise disjoint in their interior, as induced by the input polygon.

The output is guarantee to be a Polygon but may present pinched section.

Template Parameters
Polygon_2model of CGAL::Polygon_2
NamedParametersa sequence of Named Parameters
Parameters
Pthe input polygon
outthe output polygon
npan optional sequence of Named Parameters among the ones listed below
Optional Named Parameters
  • That template parameter enables to choose whether the algorithm is to be run in parallel, if CGAL::Parallel_tag is specified and CGAL has been linked with the Intel TBB library, or sequentially, otherwise.
  • Type: CGAL::Concurrency_tag
  • Default: CGAL::Sequential_tag

  • a multiplier of the error value for boundary edges to preserve the boundaries
  • Type: double
  • Default: 100
Warning
The convex property is not necessarly preserved

◆ compute_snapped_polygons_2()

template<class InputIterator , class OutputIterator , class NamedParameters = parameters::Default_named_parameters>
void CGAL::compute_snapped_polygons_2 ( InputIterator  begin,
InputIterator  end,
OutputIterator  out,
const NamedParameters &  np = parameters::default_values() 
)

#include <CGAL/Float_snap_rounding_2.h>

Given a range of Polygon_2, compute rounded polygons such that their segments are either equal either disjoint in their interior, as induced by the input polygons.

The polygons are intended to be non-intersecting, unless the named parameter compute_intersections is set to true. Any polygon is guaranteed to remain a Polygon in the output but may present pinched section or/and common vertices or segments with other polygons.

Template Parameters
InputIteratoriterator of a CGAL::Polygon_2 range
OutputContainerinserter of a CGAL::Polygon_2 range
NamedParametersa sequence of Named Parameters
Parameters
begin,endthe input polygon range
outthe output inserter
npan optional sequence of Named Parameters among the ones listed below
Optional Named Parameters
  • That template parameter enables to choose whether the algorithm is to be run in parallel, if CGAL::Parallel_tag is specified and CGAL has been linked with the Intel TBB library, or sequentially, otherwise.
  • Type: CGAL::Concurrency_tag
  • Default: CGAL::Sequential_tag

  • Enable intersection computation between the polygons before performing snapping.
  • Type: boolean
  • Default: false

Warning
If an input polygon is convex, it might no longer be convex in the output of this function

◆ compute_snapped_subcurves_2()

template<class InputIterator , class OutputIterator , class NamedParameters = parameters::Default_named_parameters>
OutputIterator CGAL::compute_snapped_subcurves_2 ( InputIterator  begin,
InputIterator  end,
OutputIterator  out,
const NamedParameters &  np = parameters::default_values() 
)

#include <CGAL/Float_snap_rounding_2.h>

Given a range of segments, compute rounded subsegments that are pairwise disjoint in their interior, as induced by the input curves.

Template Parameters
Concurrency_tagThat template parameter enables to choose whether the algorithm is to be run in parallel, if CGAL::Parallel_tag is specified and CGAL has been linked with the Intel TBB library, or sequentially, if CGAL::Sequential_tag - the default value - is specified.
InputIteratoriterator of a segment range
OutputContainerinserter of a segment range
NamedParametersa sequence of Named Parameters
Parameters
begin,endthe input segment range
outthe output inserter
npan optional sequence of Named Parameters among the ones listed below
Optional Named Parameters
  • That template parameter enables to choose whether the algorithm is to be run in parallel, if CGAL::Parallel_tag is specified and CGAL has been linked with the Intel TBB library, or sequentially, otherwise.
  • Type: CGAL::Concurrency_tag
  • Default: CGAL::Sequential_tag

◆ double_snap_rounding_2()

template<class InputIterator , class OutputContainer , class NamedParameters = parameters::Default_named_parameters>
OutputContainer CGAL::double_snap_rounding_2 ( InputIterator  begin,
InputIterator  end,
OutputContainer  out,
const NamedParameters &  np = parameters::default_values() 
)

#include <CGAL/Float_snap_rounding_2.h>

Subdivides and rounded a set of segments so that they are pairwise disjoint in their interiors.

The output is a range of polyline with each polyline corresponding to an input segment.

TODO Currently compute_subcurves have no visitor to obtain a polyline per input segment, thus currently the output contain one polyline per ubsegment of the arrangement

Template Parameters
InputIteratoriterator over a range of Segment_2
OutputContainerinserter over a range of Polyline. Polyline must be a type that provides a push_back(Point_2) function.
NamedParametersa sequence of Named Parameters
Parameters
begin,endthe input segment range
outthe output inserter
npan optional sequence of Named Parameters among the ones listed below
Optional Named Parameters
  • That template parameter enables to choose whether the algorithm is to be run in parallel, if CGAL::Parallel_tag is specified and CGAL has been linked with the Intel TBB library, or sequentially, otherwise.
  • Type: CGAL::Concurrency_tag
  • Default: CGAL::Sequential_tag

◆ snap_rounding_2()

template<class Traits , class InputIterator , class OutputContainer >
void CGAL::snap_rounding_2 ( InputIterator  begin,
InputIterator  end,
OutputContainer &  output_container,
typename Traits::FT  pixel_size,
bool  do_isr = true,
bool  int_output = true,
unsigned int  number_of_kd_trees = 1 
)

#include <CGAL/Snap_rounding_2.h>

Template Parameters
Traitsmust be a model of SnapRoundingTraits_2.
InputIteratormust be an iterator with value type Traits::Segment_2.
OutputContainermust be a container with a method push_back(const OutputContainer::value_type& c), where OutputContainer::value_type must be a container with a method push_back(const Traits::Point_2& p)
Parameters
begin,endThe first two parameters denote the iterator range of the input segments.
output_containeris a reference to a container of the output polylines. Since a polyline is composed of a sequence of points, a polyline is a container itself.
do_isrThe fifth parameter determines whether to apply ISR or SR.
pixel_sizeThe fourth parameter denotes the pixel size w. The plane will be tiled with square pixels of width w such that the origin is the center of a pixel. pixel_size must have a positive value.
int_outputThe sixth parameter denotes the output representation. If the value of the sixth parameter is true then the centers of pixels constitute the integer grid, and hence the vertices of the output polylines will be integers. For example, the coordinates of the center of the pixel to the right of the pixel containing the origin will be (1,0) regardless of the pixel width. If the value of the sixth parameter is false, then the centers of hot pixels (and hence the vertices of the output polylines) will bear their original coordinates, which may not necessarily be integers. In the latter case, the coordinates of the center of the pixel to the right of the pixel containing the origin, for example, will be (w,0).
number_of_kd_treesThe seventh parameter is briefly described later on this page; for a detailed description see [3].

Snap Rounding (SR, for short) is a well known method for converting arbitrary-precision arrangements of segments into a fixed-precision representation [1], [2], [4]. In the study of robust geometric computing, it can be classified as a finite precision approximation technique. Iterated Snap Rounding (ISR, for short) is a modification of SR in which each vertex is at least half-the-width-of-a-pixel away from any non-incident edge [3]. This package supports both methods. Algorithmic details and experimental results are given in [3].

Given a finite collection \( \Sc\) of segments in the plane, the arrangement of \( \Sc\) denoted \( \Ac(\Sc)\) is the subdivision of the plane into vertices, edges, and faces induced by \( \Sc\). A vertex of the arrangement is either a segment endpoint or the intersection of two segments. Given an arrangement of segments whose vertices are represented with arbitrary-precision coordinates, SR proceeds as follows. We tile the plane with a grid of unit squares, pixels, each centered at a point with integer coordinates. A pixel is hot if it contains a vertex of the arrangement. Each vertex of the arrangement is replaced by the center of the hot pixel containing it and each edge \( e\) is replaced by the polygonal chain through the centers of the hot pixels met by \( e\), in the same order as they are met by \( e\).

In a snap-rounded arrangement, the distance between a vertex and a non-incident edge can be extremely small compared with the width of a pixel in the grid used for rounding. ISR is a modification of SR which makes a vertex and a non-incident edge well separated (the distance between each is at least half-the-width-of-a-pixel). However, the guaranteed quality of the approximation in ISR degrades. For more details on ISR see [3].

The traits used here must support (arbitrary-precision) rational number type as this is a basic requirement of SR.

About the Number of kd-Trees

A basic query used in the algorithm is to report the hot pixels of size \( w\) that a certain segment \( s\) intersects. An alternative way to do the same is to query the hot pixels' centers contained in a Minkowski sum of \( s\) with a pixel of width \( w\) centered at the origin; we denote this Minkowski sum by \( M(s)\). Since efficiently implementing this kind of query is difficult, we use an orthogonal range-search structure instead. We query with the bounding box \( B(M(s))\) of \( M(s)\) in a two-dimensional kd-tree which stores the centers of hot pixels. Since \( B(M(s))\) in general is larger than \( M(s)\), we still need to filter out the hot pixels which do not intersect \( s\).

While this approach is easy to implement with CGAL, it may incur considerable overhead since the area of \( B(M(s))\) may be much larger than the area of \( M(s)\), possibly resulting in many redundant hot pixels to filter out. Our heuristic solution, which we describe next, is to use a cluster of kd-trees rather than just one. The cluster includes several kd-trees, each has the plane, and hence the centers of hot pixels, rotated by a different angle in the first quadrant of the plane; for our purpose, a rotation by angles outside this quadrant is symmetric to a rotation by an angle in the first quadrant.

Given a parameter \( c\), the angles of rotation are \( (i - 1) \frac{\pi}{2c}, i=1,\ldots,c\), and we construct a kd-tree corresponding to each of these angles. Then for a query segment \( s\), we choose the kd-tree for which the area of \( B(M(s))\) is the smallest, in order to (potentially) get less hot pixels to filter out. Since constructing many kd-trees may be costly, our algorithm avoids building a kd-tree which it expects to be queried a relatively small number of times (we estimate this number in advance). How many kd-trees should be used? It is difficult to provide a simple answer for that. There are inputs for which the time to build more than one kd-tree is far greater than the time saved by having to filter out less hot pixels (sparse arrangements demonstrate this behavior), and there are inputs which benefit from using several kd-trees. Thus, the user can control the number of kd-trees with the parameter number_of_kd_trees. Typically, but not always, one kd-tree (the default) is sufficient.