convex_hull.hpp

/*
 * Software License Agreement (BSD License)
 *
 *  Point Cloud Library (PCL) - www.pointclouds.org
 *  Copyright (c) 2010-2012, Willow Garage, Inc.
 *
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   * Neither the name of Willow Garage, Inc. nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *
 * $Id$
 *
 */
 
#include <pcl/pcl_config.h>
#ifdef HAVE_QHULL
 
#ifndef PCL_SURFACE_IMPL_CONVEX_HULL_H_
#define PCL_SURFACE_IMPL_CONVEX_HULL_H_
 
#include <pcl/surface/convex_hull.h>
#include <pcl/common/common.h>
#include <pcl/common/eigen.h>
#include <pcl/common/transforms.h>
#include <pcl/common/io.h>
#include <cstdio>
#include <cstdlib>
#include <pcl/surface/qhull.h>
 
//////////////////////////////////////////////////////////////////////////
template <typename PointInT> void
pcl::ConvexHull<PointInT>::calculateInputDimension ()
{
  PCL_DEBUG ("[pcl::%s::calculateInputDimension] WARNING: Input dimension not specified.  Automatically determining input dimension.\n", getClassName ().c_str ());
  Eigen::Vector4d xyz_centroid;
  compute3DCentroid (*input_, *indices_, xyz_centroid);
  EIGEN_ALIGN16 Eigen::Matrix3d covariance_matrix = Eigen::Matrix3d::Zero ();
  computeCovarianceMatrixNormalized (*input_, *indices_, xyz_centroid, covariance_matrix);
 
  EIGEN_ALIGN16 Eigen::Vector3d eigen_values;
  pcl::eigen33 (covariance_matrix, eigen_values);
 
  if (std::abs (eigen_values[0]) < std::numeric_limits<double>::epsilon () || std::abs (eigen_values[0] / eigen_values[2]) < 1.0e-3)
    dimension_ = 2;
  else
    dimension_ = 3;
}
 
