diff --git a/pointmatcher/Documentation.dox b/pointmatcher/Documentation.dox index 1fbbb3ae..1b85ce96 100644 --- a/pointmatcher/Documentation.dox +++ b/pointmatcher/Documentation.dox @@ -62,7 +62,7 @@ You can list the available modules with: pmicp -l \endcode -If you have compiled libpointmatcher with \ref yaml-cpp enabled, you can configure the ICP chain without any recompilation by passing a configuration file to the \c pmicp command using the \c --config switch. An example file is available in \c examples/data/default.yaml. +Thanks to \ref yaml-cpp , you can configure the ICP chain without any recompilation by passing a configuration file to the \c pmicp command using the \c --config switch. An example file is available in \c examples/data/default.yaml. \section Understanding Understanding libpointmatcher @@ -75,7 +75,7 @@ In libpointmatcher, every module is a class that can describe its own possible p This text-based configuration aids to explicit parameters used and eases the sharing of working setups with others, which ultimately allows for reproducibility and reusability of the solutions. The ICP chain takes as input two point clouds, in 2D or 3D, and estimates the translation and the rotation parameters that minimize the alignment error. -We called the first point cloud the \e reference and the second the \e reading. +We called the first point cloud the \e reference and the second the \e reading. The ICP algorithm tries to align the reading onto the reference. To do so, it first applies filtering (PointMatcher::DataPointsFilters) to the point clouds, and then it iterates through a sequence of processing blocks. For each iteration, it associates points in reading to points in reference (PointMatcher::Matcher), rejects outliers (PointMatcher::OutlierFilters) and finds a transformation (PointMatcher::TransformationParameters) of reading that minimizes the alignment error (PointMatcher::ErrorMinimizer). @@ -126,7 +126,7 @@ You have to modify 3 files to add a new \ref PointMatcher::DataPointsFilter "Dat - The types of the parameters are used to properly cast the string value and can be: \c &P::Comp, \c &P::Comp, \c &P::Comp, etc. See \c DataPointsFiltersImpl.h for examples. - Uncomment and rename the constructor. -- In \c DataPointsFiltersImpl.cpp, copy the implementation of \c IdentityDataPointsFilter at the end of the file including the explicit instantiation (i.e. \c template \c struct \c DataPointsFiltersImpl::YourFilter; and \c template \c struct +- In \c DataPointsFiltersImpl.cpp, copy the implementation of \c IdentityDataPointsFilter at the end of the file including the explicit instantiation (i.e. \c template \c struct \c DataPointsFiltersImpl::YourFilter; and \c template \c struct \c DataPointsFiltersImpl::YourFilter;). - Add the constructor if needed. - At this stage, you should let the implementation of the filter function to hold only the statement that returns the input.