From bee271a15c4d5583c434ad014a5ce30561922d1a Mon Sep 17 00:00:00 2001 From: Alexey Spizhevoy Date: Thu, 26 Jan 2012 12:02:45 +0000 Subject: [PATCH] Updated the stitching module docs --- modules/stitching/doc/motion_estimation.rst | 40 +++++++++++++++++++++++++++-- 1 file changed, 38 insertions(+), 2 deletions(-) diff --git a/modules/stitching/doc/motion_estimation.rst b/modules/stitching/doc/motion_estimation.rst index cb0d5f3..6e80733 100644 --- a/modules/stitching/doc/motion_estimation.rst +++ b/modules/stitching/doc/motion_estimation.rst @@ -136,6 +136,8 @@ Base class for all camera parameters refinement methods. :: std::vector > edges_; }; +.. seealso:: :ocv:class:`detail::Estimator` + detail::BundleAdjusterBase::BundleAdjusterBase ---------------------------------------------- @@ -147,6 +149,42 @@ Construct a bundle adjuster base instance. :param num_errs_per_measurement: Number of error terms (components) per match +detail::BundleAdjusterBase::setUpInitialCameraParams +---------------------------------------------------- + +Sets initial camera parameter to refine. + +.. ocv:function:: void detail::BundleAdjusterBase::setUpInitialCameraParams(const std::vector &cameras) = 0; + + :param cameras: Camera parameters + +detail::BundleAdjusterBase::calcError +------------------------------------- + +Calculates error vector. + +.. ocv:function:: void detail::BundleAdjusterBase::calcError(Mat &err) = 0; + + :param err: Error column-vector of length ``total_num_matches * num_errs_per_measurement`` + +detail::BundleAdjusterBase::calcJacobian +---------------------------------------- + +Calculates the cost function jacobian. + +.. ocv:function:: void detail::BundleAdjusterBase::calcJacobian(Mat &jac) = 0; + + :param jac: Jacobian matrix of dimensions ``(total_num_matches * num_errs_per_measurement) x (num_images * num_params_per_cam)`` + +detail::BundleAdjusterBase::obtainRefinedCameraParams +----------------------------------------------------- + +Gets the refined camera parameters. + +.. ocv:function:: void detail::BundleAdjusterBase::obtainRefinedCameraParams(std::vector &cameras) const = 0; + + :param cameras: Refined camera parameters + detail::BundleAdjusterReproj ---------------------------- .. ocv:class:: detail::BundleAdjusterReproj @@ -201,5 +239,3 @@ Tries to make panorama more horizontal (or verical). :param rmats: Camera rotation matrices. :param kind: Correction kind, see :ocv:class:`detail::WaveCorrectKind`. - - -- 2.7.4