Updated the stitching module docs
authorAlexey Spizhevoy <no@email>
Thu, 26 Jan 2012 13:28:04 +0000 (13:28 +0000)
committerAlexey Spizhevoy <no@email>
Thu, 26 Jan 2012 13:28:04 +0000 (13:28 +0000)
modules/stitching/doc/blenders.rst
modules/stitching/doc/exposure_compensation.rst
modules/stitching/doc/seam_estimation.rst

index e7da934..b1a9e70 100644 (file)
@@ -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<Point> &corners, const std::vector<Size> &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
index b4fb4b7..19e4eaa 100644 (file)
@@ -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<Point> &corners, const std::vector<Mat> &images, const std::vector<Mat> &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<Point> &corners, const std::vector<Mat> &images, const std::vector<std::pair<Mat,uchar> > &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
index 3beeafe..0ff4e54 100644 (file)
@@ -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<Mat> &masks) = 0;
     };
 
+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)
+
+    :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