updates range_cutoff API documentation

This commit is contained in:
enriquefernandez 2014-06-04 13:46:21 +02:00
parent c8fc9bf5b4
commit 072561a2f3

View File

@ -115,7 +115,8 @@ namespace laser_geometry
* \param scan_in The input laser scan * \param scan_in The input laser scan
* \param cloud_out The output point cloud * \param cloud_out The output point cloud
* \param range_cutoff An additional range cutoff which can be * \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. * \param channel_option An OR'd set of channels to include.
* Options include: channel_option::Default, * Options include: channel_option::Default,
* channel_option::Intensity, channel_option::Index, * channel_option::Intensity, channel_option::Index,
@ -138,7 +139,8 @@ namespace laser_geometry
* \param scan_in The input laser scan * \param scan_in The input laser scan
* \param cloud_out The output point cloud * \param cloud_out The output point cloud
* \param range_cutoff An additional range cutoff which can be * \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. * \param channel_option An OR'd set of channels to include.
* Options include: channel_option::Default, * Options include: channel_option::Default,
* channel_option::Intensity, channel_option::Index, * channel_option::Intensity, channel_option::Index,
@ -168,7 +170,7 @@ namespace laser_geometry
* \param tf a tf::Transformer object to use to perform the * \param tf a tf::Transformer object to use to perform the
* transform * transform
* \param range_cutoff An additional range cutoff which can be * \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. * \param channel_option An OR'd set of channels to include.
* Options include: channel_option::Default, * Options include: channel_option::Default,
* channel_option::Intensity, channel_option::Index, * channel_option::Intensity, channel_option::Index,
@ -227,7 +229,8 @@ namespace laser_geometry
* \param tf a tf::Transformer object to use to perform the * \param tf a tf::Transformer object to use to perform the
* transform * transform
* \param range_cutoff An additional range cutoff which can be * \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. * \param channel_option An OR'd set of channels to include.
* Options include: channel_option::Default, * Options include: channel_option::Default,
* channel_option::Intensity, channel_option::Index, * channel_option::Intensity, channel_option::Index,