From 072561a2f36daba1fd9b95c9c0a1fca5debd1538 Mon Sep 17 00:00:00 2001 From: enriquefernandez Date: Wed, 4 Jun 2014 13:46:21 +0200 Subject: [PATCH] updates range_cutoff API documentation --- include/laser_geometry/laser_geometry.h | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/include/laser_geometry/laser_geometry.h b/include/laser_geometry/laser_geometry.h index 9d60a88..eeae28f 100644 --- a/include/laser_geometry/laser_geometry.h +++ b/include/laser_geometry/laser_geometry.h @@ -115,7 +115,8 @@ namespace laser_geometry * \param scan_in The input laser scan * \param cloud_out The output point cloud * \param range_cutoff An additional range cutoff which can be - * applied which is more limiting than max_range in the scan. + * applied to discard everything above it. + * Defaults to -1.0, which means the laser scan max range. * \param channel_option An OR'd set of channels to include. * Options include: channel_option::Default, * channel_option::Intensity, channel_option::Index, @@ -138,7 +139,8 @@ namespace laser_geometry * \param scan_in The input laser scan * \param cloud_out The output point cloud * \param range_cutoff An additional range cutoff which can be - * applied which is more limiting than max_range in the scan. + * applied to discard everything above it. + * Defaults to -1.0, which means the laser scan max range. * \param channel_option An OR'd set of channels to include. * Options include: channel_option::Default, * channel_option::Intensity, channel_option::Index, @@ -168,7 +170,7 @@ namespace laser_geometry * \param tf a tf::Transformer object to use to perform the * transform * \param range_cutoff An additional range cutoff which can be - * applied which is more limiting than max_range in the scan. + * applied to discard everything above it. * \param channel_option An OR'd set of channels to include. * Options include: channel_option::Default, * channel_option::Intensity, channel_option::Index, @@ -227,7 +229,8 @@ namespace laser_geometry * \param tf a tf::Transformer object to use to perform the * transform * \param range_cutoff An additional range cutoff which can be - * applied which is more limiting than max_range in the scan. + * applied to discard everything above it. + * Defaults to -1.0, which means the laser scan max range. * \param channel_option An OR'd set of channels to include. * Options include: channel_option::Default, * channel_option::Intensity, channel_option::Index,