Merge pull request #5818 from themightyoarfish/organized-neihgbour-doc

update doc for OrganizedNeighnor
PointCloudLibrary · Sep 27, 2023 · b66f8b8 · b66f8b8
2 parents 7cc21f7 + 77c628f
commit b66f8b8
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/search/include/pcl/search/organized.h b/search/include/pcl/search/organized.h
@@ -52,10 +52,14 @@ namespace pcl
 {
   namespace search
   {
-    /** \brief OrganizedNeighbor is a class for optimized nearest neighbor search in organized point clouds.
-      * \author Radu B. Rusu, Julius Kammerl, Suat Gedikli, Koen Buys
-      * \ingroup search
-      */
+    /** \brief OrganizedNeighbor is a class for optimized nearest neighbor search in
+     * organized projectable point clouds, for instance from Time-Of-Flight cameras or
+     * stereo cameras. Note that rotating LIDARs may output organized clouds, but are
+     * not projectable via a pinhole camera model into two dimensions and thus will
+     * generally not work with this class.
+     * \author Radu B. Rusu, Julius Kammerl, Suat Gedikli, Koen Buys
+     * \ingroup search
+     */
     template<typename PointT>
     class OrganizedNeighbor : public pcl::search::Search<PointT>
     {