tapi: stitching: fix documentation
authorAlexander Alekhin <alexander.alekhin@itseez.com>
Mon, 17 Mar 2014 14:54:53 +0000 (18:54 +0400)
committerAndrey Pavlenko <andrey.pavlenko@itseez.com>
Fri, 11 Apr 2014 09:09:17 +0000 (13:09 +0400)
modules/stitching/doc/blenders.rst
modules/stitching/doc/exposure_compensation.rst
modules/stitching/doc/high_level.rst
modules/stitching/doc/matching.rst
modules/stitching/doc/seam_estimation.rst

index 031a326..39d9571 100644 (file)
@@ -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
 
index ec0d5db..b2778f1 100644 (file)
@@ -27,9 +27,9 @@ Base class for all exposure compensators. ::
 detail::ExposureCompensator::feed
 ----------------------------------
 
-.. ocv:function:: void detail::ExposureCompensator::feed(const std::vector<Point> &corners, const std::vector<Mat> &images, const std::vector<Mat> &masks)
+.. ocv:function:: void detail::ExposureCompensator::feed(const std::vector<Point> &corners, const std::vector<UMat> &images, const std::vector<UMat> &masks)
 
-.. ocv:function:: void detail::ExposureCompensator::feed(const std::vector<Point> &corners, const std::vector<Mat> &images, const std::vector<std::pair<Mat,uchar> > &masks)
+.. ocv:function:: void detail::ExposureCompensator::feed(const std::vector<Point> &corners, const std::vector<UMat> &images, const std::vector<std::pair<UMat,uchar> > &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
 
index 955f8f2..4cc5f99 100644 (file)
@@ -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<std::vector<Rect> > &rois)
+.. ocv:function:: Status Stitcher::estimateTransform(InputArrayOfArrays images, const std::vector<std::vector<Rect> > &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<std::vector<Rect> > &rois, OutputArray pano)
+.. ocv:function:: Status Stitcher::stitch(InputArrayOfArrays images, const std::vector<std::vector<Rect> > &rois, OutputArray pano)
 
     :param images: Input images.
 
index 2f9dabf..9f112d0 100644 (file)
@@ -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<cv::Rect> &rois)
+.. ocv:function:: void detail::FeaturesFinder::operator ()(InputArray image, ImageFeatures &features, const std::vector<cv::Rect> &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<ImageFeatures> & features, std::vector<MatchesInfo> & pairwise_matches, const Mat & mask=Mat() )
+.. ocv:function:: void detail::FeaturesMatcher::operator ()( const std::vector<ImageFeatures> & features, std::vector<MatchesInfo> & pairwise_matches, const UMat & mask=UMat() )
 
     :param features: Features of the source images
 
index 119fb1e..e7a3e47 100644 (file)
@@ -22,7 +22,7 @@ detail::SeamFinder::find
 
 Estimates seams.
 
-.. ocv:function:: void detail::SeamFinder::find(const std::vector<Mat> &src, const std::vector<Point> &corners, std::vector<Mat> &masks)
+.. ocv:function:: void detail::SeamFinder::find(const std::vector<UMat> &src, const std::vector<Point> &corners, std::vector<UMat> &masks)
 
     :param src: Source images