//////////////////////////////////////////////////////////////////////////
template <typename PointInT> void
pcl::ConvexHull<PointInT>::performReconstruction2D (PointCloud &hull, std::vector<pcl::Vertices> &polygons,
                                                    bool)
{
  int dimension = 2;
  bool xy_proj_safe = true;
  bool yz_proj_safe = true;
  bool xz_proj_safe = true;
 
  Eigen::Vector4d normal_calc_centroid;
  Eigen::Matrix3d normal_calc_covariance;
 
  // Check the input's normal to see which projection to use
  PointInT p0 = (*input_)[(*indices_)[0]];
  PointInT p1 = (*input_)[(*indices_)[indices_->size () - 1]];
  PointInT p2 = (*input_)[(*indices_)[indices_->size () / 2]];
  if (pcl::isXYZFinite(p0) && pcl::isXYZFinite(p1) && pcl::isXYZFinite(p2) &&
      (p1.getVector3fMap() - p0.getVector3fMap())
              .cross(p2.getVector3fMap() - p0.getVector3fMap())
              .stableNorm() > Eigen::NumTraits<float>::dummy_precision()) {
    pcl::PointCloud<PointInT> normal_calc_cloud;
    normal_calc_cloud.resize(3);
    normal_calc_cloud[0] = p0;
    normal_calc_cloud[1] = p1;
    normal_calc_cloud[2] = p2;
 
    pcl::compute3DCentroid(normal_calc_cloud, normal_calc_centroid);
    pcl::computeCovarianceMatrixNormalized(
        normal_calc_cloud, normal_calc_centroid, normal_calc_covariance);
  }
  else {
    // Three points do not form a valid triangle, fallback to use all points to
    // calculate the covariance matrix
    pcl::compute3DCentroid(*input_, *indices_, normal_calc_centroid);
    pcl::computeCovarianceMatrixNormalized(
        *input_, *indices_, normal_calc_centroid, normal_calc_covariance);
  }
 
  // Need to set -1 here. See eigen33 for explanations.
  Eigen::Vector3d::Scalar eigen_value;
  Eigen::Vector3d plane_params;
  pcl::eigen33 (normal_calc_covariance, eigen_value, plane_params);
  float theta_x = std::abs (static_cast<float> (plane_params.dot (x_axis_)));
  float theta_y = std::abs (static_cast<float> (plane_params.dot (y_axis_)));
  float theta_z = std::abs (static_cast<float> (plane_params.dot (z_axis_)));
 
  // Check for degenerate cases of each projection
  // We must avoid projections in which the plane projects as a line
  if (theta_z > projection_angle_thresh_)
  {
    xz_proj_safe = false;
    yz_proj_safe = false;
  }
  if (theta_x > projection_angle_thresh_)
  {
    xz_proj_safe = false;
    xy_proj_safe = false;
  }
  if (theta_y > projection_angle_thresh_)
  {
    xy_proj_safe = false;
    yz_proj_safe = false;
  }
 
  // True if qhull should free points in qh_freeqhull() or reallocation
  boolT ismalloc = True;
  // output from qh_produce_output(), use NULL to skip qh_produce_output()
  FILE *outfile = nullptr;
 
  if (compute_area_ && pcl::console::isVerbosityLevelEnabled(pcl::console::L_DEBUG))
    outfile = stderr;
 
  // option flags for qhull, see qh_opt.htm
  const char* flags = qhull_flags.c_str ();
  // error messages from qhull code
  FILE *errfile = stderr;
 
  // Array of coordinates for each point
  coordT *points = reinterpret_cast<coordT*> (calloc (indices_->size () * dimension, sizeof (coordT)));
 
  // Build input data, using appropriate projection
  int j = 0;
  if (xy_proj_safe)
  {
    for (std::size_t i = 0; i < indices_->size (); ++i, j+=dimension)
    {
      points[j + 0] = static_cast<coordT> ((*input_)[(*indices_)[i]].x);
      points[j + 1] = static_cast<coordT> ((*input_)[(*indices_)[i]].y);
    }
  } 
  else if (yz_proj_safe)
  {
    for (std::size_t i = 0; i < indices_->size (); ++i, j+=dimension)
    {
      points[j + 0] = static_cast<coordT> ((*input_)[(*indices_)[i]].y);
      points[j + 1] = static_cast<coordT> ((*input_)[(*indices_)[i]].z);
    }
  }
  else if (xz_proj_safe)
  {
    for (std::size_t i = 0; i < indices_->size (); ++i, j+=dimension)
    {
      points[j + 0] = static_cast<coordT> ((*input_)[(*indices_)[i]].x);
      points[j + 1] = static_cast<coordT> ((*input_)[(*indices_)[i]].z);
    }
  }
  else
  {
    // This should only happen if we had invalid input
    PCL_ERROR ("[pcl::%s::performReconstruction2D] Invalid input!\n", getClassName ().c_str ());
  }
 
  qhT qh_qh;
  qhT* qh = &qh_qh;
  QHULL_LIB_CHECK
  qh_zero(qh, errfile);
   
  // Compute convex hull
  int exitcode = qh_new_qhull (qh, dimension, static_cast<int> (indices_->size ()), points, ismalloc, const_cast<char*> (flags), outfile, errfile);
  if (compute_area_)
  {
    qh_prepare_output(qh);
  }
    
  // 0 if no error from qhull or it doesn't find any vertices
  if (exitcode != 0 || qh->num_vertices == 0)
  {
    PCL_ERROR ("[pcl::%s::performReconstrution2D] ERROR: qhull was unable to compute a convex hull for the given point cloud (%lu)!\n", getClassName ().c_str (), indices_->size ());
 
    hull.resize (0);
    hull.width = hull.height = 0;
    polygons.resize (0);
 
    qh_freeqhull (qh, !qh_ALL);
    int curlong, totlong;
    qh_memfreeshort (qh, &curlong, &totlong);
 
    return;
  }
 
  // Qhull returns the area in volume for 2D
  if (compute_area_)
  {
    total_area_ = qh->totvol;
    total_volume_ = 0.0;
  }
 
  int num_vertices = qh->num_vertices;
 
  hull.clear();
  hull.resize(num_vertices, PointInT{});
 
  vertexT * vertex;
  int i = 0;
 
  AlignedVector<std::pair<int, Eigen::Vector4f>> idx_points (num_vertices);
 
  FORALLvertices
  {
    hull[i] = (*input_)[(*indices_)[qh_pointid (qh, vertex->point)]];
    idx_points[i].first = qh_pointid (qh, vertex->point);
    ++i;
  }
 
  // Sort
  Eigen::Vector4f centroid;
  pcl::compute3DCentroid (hull, centroid);
  if (xy_proj_safe)
  {
    for (std::size_t j = 0; j < hull.size (); j++)
    {
      idx_points[j].second[0] = hull[j].x - centroid[0];
      idx_points[j].second[1] = hull[j].y - centroid[1];
    }
  }
  else if (yz_proj_safe)
  {
    for (std::size_t j = 0; j < hull.size (); j++)
    {
      idx_points[j].second[0] = hull[j].y - centroid[1];
      idx_points[j].second[1] = hull[j].z - centroid[2];
    }
  }
  else if (xz_proj_safe)
  {
    for (std::size_t j = 0; j < hull.size (); j++)
    {
      idx_points[j].second[0] = hull[j].x - centroid[0];
      idx_points[j].second[1] = hull[j].z - centroid[2];
    }
  }
  std::sort (idx_points.begin (), idx_points.end (), comparePoints2D);
    
  polygons.resize (1);
  polygons[0].vertices.resize (hull.size ());
 
  hull_indices_.header = input_->header;
  hull_indices_.indices.clear ();
  hull_indices_.indices.reserve (hull.size ());
 
  for (int j = 0; j < static_cast<int> (hull.size ()); j++)
  {
    hull_indices_.indices.push_back ((*indices_)[idx_points[j].first]);
    hull[j] = (*input_)[(*indices_)[idx_points[j].first]];
    polygons[0].vertices[j] = static_cast<unsigned int> (j);
  }
    
  qh_freeqhull (qh, !qh_ALL);
  int curlong, totlong;
  qh_memfreeshort (qh, &curlong, &totlong);
 
  hull.width = hull.size ();
  hull.height = 1;
  hull.is_dense = false;
  return;
}
 
