pcl icon indicating copy to clipboard operation
pcl copied to clipboard

[CorrespondenceEstimation] There may be something wrong with the annotation

Open QiuYilin opened this issue 9 months ago • 2 comments

https://github.com/PointCloudLibrary/pcl/blob/master/registration/include/pcl/registration/correspondence_estimation.h#L386

It says "CorrespondenceEstimation represents the base class for determining correspondences between target and query point sets/features.", but CorrespondenceEstimation does not have subclasses. Instead, it has a base class named CorrespondenceEstimationBase.

QiuYilin avatar May 17 '24 02:05 QiuYilin

Yeah, that might be a bit confusing. CorrespondenceEstimationBase is abstract (so not usable by itself) and the base class/parent class of four non-abstract correspondence estimation methods, including CorrespondenceEstimation. CorrespondenceEstimation is probably the most "basic" or "simple" of the four correspondence estimation methods. See also the inheritance diagram at https://pointclouds.org/documentation/classpcl_1_1registration_1_1_correspondence_estimation_base.html

mvieth avatar May 17 '24 11:05 mvieth

Then I think modifying this comment would make the meaning clearer. As you said, change it to "CorrespondenceEstimation represents the basic/simple class for determining correspondences between target and query point sets/features". And It would be best if there is also an explanation of the basic principles "For each point in the source point cloud, find the closest point in the target point cloud (usually using KD-tree or other acceleration structures).".

QiuYilin avatar May 20 '24 01:05 QiuYilin