diff options
author | Campbell Barton <ideasman42@gmail.com> | 2020-11-06 06:35:38 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2020-11-06 06:35:38 +0300 |
commit | 605425c0063f2e357df5a00056c2ca3439e46533 (patch) | |
tree | 33f3e57300ab54877984758c9675ddc6c4ef378a /intern/libmv | |
parent | eed6bf22a4f74136cd10159ea32b788ae93d7850 (diff) |
Cleanup: doxygen comments
Diffstat (limited to 'intern/libmv')
-rw-r--r-- | intern/libmv/libmv/multiview/homography.h | 34 | ||||
-rw-r--r-- | intern/libmv/libmv/simple_pipeline/keyframe_selection.h | 10 |
2 files changed, 24 insertions, 20 deletions
diff --git a/intern/libmv/libmv/multiview/homography.h b/intern/libmv/libmv/multiview/homography.h index 6d810c845ed..a76aa9405a5 100644 --- a/intern/libmv/libmv/multiview/homography.h +++ b/intern/libmv/libmv/multiview/homography.h @@ -27,21 +27,23 @@ namespace libmv { /** * 2D homography transformation estimation. - * + * * This function estimates the homography transformation from a list of 2D * correspondences which represents either: * * - 3D points on a plane, with a general moving camera. * - 3D points with a rotating camera (pure rotation). * - 3D points + different planar projections - * - * \param x1 The first 2xN or 3xN matrix of euclidean or homogeneous points. - * \param x2 The second 2xN or 3xN matrix of euclidean or homogeneous points. - * \param H The 3x3 homography transformation matrix (8 dof) such that - * x2 = H * x1 with |a b c| - * H = |d e f| - * |g h 1| - * \param expected_precision The expected precision in order for instance + * + * \param x1: The first 2xN or 3xN matrix of euclidean or homogeneous points. + * \param x2: The second 2xN or 3xN matrix of euclidean or homogeneous points. + * \param H: The 3x3 homography transformation matrix (8 dof) such that + * <pre> + * x2 = H * x1 with |a b c| + * H = |d e f| + * |g h 1| + * </pre> + * \param expected_precision: The expected precision in order for instance * to accept almost homography matrices. * * \return True if the transformation estimation has succeeded. @@ -113,16 +115,18 @@ bool EstimateHomography2DFromCorrespondences( * \param[in] x1 The first 4xN matrix of homogeneous points * \param[in] x2 The second 4xN matrix of homogeneous points * \param[out] H The 4x4 homography transformation matrix (15 dof) such that - * x2 = H * x1 with |a b c d| - * H = |e f g h| - * |i j k l| - * |m n o 1| - * \param[in] expected_precision The expected precision in order for instance + * <pre> + * x2 = H * x1 with |a b c d| + * H = |e f g h| + * |i j k l| + * |m n o 1| + * </pre> + * \param[in] expected_precision The expected precision in order for instance * to accept almost homography matrices. * * \return true if the transformation estimation has succeeded * - * \note Need at least 5 non coplanar points + * \note Need at least 5 non coplanar points * \note Points coordinates must be in homogeneous coordinates */ bool Homography3DFromCorrespondencesLinear(const Mat &x1, diff --git a/intern/libmv/libmv/simple_pipeline/keyframe_selection.h b/intern/libmv/libmv/simple_pipeline/keyframe_selection.h index aa3eeaf193d..25253af32fe 100644 --- a/intern/libmv/libmv/simple_pipeline/keyframe_selection.h +++ b/intern/libmv/libmv/simple_pipeline/keyframe_selection.h @@ -38,11 +38,11 @@ namespace libmv { // and if expected error estimation is too large, keyframe candidate // is rejecting. // -// \param tracks contains all tracked correspondences between frames -// expected to be undistorted and normalized -// \param intrinsics is camera intrinsics -// \param keyframes will contain all images number which are considered -// good to be used for reconstruction +// \param tracks: contains all tracked correspondences between frames +// expected to be undistorted and normalized. +// \param intrinsics: is camera intrinsics. +// \param keyframes: will contain all images number which are considered +// good to be used for reconstruction. void SelectKeyframesBasedOnGRICAndVariance( const Tracks &tracks, const CameraIntrinsics &intrinsics, |