From 9187739d18ba9174d60f60f5b5fc8db1c8485dfd Mon Sep 17 00:00:00 2001 From: Alexey Spizhevoy Date: Thu, 26 Jan 2012 13:28:04 +0000 Subject: [PATCH] Updated the stitching module docs --- modules/stitching/doc/blenders.rst | 35 ++++++++++++++++++ .../stitching/doc/exposure_compensation.rst | 37 +++++++++++++++++++ modules/stitching/doc/seam_estimation.rst | 29 ++++++++++++++- 3 files changed, 100 insertions(+), 1 deletion(-) diff --git a/modules/stitching/doc/blenders.rst b/modules/stitching/doc/blenders.rst index e7da934cc..b1a9e702e 100644 --- a/modules/stitching/doc/blenders.rst +++ b/modules/stitching/doc/blenders.rst @@ -27,6 +27,41 @@ Base class for all blenders. :: Rect dst_roi_; }; +detail::Blender::prepare +------------------------ + +Prepares the blender for blending. + +.. ocv:function:: void detail::Blender::prepare(const std::vector &corners, const std::vector &sizes) + + :param corners: Source images top-left corners + + :param sizes: Source image sizes + +detail::Blender::feed +--------------------- + +Processes the image. + +.. ocv:function:: void detail::Blender::feed(const Mat &img, const Mat &mask, Point tl) + + :param img: Source image + + :param mask: Source image masks + + :param tl: Source image top-left corners + +detail::Blender::blend +---------------------- + +Blends and returns the final pano. + +.. ocv:function:: void detail::Blender::blend(Mat &dst, Mat &dst_mask) + + :param dst: Final pano + + :param dst_mask: Final pano mask + detail::FeatherBlender ---------------------- .. ocv:class:: detail::FeatherBlender diff --git a/modules/stitching/doc/exposure_compensation.rst b/modules/stitching/doc/exposure_compensation.rst index b4fb4b7a1..19e4eaa09 100644 --- a/modules/stitching/doc/exposure_compensation.rst +++ b/modules/stitching/doc/exposure_compensation.rst @@ -24,6 +24,43 @@ Base class for all exposure compensators. :: virtual void apply(int index, Point corner, Mat &image, const Mat &mask) = 0; }; +detail::ExposureCompensation::feed +---------------------------------- + +.. ocv:function:: void detail::ExposureCompensation::feed(const std::vector &corners, const std::vector &images, const std::vector &masks) + + :param corners: Source image top-left corners + + :param images: Source images + + :param masks: Image masks to update + +detail::ExposureCompensation::feed +---------------------------------- + +.. ocv:function:: void detail::ExposureCompensation::feed(const std::vector &corners, const std::vector &images, const std::vector > &masks) + + :param corners: Source image top-left corners + + :param images: Source images + + :param masks: Image masks to update (second value in pair specifies the value which should be used to detect where image is) + +detil::ExposureCompensation::apply +---------------------------------- + +Compensate exposure in the specified image. + +.. ocv:function:: void detail::ExposureCompensation::apply(int index, Point corner, Mat &image, const Mat &mask) + + :param index: Image index + + :param corner: Image top-left corner + + :param image: Image to process + + :param mask: Image mask + detail::NoExposureCompensator ----------------------------- .. ocv:class:: detail::NoExposureCompensator diff --git a/modules/stitching/doc/seam_estimation.rst b/modules/stitching/doc/seam_estimation.rst index 3beeafe2e..0ff4e54d1 100644 --- a/modules/stitching/doc/seam_estimation.rst +++ b/modules/stitching/doc/seam_estimation.rst @@ -7,7 +7,7 @@ detail::SeamFinder ------------------ .. ocv:class:: detail::SeamFinder -Base class for seam estimators. :: +Base class for a seam estimator. :: class CV_EXPORTS SeamFinder { @@ -17,6 +17,20 @@ Base class for seam estimators. :: std::vector &masks) = 0; }; +detail::SeamFinder::find +------------------------ + +Estimates seams. + +.. ocv:function:: void detail::SeamFinder::find(const std::vector &src, const std::vector &corners, std::vector &masks) + + :param src: Source images + + :param corners: Source image top-left corners + + :param masks: Source image masks to update + + detail::NoSeamFinder -------------------- .. ocv:class:: detail::NoSeamFinder @@ -55,6 +69,19 @@ Base class for all pairwise seam estimators. :: .. seealso:: :ocv:class:`detail::SeamFinder` +detail::PairwiseSeamFinder::findInPair +-------------------------------------- + +Resolves masks intersection of two specified images in the given ROI. + +.. ocv:function:: void detail::PairwiseSeamFinder::findInPair(size_t first, size_t second, Rect roi) + + :param first: First image index + + :param second: Second image index + + :param roi: Region of interest + detail::VoronoiSeamFinder ------------------------- .. ocv:class:: detail::VoronoiSeamFinder