From 588658d1a3f16ef9c61fa71b5d2ef0630030dbf4 Mon Sep 17 00:00:00 2001 From: Alexander Alekhin Date: Mon, 17 Mar 2014 18:54:53 +0400 Subject: [PATCH] tapi: stitching: fix documentation --- modules/stitching/doc/blenders.rst | 4 ++-- modules/stitching/doc/exposure_compensation.rst | 6 +++--- modules/stitching/doc/high_level.rst | 10 +++++----- modules/stitching/doc/matching.rst | 8 ++++---- modules/stitching/doc/seam_estimation.rst | 2 +- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/modules/stitching/doc/blenders.rst b/modules/stitching/doc/blenders.rst index 031a326649..39d9571c3a 100644 --- a/modules/stitching/doc/blenders.rst +++ b/modules/stitching/doc/blenders.rst @@ -43,7 +43,7 @@ detail::Blender::feed Processes the image. -.. ocv:function:: void detail::Blender::feed(const Mat &img, const Mat &mask, Point tl) +.. ocv:function:: void detail::Blender::feed(InputArray img, InputArray mask, Point tl) :param img: Source image @@ -56,7 +56,7 @@ detail::Blender::blend Blends and returns the final pano. -.. ocv:function:: void detail::Blender::blend(Mat &dst, Mat &dst_mask) +.. ocv:function:: void detail::Blender::blend(InputOutputArray dst, InputOutputArray dst_mask) :param dst: Final pano diff --git a/modules/stitching/doc/exposure_compensation.rst b/modules/stitching/doc/exposure_compensation.rst index ec0d5db325..b2778f1249 100644 --- a/modules/stitching/doc/exposure_compensation.rst +++ b/modules/stitching/doc/exposure_compensation.rst @@ -27,9 +27,9 @@ Base class for all exposure compensators. :: detail::ExposureCompensator::feed ---------------------------------- -.. ocv:function:: void detail::ExposureCompensator::feed(const std::vector &corners, const std::vector &images, const std::vector &masks) +.. ocv:function:: void detail::ExposureCompensator::feed(const std::vector &corners, const std::vector &images, const std::vector &masks) -.. ocv:function:: void detail::ExposureCompensator::feed(const std::vector &corners, const std::vector &images, const std::vector > &masks) +.. ocv:function:: void detail::ExposureCompensator::feed(const std::vector &corners, const std::vector &images, const std::vector > &masks) :param corners: Source image top-left corners @@ -42,7 +42,7 @@ detil::ExposureCompensator::apply Compensate exposure in the specified image. -.. ocv:function:: void detail::ExposureCompensator::apply(int index, Point corner, Mat &image, const Mat &mask) +.. ocv:function:: void detail::ExposureCompensator::apply(int index, Point corner, InputOutputArray image, InputArray mask) :param index: Image index diff --git a/modules/stitching/doc/high_level.rst b/modules/stitching/doc/high_level.rst index 955f8f2481..4cc5f9914d 100644 --- a/modules/stitching/doc/high_level.rst +++ b/modules/stitching/doc/high_level.rst @@ -110,9 +110,9 @@ These functions try to match the given images and to estimate rotations of each .. note:: Use the functions only if you're aware of the stitching pipeline, otherwise use :ocv:func:`Stitcher::stitch`. -.. ocv:function:: Status Stitcher::estimateTransform(InputArray images) +.. ocv:function:: Status Stitcher::estimateTransform(InputArrayOfArrays images) -.. ocv:function:: Status Stitcher::estimateTransform(InputArray images, const std::vector > &rois) +.. ocv:function:: Status Stitcher::estimateTransform(InputArrayOfArrays images, const std::vector > &rois) :param images: Input images. @@ -129,7 +129,7 @@ These functions try to compose the given images (or images stored internally fro .. ocv:function:: Status Stitcher::composePanorama(OutputArray pano) -.. ocv:function:: Status Stitcher::composePanorama(InputArray images, OutputArray pano) +.. ocv:function:: Status Stitcher::composePanorama(InputArrayOfArrays images, OutputArray pano) :param images: Input images. @@ -142,9 +142,9 @@ Stitcher::stitch These functions try to stitch the given images. -.. ocv:function:: Status Stitcher::stitch(InputArray images, OutputArray pano) +.. ocv:function:: Status Stitcher::stitch(InputArrayOfArrays images, OutputArray pano) -.. ocv:function:: Status Stitcher::stitch(InputArray images, const std::vector > &rois, OutputArray pano) +.. ocv:function:: Status Stitcher::stitch(InputArrayOfArrays images, const std::vector > &rois, OutputArray pano) :param images: Input images. diff --git a/modules/stitching/doc/matching.rst b/modules/stitching/doc/matching.rst index 2f9dabf728..9f112d0a0e 100644 --- a/modules/stitching/doc/matching.rst +++ b/modules/stitching/doc/matching.rst @@ -40,9 +40,9 @@ detail::FeaturesFinder::operator() Finds features in the given image. -.. ocv:function:: void detail::FeaturesFinder::operator ()(const Mat &image, ImageFeatures &features) +.. ocv:function:: void detail::FeaturesFinder::operator ()(InputArray image, ImageFeatures &features) -.. ocv:function:: void detail::FeaturesFinder::operator ()(const Mat &image, ImageFeatures &features, const std::vector &rois) +.. ocv:function:: void detail::FeaturesFinder::operator ()(InputArray image, ImageFeatures &features, const std::vector &rois) :param image: Source image @@ -64,7 +64,7 @@ detail::FeaturesFinder::find This method must implement features finding logic in order to make the wrappers `detail::FeaturesFinder::operator()`_ work. -.. ocv:function:: void detail::FeaturesFinder::find(const Mat &image, ImageFeatures &features) +.. ocv:function:: void detail::FeaturesFinder::find(InputArray image, ImageFeatures &features) :param image: Source image @@ -171,7 +171,7 @@ Performs images matching. :param matches_info: Found matches -.. ocv:function:: void detail::FeaturesMatcher::operator ()( const std::vector & features, std::vector & pairwise_matches, const Mat & mask=Mat() ) +.. ocv:function:: void detail::FeaturesMatcher::operator ()( const std::vector & features, std::vector & pairwise_matches, const UMat & mask=UMat() ) :param features: Features of the source images diff --git a/modules/stitching/doc/seam_estimation.rst b/modules/stitching/doc/seam_estimation.rst index 119fb1e158..e7a3e47b29 100644 --- a/modules/stitching/doc/seam_estimation.rst +++ b/modules/stitching/doc/seam_estimation.rst @@ -22,7 +22,7 @@ detail::SeamFinder::find Estimates seams. -.. ocv:function:: void detail::SeamFinder::find(const std::vector &src, const std::vector &corners, std::vector &masks) +.. ocv:function:: void detail::SeamFinder::find(const std::vector &src, const std::vector &corners, std::vector &masks) :param src: Source images