#ifdef __GNUC__
#pragma GCC diagnostic ignored "-Wold-style-cast"
#endif
//////////////////////////////////////////////////////////////////////////
template <typename PointInT> void
pcl::ConvexHull<PointInT>::performReconstruction3D (
    PointCloud &hull, std::vector<pcl::Vertices> &polygons, bool fill_polygon_data)
{
  int dimension = 3;
 
  // True if qhull should free points in qh_freeqhull() or reallocation
  boolT ismalloc = True;
  // output from qh_produce_output(), use NULL to skip qh_produce_output()
  FILE *outfile = nullptr;
 
  if (compute_area_ && pcl::console::isVerbosityLevelEnabled(pcl::console::L_DEBUG))
    outfile = stderr;
 
  // option flags for qhull, see qh_opt.htm
  const char *flags = qhull_flags.c_str ();
  // error messages from qhull code
  FILE *errfile = stderr;
 
  // Array of coordinates for each point
  coordT *points = reinterpret_cast<coordT*> (calloc (indices_->size () * dimension, sizeof (coordT)));
 
  int j = 0;
  for (std::size_t i = 0; i < indices_->size (); ++i, j+=dimension)
  {
    points[j + 0] = static_cast<coordT> ((*input_)[(*indices_)[i]].x);
    points[j + 1] = static_cast<coordT> ((*input_)[(*indices_)[i]].y);
    points[j + 2] = static_cast<coordT> ((*input_)[(*indices_)[i]].z);
  }
 
  qhT qh_qh;
  qhT* qh = &qh_qh;
  QHULL_LIB_CHECK
  qh_zero(qh, errfile);
 
  // Compute convex hull
  int exitcode = qh_new_qhull (qh, dimension, static_cast<int> (indices_->size ()), points, ismalloc, const_cast<char*> (flags), outfile, errfile);
  if (compute_area_)
  {
    qh_prepare_output(qh);
  }
 
  // 0 if no error from qhull
  if (exitcode != 0)
  {
    PCL_ERROR("[pcl::%s::performReconstrution3D] ERROR: qhull was unable to compute a "
              "convex hull for the given point cloud (%zu)!\n",
              getClassName().c_str(),
              static_cast<std::size_t>(input_->size()));
 
    hull.resize (0);
    hull.width = hull.height = 0;
    polygons.resize (0);
 
    qh_freeqhull (qh, !qh_ALL);
    int curlong, totlong;
    qh_memfreeshort (qh, &curlong, &totlong);
 
    return;
  }
 
  qh_triangulate (qh);
 
  int num_facets = qh->num_facets;
 
  int num_vertices = qh->num_vertices;
  hull.resize (num_vertices);
 
  vertexT * vertex;
  int i = 0;
  // Max vertex id
  unsigned int max_vertex_id = 0;
  FORALLvertices
  {
    if (vertex->id + 1 > max_vertex_id)
      max_vertex_id = vertex->id + 1;
  }
 
  ++max_vertex_id;
  std::vector<int> qhid_to_pcidx (max_vertex_id);
 
  hull_indices_.header = input_->header;
  hull_indices_.indices.clear ();
  hull_indices_.indices.reserve (num_vertices);
 
  FORALLvertices
  {
    // Add vertices to hull point_cloud and store index
    hull_indices_.indices.push_back ((*indices_)[qh_pointid (qh, vertex->point)]);
    hull[i] = (*input_)[hull_indices_.indices.back ()];
 
    qhid_to_pcidx[vertex->id] = i; // map the vertex id of qhull to the point cloud index
    ++i;
  }
 
  if (compute_area_)
  {
    total_area_  = qh->totarea;
    total_volume_ = qh->totvol;
  }
 
  if (fill_polygon_data)
  {
    polygons.resize (num_facets);
    int dd = 0;
 
    facetT * facet;
    FORALLfacets
    {
      polygons[dd].vertices.resize (3);
 
      // Needed by FOREACHvertex_i_
      int vertex_n, vertex_i;
      FOREACHvertex_i_ (qh, (*facet).vertices)
      //facet_vertices.vertices.push_back (qhid_to_pcidx[vertex->id]);
      polygons[dd].vertices[vertex_i] = qhid_to_pcidx[vertex->id];
      ++dd;
    }
  }
  // Deallocates memory (also the points)
  qh_freeqhull (qh, !qh_ALL);
  int curlong, totlong;
  qh_memfreeshort (qh, &curlong, &totlong);
 
  hull.width = hull.size ();
  hull.height = 1;
  hull.is_dense = false;
}
#ifdef __GNUC__
#pragma GCC diagnostic warning "-Wold-style-cast"
#endif
 
