update the docstring

release/4.3a0
John Lambert 2021-03-03 00:21:54 -05:00
parent b839444d17
commit 7604633c43
1 changed files with 4 additions and 2 deletions

View File

@ -125,8 +125,10 @@ public:
GTSAM_UNSTABLE_EXPORT static Similarity3 Align(const std::vector<Point3Pair>& abPointPairs);
/**
* Create Similarity3 by aligning at least two pose pairs
*
* 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);