Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mvieth committed Nov 29, 2024
1 parent 3a0916d commit a4ad614
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 5 deletions.
8 changes: 4 additions & 4 deletions common/include/pcl/common/common.h
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ namespace pcl
getMaxDistance (const pcl::PointCloud<PointT> &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
Expand All @@ -189,7 +189,7 @@ namespace pcl
template <typename PointT> inline void
getMinMax3D (const pcl::PointCloud<PointT> &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
Expand All @@ -199,7 +199,7 @@ namespace pcl
getMinMax3D (const pcl::PointCloud<PointT> &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
Expand All @@ -210,7 +210,7 @@ namespace pcl
getMinMax3D (const pcl::PointCloud<PointT> &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
Expand Down
1 change: 1 addition & 0 deletions filters/include/pcl/filters/covariance_sampling.h
Original file line number Diff line number Diff line change
Expand Up @@ -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, [email protected]
*/
template <typename PointT, typename PointNT>
Expand Down
1 change: 1 addition & 0 deletions filters/include/pcl/filters/model_outlier_removal.h
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ namespace pcl
* filter.filter (*cloud_out);
* \endcode
* \ingroup filters
*/
template <typename PointT>
class ModelOutlierRemoval : public FilterIndices<PointT>
Expand Down
1 change: 1 addition & 0 deletions filters/include/pcl/filters/radius_outlier_removal.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
1 change: 1 addition & 0 deletions filters/include/pcl/filters/statistical_outlier_removal.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion sample_consensus/sample_consensus.doxy
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<li>\link pcl::SampleConsensusModelSphere SACMODEL_SPHERE \endlink - used to determine sphere models. The <b>four</b> coefficients of the sphere are given by its 3D center and radius as: [<b>center.x center.y center.z radius</b>]</li>
<li>\link pcl::SampleConsensusModelCylinder SACMODEL_CYLINDER \endlink - used to determine cylinder models. The <b>seven</b> coefficients of the cylinder are given by a point on its axis, the axis direction, and a radius, as: [<b>point_on_axis.x point_on_axis.y point_on_axis.z axis_direction.x axis_direction.y axis_direction.z radius</b>]</li>
<li>\link pcl::SampleConsensusModelCone SACMODEL_CONE \endlink - used to determine cone models. The <b>seven</b> coefficients of the cone are given by a point of its apex, the axis direction and the opening angle, as: [<b>apex.x, apex.y, apex.z, axis_direction.x, axis_direction.y, axis_direction.z, opening_angle</b>]</li>
<li>SACMODEL_TORUS - not implemented yet</li>
<li>\link pcl::SampleConsensusModelTorus SACMODEL_TORUS \endlink - used to determine torus models. The <b>eight</b> coefficients of the torus are given by the inner and outer radius, the center point, and the torus axis.</li>
<li>\link pcl::SampleConsensusModelParallelLine SACMODEL_PARALLEL_LINE \endlink - a model for determining a line <b>parallel</b> with a given axis, within a maximum specified angular deviation. The line coefficients are similar to \link pcl::SampleConsensusModelLine SACMODEL_LINE \endlink.</li>
<li>\link pcl::SampleConsensusModelPerpendicularPlane SACMODEL_PERPENDICULAR_PLANE \endlink - a model for determining a plane <b>perpendicular</b> to a user-specified axis, within a maximum specified angular deviation. The plane coefficients are similar to \link pcl::SampleConsensusModelPlane SACMODEL_PLANE \endlink.</li>
<li>SACMODEL_PARALLEL_LINES - not implemented yet</li>
Expand Down

0 comments on commit a4ad614

Please sign in to comment.