Merge pull request #1554 from IshitaTakeshi/stereopoint-doc

borglab · Jun 28, 2023 · eb5604d · eb5604d
2 parents e444ee1 + 1de2602
commit eb5604d
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/gtsam/geometry/StereoPoint2.h b/gtsam/geometry/StereoPoint2.h
@@ -46,7 +46,9 @@ class GTSAM_EXPORT StereoPoint2 {
       uL_(0), uR_(0), v_(0) {
   }
 
-  /** constructor */
+  /** uL and uR represent the x-axis value of left and right frame coordinates respectively.
+      v represents the y coordinate value. The y-axis value should be the same under the
+      stereo constraint. */
   StereoPoint2(double uL, double uR, double v) :
       uL_(uL), uR_(uR), v_(v) {
   }