//////////////////////////////////////////////////////////////////////////
template <typename PointInT> void
pcl::ConvexHull<PointInT>::performReconstruction (PointCloud &hull, std::vector<pcl::Vertices> &polygons,
                                                  bool fill_polygon_data)
{
  if (dimension_ == 0)
    calculateInputDimension ();
  if (dimension_ == 2)
    performReconstruction2D (hull, polygons, fill_polygon_data);
  else if (dimension_ == 3)
    performReconstruction3D (hull, polygons, fill_polygon_data);
  else
    PCL_ERROR ("[pcl::%s::performReconstruction] Error: invalid input dimension requested: %d\n",getClassName ().c_str (),dimension_);
}
 
//////////////////////////////////////////////////////////////////////////
template <typename PointInT> void
pcl::ConvexHull<PointInT>::reconstruct (PointCloud &points)
{
  points.header = input_->header;
  if (!initCompute () || input_->points.empty () || indices_->empty ())
  {
    points.clear ();
    return;
  }
 
  // Perform the actual surface reconstruction
  std::vector<pcl::Vertices> polygons;
  performReconstruction (points, polygons, false);
 
  points.width = points.size ();
  points.height = 1;
  points.is_dense = true;
 
  deinitCompute ();
}
 
 
//////////////////////////////////////////////////////////////////////////
template <typename PointInT> void
pcl::ConvexHull<PointInT>::performReconstruction (PolygonMesh &output)
{
  // Perform reconstruction
  pcl::PointCloud<PointInT> hull_points;
  performReconstruction (hull_points, output.polygons, true);
 
  // Convert the PointCloud into a PCLPointCloud2
  pcl::toPCLPointCloud2 (hull_points, output.cloud);
}
 
//////////////////////////////////////////////////////////////////////////
template <typename PointInT> void
pcl::ConvexHull<PointInT>::performReconstruction (std::vector<pcl::Vertices> &polygons)
{
  pcl::PointCloud<PointInT> hull_points;
  performReconstruction (hull_points, polygons, true);
}
 
//////////////////////////////////////////////////////////////////////////
template <typename PointInT> void
pcl::ConvexHull<PointInT>::reconstruct (PointCloud &points, std::vector<pcl::Vertices> &polygons)
{
  points.header = input_->header;
  if (!initCompute () || input_->points.empty () || indices_->empty ())
  {
    points.clear ();
    return;
  }
 
  // Perform the actual surface reconstruction
  performReconstruction (points, polygons, true);
 
  points.width = points.size ();
  points.height = 1;
  points.is_dense = true;
 
  deinitCompute ();
}
//////////////////////////////////////////////////////////////////////////
template <typename PointInT> void
pcl::ConvexHull<PointInT>::getHullPointIndices (pcl::PointIndices &hull_point_indices) const
{
  hull_point_indices = hull_indices_;
}
 
#define PCL_INSTANTIATE_ConvexHull(T) template class PCL_EXPORTS pcl::ConvexHull<T>;
 
#endif    // PCL_SURFACE_IMPL_CONVEX_HULL_H_
#endif