From a4ad614a1587801092fd085e4796c411017a77ac Mon Sep 17 00:00:00 2001 From: Markus Vieth Date: Thu, 21 Nov 2024 20:42:20 +0100 Subject: [PATCH] Improve documentation --- common/include/pcl/common/common.h | 8 ++++---- filters/include/pcl/filters/covariance_sampling.h | 1 + filters/include/pcl/filters/model_outlier_removal.h | 1 + filters/include/pcl/filters/radius_outlier_removal.h | 1 + filters/include/pcl/filters/statistical_outlier_removal.h | 1 + sample_consensus/sample_consensus.doxy | 2 +- 6 files changed, 9 insertions(+), 5 deletions(-) diff --git a/common/include/pcl/common/common.h b/common/include/pcl/common/common.h index af32634ca65..857cca893ac 100644 --- a/common/include/pcl/common/common.h +++ b/common/include/pcl/common/common.h @@ -180,7 +180,7 @@ namespace pcl getMaxDistance (const pcl::PointCloud &cloud, const Indices &indices, const Eigen::Vector4f &pivot_pt, Eigen::Vector4f &max_pt); - /** \brief Get the minimum and maximum values on each of the 3 (x-y-z) dimensions in a given pointcloud + /** \brief Get the minimum and maximum values on each of the 3 (x-y-z) dimensions in a given pointcloud. This is the axis aligned bounding box (AABB). * \param[in] cloud the point cloud data message * \param[out] min_pt the resultant minimum bounds * \param[out] max_pt the resultant maximum bounds @@ -189,7 +189,7 @@ namespace pcl template inline void getMinMax3D (const pcl::PointCloud &cloud, PointT &min_pt, PointT &max_pt); - /** \brief Get the minimum and maximum values on each of the 3 (x-y-z) dimensions in a given pointcloud + /** \brief Get the minimum and maximum values on each of the 3 (x-y-z) dimensions in a given pointcloud. This is the axis aligned bounding box (AABB). * \param[in] cloud the point cloud data message * \param[out] min_pt the resultant minimum bounds * \param[out] max_pt the resultant maximum bounds @@ -199,7 +199,7 @@ namespace pcl getMinMax3D (const pcl::PointCloud &cloud, Eigen::Vector4f &min_pt, Eigen::Vector4f &max_pt); - /** \brief Get the minimum and maximum values on each of the 3 (x-y-z) dimensions in a given pointcloud + /** \brief Get the minimum and maximum values on each of the 3 (x-y-z) dimensions in a given pointcloud. This is the axis aligned bounding box (AABB). * \param[in] cloud the point cloud data message * \param[in] indices the vector of point indices to use from \a cloud * \param[out] min_pt the resultant minimum bounds @@ -210,7 +210,7 @@ namespace pcl getMinMax3D (const pcl::PointCloud &cloud, const Indices &indices, Eigen::Vector4f &min_pt, Eigen::Vector4f &max_pt); - /** \brief Get the minimum and maximum values on each of the 3 (x-y-z) dimensions in a given pointcloud + /** \brief Get the minimum and maximum values on each of the 3 (x-y-z) dimensions in a given pointcloud. This is the axis aligned bounding box (AABB). * \param[in] cloud the point cloud data message * \param[in] indices the vector of point indices to use from \a cloud * \param[out] min_pt the resultant minimum bounds diff --git a/filters/include/pcl/filters/covariance_sampling.h b/filters/include/pcl/filters/covariance_sampling.h index d44b2e66a09..831a623be33 100644 --- a/filters/include/pcl/filters/covariance_sampling.h +++ b/filters/include/pcl/filters/covariance_sampling.h @@ -56,6 +56,7 @@ namespace pcl * Based on the following publication: * * "Geometrically Stable Sampling for the ICP Algorithm" - N. Gelfand, L. Ikemoto, S. Rusinkiewicz, M. Levoy * + * \ingroup filters * \author Alexandru E. Ichim, alex.e.ichim@gmail.com */ template diff --git a/filters/include/pcl/filters/model_outlier_removal.h b/filters/include/pcl/filters/model_outlier_removal.h index 8fbe3dce188..bc811290191 100644 --- a/filters/include/pcl/filters/model_outlier_removal.h +++ b/filters/include/pcl/filters/model_outlier_removal.h @@ -67,6 +67,7 @@ namespace pcl * filter.filter (*cloud_out); * \endcode + * \ingroup filters */ template class ModelOutlierRemoval : public FilterIndices diff --git a/filters/include/pcl/filters/radius_outlier_removal.h b/filters/include/pcl/filters/radius_outlier_removal.h index 23f1d48317d..b01d6619f8b 100644 --- a/filters/include/pcl/filters/radius_outlier_removal.h +++ b/filters/include/pcl/filters/radius_outlier_removal.h @@ -64,6 +64,7 @@ namespace pcl * indices_rem = rorfilter.getRemovedIndices (); * // The indices_rem array indexes all points of cloud_in that have 5 or more neighbors within the 0.1 search radius * \endcode + * \sa StatisticalOutlierRemoval * \author Radu Bogdan Rusu * \ingroup filters */ diff --git a/filters/include/pcl/filters/statistical_outlier_removal.h b/filters/include/pcl/filters/statistical_outlier_removal.h index 4abfd12316e..c752935b906 100644 --- a/filters/include/pcl/filters/statistical_outlier_removal.h +++ b/filters/include/pcl/filters/statistical_outlier_removal.h @@ -73,6 +73,7 @@ namespace pcl * indices_rem = sorfilter.getRemovedIndices (); * // The indices_rem array indexes all points of cloud_in that are outliers * \endcode + * \sa RadiusOutlierRemoval * \author Radu Bogdan Rusu * \ingroup filters */ diff --git a/sample_consensus/sample_consensus.doxy b/sample_consensus/sample_consensus.doxy index 914722bb28b..5ad7932867c 100644 --- a/sample_consensus/sample_consensus.doxy +++ b/sample_consensus/sample_consensus.doxy @@ -23,7 +23,7 @@
  • \link pcl::SampleConsensusModelSphere SACMODEL_SPHERE \endlink - used to determine sphere models. The four coefficients of the sphere are given by its 3D center and radius as: [center.x center.y center.z radius]
  • \link pcl::SampleConsensusModelCylinder SACMODEL_CYLINDER \endlink - used to determine cylinder models. The seven coefficients of the cylinder are given by a point on its axis, the axis direction, and a radius, as: [point_on_axis.x point_on_axis.y point_on_axis.z axis_direction.x axis_direction.y axis_direction.z radius]
  • \link pcl::SampleConsensusModelCone SACMODEL_CONE \endlink - used to determine cone models. The seven coefficients of the cone are given by a point of its apex, the axis direction and the opening angle, as: [apex.x, apex.y, apex.z, axis_direction.x, axis_direction.y, axis_direction.z, opening_angle]
    • -
  • SACMODEL_TORUS - not implemented yet
    • +
  • \link pcl::SampleConsensusModelTorus SACMODEL_TORUS \endlink - used to determine torus models. The eight coefficients of the torus are given by the inner and outer radius, the center point, and the torus axis.
  • \link pcl::SampleConsensusModelParallelLine SACMODEL_PARALLEL_LINE \endlink - a model for determining a line parallel with a given axis, within a maximum specified angular deviation. The line coefficients are similar to \link pcl::SampleConsensusModelLine SACMODEL_LINE \endlink.
  • \link pcl::SampleConsensusModelPerpendicularPlane SACMODEL_PERPENDICULAR_PLANE \endlink - a model for determining a plane perpendicular to a user-specified axis, within a maximum specified angular deviation. The plane coefficients are similar to \link pcl::SampleConsensusModelPlane SACMODEL_PLANE \endlink.
  • SACMODEL_PARALLEL_LINES - not implemented yet