update the docstring

2021-03-03 00:21:54 -05:00 · 2021-03-03 00:21:54 -05:00 · 7604633c43
parent b839444d17
commit 7604633c43
1 changed files with 4 additions and 2 deletions
--- a/gtsam/geometry/Similarity3.h
+++ b/gtsam/geometry/Similarity3.h
@ -126,7 +126,9 @@ public:
  
  /**
   * Create Similarity3 by aligning at least two pose pairs
-   * 
+   * Given a list of pairs in world frame w1, and a list of pairs in another world
+   * frame w2, will compute the best-fit Similarity3 transformation to align them.
+   * `w2Sw1` will returned for pairs [ (w2Ti1,w1Ti1), (w2Ti2,w1Ti2), (w2Ti3,w1Ti3) ]
   */
  GTSAM_UNSTABLE_EXPORT static Similarity3 Align(const std::vector<Pose3Pair>& abPosePairs);