322 lines
11 KiB
C
322 lines
11 KiB
C
|
// Copyright (c) 2007-09 INRIA Sophia-Antipolis (France).
|
||
|
|
// All rights reserved.
|
||
|
|
//
|
||
|
|
// This file is part of CGAL (www.cgal.org).
|
||
|
|
// You can redistribute it and/or modify it under the terms of the GNU
|
||
|
|
// General Public License as published by the Free Software Foundation,
|
||
|
|
// either version 3 of the License, or (at your option) any later version.
|
||
|
|
//
|
||
|
|
// Licensees holding a valid commercial license may use this file in
|
||
|
|
// accordance with the commercial license agreement provided with the software.
|
||
|
|
//
|
||
|
|
// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
|
||
|
|
// WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
|
||
|
|
//
|
||
|
|
// $URL$
|
||
|
|
// $Id$
|
||
|
|
// SPDX-License-Identifier: GPL-3.0+
|
||
|
|
//
|
||
|
|
// Author(s) : Nader Salman and Laurent Saboret
|
||
|
|
|
||
|
|
#ifndef CGAL_GRID_SIMPLIFY_POINT_SET_H
|
||
|
|
#define CGAL_GRID_SIMPLIFY_POINT_SET_H
|
||
|
|
|
||
|
|
#include <CGAL/license/Point_set_processing_3.h>
|
||
|
|
|
||
|
|
#include <CGAL/disable_warnings.h>
|
||
|
|
|
||
|
|
#include <CGAL/property_map.h>
|
||
|
|
#include <CGAL/Kernel_traits.h>
|
||
|
|
#include <CGAL/point_set_processing_assertions.h>
|
||
|
|
#include <CGAL/unordered.h>
|
||
|
|
#include <CGAL/Iterator_range.h>
|
||
|
|
#include <CGAL/function.h>
|
||
|
|
#include <boost/functional/hash.hpp>
|
||
|
|
|
||
|
|
#include <CGAL/boost/graph/named_function_params.h>
|
||
|
|
#include <CGAL/boost/graph/named_params_helper.h>
|
||
|
|
|
||
|
|
#include <iterator>
|
||
|
|
#include <deque>
|
||
|
|
#include <algorithm>
|
||
|
|
#include <cmath>
|
||
|
|
|
||
|
|
namespace CGAL {
|
||
|
|
|
||
|
|
|
||
|
|
// ----------------------------------------------------------------------------
|
||
|
|
// Private section
|
||
|
|
// ----------------------------------------------------------------------------
|
||
|
|
/// \cond SKIP_IN_MANUAL
|
||
|
|
|
||
|
|
namespace internal {
|
||
|
|
|
||
|
|
|
||
|
|
// Round number to multiples of epsilon
|
||
|
|
inline double round_epsilon(double value, double epsilon)
|
||
|
|
{
|
||
|
|
return std::floor(value / epsilon);
|
||
|
|
}
|
||
|
|
|
||
|
|
/// Utility class for grid_simplify_point_set(): Hash_epsilon_points_3
|
||
|
|
/// defines a 3D point hash / 2 points are equal iff they belong to
|
||
|
|
/// the same cell of a grid of cell size = epsilon.
|
||
|
|
template <class Point_3, class PointMap>
|
||
|
|
struct Hash_epsilon_points_3
|
||
|
|
{
|
||
|
|
private:
|
||
|
|
|
||
|
|
double m_epsilon;
|
||
|
|
PointMap point_map;
|
||
|
|
typedef typename boost::property_traits<PointMap>::value_type Point;
|
||
|
|
public:
|
||
|
|
|
||
|
|
Hash_epsilon_points_3 (double epsilon, PointMap p_map)
|
||
|
|
: m_epsilon (epsilon), point_map(p_map)
|
||
|
|
{
|
||
|
|
CGAL_point_set_processing_precondition(epsilon > 0);
|
||
|
|
}
|
||
|
|
|
||
|
|
std::size_t operator() (const Point_3& a) const
|
||
|
|
{
|
||
|
|
const Point& pa = get(point_map,a);
|
||
|
|
std::size_t result = boost::hash_value(round_epsilon(pa.x(), m_epsilon));
|
||
|
|
boost::hash_combine(result, boost::hash_value(round_epsilon(pa.y(), m_epsilon)));
|
||
|
|
boost::hash_combine(result, boost::hash_value(round_epsilon(pa.z(), m_epsilon)));
|
||
|
|
return result;
|
||
|
|
}
|
||
|
|
|
||
|
|
};
|
||
|
|
|
||
|
|
/// Utility class for grid_simplify_point_set(): Hash_epsilon_points_3
|
||
|
|
/// defines a 3D point equality / 2 points are equal iff they belong
|
||
|
|
/// to the same cell of a grid of cell size = epsilon.
|
||
|
|
template <class Point_3, class PointMap>
|
||
|
|
struct Equal_epsilon_points_3
|
||
|
|
{
|
||
|
|
private:
|
||
|
|
|
||
|
|
const double m_epsilon;
|
||
|
|
PointMap point_map;
|
||
|
|
typedef typename boost::property_traits<PointMap>::value_type Point;
|
||
|
|
public:
|
||
|
|
|
||
|
|
Equal_epsilon_points_3 (const double& epsilon, PointMap p_map)
|
||
|
|
: m_epsilon (epsilon), point_map(p_map)
|
||
|
|
{
|
||
|
|
CGAL_point_set_processing_precondition(epsilon > 0);
|
||
|
|
}
|
||
|
|
|
||
|
|
bool operator() (const Point_3& a, const Point_3& b) const
|
||
|
|
{
|
||
|
|
const Point& pa = get(point_map,a);
|
||
|
|
const Point& pb = get(point_map,b);
|
||
|
|
|
||
|
|
double ra = round_epsilon(pa.x(), m_epsilon);
|
||
|
|
double rb = round_epsilon(pb.x(), m_epsilon);
|
||
|
|
if (ra != rb)
|
||
|
|
return false;
|
||
|
|
ra = round_epsilon(pa.y(), m_epsilon);
|
||
|
|
rb = round_epsilon(pb.y(), m_epsilon);
|
||
|
|
if (ra != rb)
|
||
|
|
return false;
|
||
|
|
ra = round_epsilon(pa.z(), m_epsilon);
|
||
|
|
rb = round_epsilon(pb.z(), m_epsilon);
|
||
|
|
return ra == rb;
|
||
|
|
}
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
} /* namespace internal */
|
||
|
|
|
||
|
|
|
||
|
|
/// Utility class for grid_simplify_point_set():
|
||
|
|
/// 3D points set which allows at most 1 point per cell
|
||
|
|
/// of a grid of cell size = epsilon.
|
||
|
|
///
|
||
|
|
/// Warning:
|
||
|
|
/// This class is a container sorted wrt points position
|
||
|
|
/// => you should not modify directly the order or the position of points.
|
||
|
|
|
||
|
|
template <class Point_3, class PointMap>
|
||
|
|
class Epsilon_point_set_3
|
||
|
|
: public cpp11::unordered_set<Point_3,
|
||
|
|
internal::Hash_epsilon_points_3<Point_3, PointMap>,
|
||
|
|
internal::Equal_epsilon_points_3<Point_3, PointMap> >
|
||
|
|
{
|
||
|
|
private:
|
||
|
|
|
||
|
|
// superclass
|
||
|
|
typedef cpp11::unordered_set<Point_3,
|
||
|
|
internal::Hash_epsilon_points_3<Point_3, PointMap>,
|
||
|
|
internal::Equal_epsilon_points_3<Point_3, PointMap> > Base;
|
||
|
|
|
||
|
|
public:
|
||
|
|
|
||
|
|
Epsilon_point_set_3 (double epsilon, PointMap point_map)
|
||
|
|
: Base(10, internal::Hash_epsilon_points_3<Point_3, PointMap>(epsilon, point_map),
|
||
|
|
internal::Equal_epsilon_points_3<Point_3, PointMap>(epsilon, point_map))
|
||
|
|
{
|
||
|
|
CGAL_point_set_processing_precondition(epsilon > 0);
|
||
|
|
}
|
||
|
|
|
||
|
|
// default copy constructor, operator =() and destructor are fine.
|
||
|
|
};
|
||
|
|
|
||
|
|
/// \endcond
|
||
|
|
|
||
|
|
// ----------------------------------------------------------------------------
|
||
|
|
// Public section
|
||
|
|
// ----------------------------------------------------------------------------
|
||
|
|
|
||
|
|
/**
|
||
|
|
\ingroup PkgPointSetProcessingAlgorithms
|
||
|
|
Merges points which belong to the same cell of a grid of cell size = `epsilon`.
|
||
|
|
|
||
|
|
This method modifies the order of input points so as to pack all remaining points first,
|
||
|
|
and returns an iterator over the first point to remove (see erase-remove idiom).
|
||
|
|
For this reason it should not be called on sorted containers.
|
||
|
|
|
||
|
|
\pre `epsilon > 0`
|
||
|
|
|
||
|
|
\tparam PointRange is a model of `Range`. The value type of
|
||
|
|
its iterator is the key type of the named parameter `point_map`.
|
||
|
|
|
||
|
|
\param points input point range.
|
||
|
|
\param epsilon tolerance value when merging 3D points.
|
||
|
|
\param np optional sequence of \ref psp_namedparameters "Named Parameters" among the ones listed below.
|
||
|
|
|
||
|
|
\cgalNamedParamsBegin
|
||
|
|
\cgalParamBegin{point_map} a model of `ReadWritePropertyMap` with value type `geom_traits::Point_3`.
|
||
|
|
If this parameter is omitted, `CGAL::Identity_property_map<geom_traits::Point_3>` is used.\cgalParamEnd
|
||
|
|
\cgalParamBegin{callback} an instance of
|
||
|
|
`cpp11::function<bool(double)>`. It is called regularly when the
|
||
|
|
algorithm is running: the current advancement (between 0. and
|
||
|
|
1.) is passed as parameter. If it returns `true`, then the
|
||
|
|
algorithm continues its execution normally; if it returns
|
||
|
|
`false`, the algorithm is stopped and simplification stops with
|
||
|
|
no guarantee on the output.\cgalParamEnd
|
||
|
|
\cgalParamBegin{geom_traits} an instance of a geometric traits class, model of `Kernel`\cgalParamEnd
|
||
|
|
\cgalNamedParamsEnd
|
||
|
|
|
||
|
|
\return iterator over the first point to remove.
|
||
|
|
*/
|
||
|
|
template <typename PointRange, typename NamedParameters>
|
||
|
|
typename PointRange::iterator
|
||
|
|
grid_simplify_point_set(
|
||
|
|
PointRange& points,
|
||
|
|
double epsilon,
|
||
|
|
const NamedParameters& np)
|
||
|
|
{
|
||
|
|
using boost::choose_param;
|
||
|
|
|
||
|
|
typedef typename Point_set_processing_3::GetPointMap<PointRange, NamedParameters>::const_type PointMap;
|
||
|
|
PointMap point_map = choose_param(get_param(np, internal_np::point_map), PointMap());
|
||
|
|
const cpp11::function<bool(double)>& callback = choose_param(get_param(np, internal_np::callback),
|
||
|
|
cpp11::function<bool(double)>());
|
||
|
|
|
||
|
|
// actual type of input points
|
||
|
|
typedef typename std::iterator_traits<typename PointRange::iterator>::value_type Enriched_point;
|
||
|
|
|
||
|
|
CGAL_point_set_processing_precondition(epsilon > 0);
|
||
|
|
|
||
|
|
// Merges points which belong to the same cell of a grid of cell size = epsilon.
|
||
|
|
// points_to_keep[] will contain 1 point per cell; the others will be in points_to_remove[].
|
||
|
|
Epsilon_point_set_3<Enriched_point, PointMap> points_to_keep(epsilon, point_map);
|
||
|
|
std::deque<Enriched_point> points_to_remove;
|
||
|
|
std::size_t nb = 0, nb_points = points.size();
|
||
|
|
for (typename PointRange::iterator it = points.begin(); it != points.end(); it++, ++ nb)
|
||
|
|
{
|
||
|
|
std::pair<typename Epsilon_point_set_3<Enriched_point, PointMap>::iterator,bool> result;
|
||
|
|
result = points_to_keep.insert(*it);
|
||
|
|
if (!result.second) // if not inserted
|
||
|
|
points_to_remove.push_back(*it);
|
||
|
|
if (callback && !callback ((nb+1) / double(nb_points)))
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Replaces `[first, beyond)` range by the content of points_to_keep, then points_to_remove.
|
||
|
|
typename PointRange::iterator first_point_to_remove =
|
||
|
|
std::copy(points_to_keep.begin(), points_to_keep.end(), points.begin());
|
||
|
|
std::copy(points_to_remove.begin(), points_to_remove.end(), first_point_to_remove);
|
||
|
|
|
||
|
|
return first_point_to_remove;
|
||
|
|
}
|
||
|
|
|
||
|
|
/// \cond SKIP_IN_MANUAL
|
||
|
|
// variant with default NP
|
||
|
|
template <typename PointRange>
|
||
|
|
typename PointRange::iterator
|
||
|
|
grid_simplify_point_set(PointRange& points, double epsilon)
|
||
|
|
{
|
||
|
|
return grid_simplify_point_set
|
||
|
|
(points, epsilon, CGAL::Point_set_processing_3::parameters::all_default(points));
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
#ifndef CGAL_NO_DEPRECATED_CODE
|
||
|
|
// deprecated API
|
||
|
|
template <typename ForwardIterator,
|
||
|
|
typename PointMap,
|
||
|
|
typename Kernel>
|
||
|
|
CGAL_DEPRECATED_MSG("you are using the deprecated V1 API of CGAL::grid_simplify_point_set(), please update your code")
|
||
|
|
ForwardIterator grid_simplify_point_set(
|
||
|
|
ForwardIterator first, ///< iterator over the first input point.
|
||
|
|
ForwardIterator beyond, ///< past-the-end iterator over the input points.
|
||
|
|
PointMap point_map, ///< property map: value_type of ForwardIterator -> Point_3
|
||
|
|
double epsilon, ///< tolerance value when merging 3D points.
|
||
|
|
const Kernel& /*kernel*/) ///< geometric traits.
|
||
|
|
{
|
||
|
|
CGAL::Iterator_range<ForwardIterator> points = CGAL::make_range (first, beyond);
|
||
|
|
return grid_simplify_point_set
|
||
|
|
(points,
|
||
|
|
epsilon,
|
||
|
|
CGAL::parameters::point_map (point_map).
|
||
|
|
geom_traits (Kernel()));
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
// deprecated API
|
||
|
|
template <typename ForwardIterator,
|
||
|
|
typename PointMap
|
||
|
|
>
|
||
|
|
CGAL_DEPRECATED_MSG("you are using the deprecated V1 API of CGAL::grid_simplify_point_set(), please update your code")
|
||
|
|
ForwardIterator
|
||
|
|
grid_simplify_point_set(
|
||
|
|
ForwardIterator first, ///< iterator over the first input point
|
||
|
|
ForwardIterator beyond, ///< past-the-end iterator
|
||
|
|
PointMap point_map, ///< property map: value_type of ForwardIterator -> Point_3
|
||
|
|
double epsilon) ///< tolerance value when merging 3D points
|
||
|
|
{
|
||
|
|
CGAL::Iterator_range<ForwardIterator> points = CGAL::make_range (first, beyond);
|
||
|
|
return grid_simplify_point_set
|
||
|
|
(points,
|
||
|
|
epsilon,
|
||
|
|
CGAL::parameters::point_map (point_map));
|
||
|
|
}
|
||
|
|
|
||
|
|
// deprecated API
|
||
|
|
template <typename ForwardIterator
|
||
|
|
>
|
||
|
|
CGAL_DEPRECATED_MSG("you are using the deprecated V1 API of CGAL::grid_simplify_point_set(), please update your code")
|
||
|
|
ForwardIterator
|
||
|
|
grid_simplify_point_set(
|
||
|
|
ForwardIterator first, ///< iterator over the first input point
|
||
|
|
ForwardIterator beyond, ///< past-the-end iterator
|
||
|
|
double epsilon) ///< tolerance value when merging 3D points
|
||
|
|
{
|
||
|
|
CGAL::Iterator_range<ForwardIterator> points = CGAL::make_range (first, beyond);
|
||
|
|
return grid_simplify_point_set
|
||
|
|
(points,
|
||
|
|
epsilon);
|
||
|
|
}
|
||
|
|
#endif // CGAL_NO_DEPRECATED_CODE
|
||
|
|
/// \endcond
|
||
|
|
|
||
|
|
|
||
|
|
} //namespace CGAL
|
||
|
|
|
||
|
|
#include <CGAL/enable_warnings.h>
|
||
|
|
|
||
|
|
#endif // CGAL_GRID_SIMPLIFY_POINT_SET_H
|