Updated the stitching module docs

modules/stitching/doc/exposure_compensation.rst

@@ -81,7 +81,7 @@ detail::GainCompensator
 -----------------------
 .. ocv:class:: detail::GainCompensator
 
-Exposure compensator which tries to remove exposure related artifacts by adjusting image intensities. ::
+Exposure compensator which tries to remove exposure related artifacts by adjusting image intensities, see [BL07]_ and [WJ10]_ for details. ::
 
     class CV_EXPORTS GainCompensator : public ExposureCompensator
     {
@@ -92,7 +92,7 @@ Exposure compensator which tries to remove exposure related artifacts by adjusti
         std::vector<double> gains() const;
 
     private:
-        Mat_<double> gains_;
+        /* hidden */
     };
 
 .. seealso:: :ocv:class:`detail::ExposureCompensation`
@@ -101,7 +101,7 @@ detail::BlocksGainCompensator
 -----------------------------
 .. ocv:class:: detail::BlocksGainCompensator
 
-Exposure compensator which tries to remove exposure related artifacts by adjusting image block intensities. ::
+Exposure compensator which tries to remove exposure related artifacts by adjusting image block intensities, see [UES01]_ for details. ::
 
     class CV_EXPORTS BlocksGainCompensator : public ExposureCompensator
     {
@@ -113,8 +113,7 @@ Exposure compensator which tries to remove exposure related artifacts by adjusti
         void apply(int index, Point corner, Mat &image, const Mat &mask);
 
     private:
-        int bl_width_, bl_height_;
-        std::vector<Mat_<float> > gain_maps_;
+        /* hidden */
     };
 
 .. seealso:: :ocv:class:`detail::ExposureCompensation`

modules/stitching/doc/introduction.rst

@@ -5,6 +5,8 @@ Stitching Pipeline
 
 This figure illustrates the stitching module pipeline implemented in the :ocv:class:`Stitcher` class. Using that class it's possible to configure/remove some steps, i.e. adjust the stitching pipeline according to the particular needs. All building blocks from the pipeline are available in the ``detail`` namespace, one can combine and use them separately.
 
+The implemented stitching pipeline is very similar to the one proposed in [BL07]_.
+
 .. image:: StitchingPipeline.jpg
 
 References
@@ -20,4 +22,8 @@ References
 
 .. [V03] Vivek Kwatra, Arno Schödl, Irfan Essa, Greg Turk and Aaron Bobick. Graphcut Textures: Image and Video Synthesis Using Graph Cuts. To appear in Proc. ACM Transactions on Graphics, SIGGRAPH 2003.
 
+.. [UES01] M. Uyttendaele, A. Eden, and R. Szeliski. Eliminating ghosting and exposure artifacts in image mosaics. In Proc. CVPR’01, volume 2, pages 509–516, 2001
+
+.. [WJ10] Wei Xu and Jane Mulligan. Performance evaluation of color correction approaches for automatic multiview image and video stitching. In Intl. Conf on Computer Vision and Pattern Recognition (CVPR10), San Francisco, CA, 2010
+
 .. [BA83] Burt, P., and Adelson, E. H., A Multiresolution Spline with Application to Image Mosaics. ACM Transactions on Graphics, 2(4):217-236, 1983.

modules/stitching/doc/seam_estimation.rst

@@ -103,7 +103,7 @@ detail::GraphCutSeamFinderBase
 ------------------------------
 .. ocv:class:: detail::GraphCutSeamFinderBase
 
-Base class for all minimum graph cut-based seam estimators. ::
+Base class for all minimum graph-cut-based seam estimators. ::
 
     class CV_EXPORTS GraphCutSeamFinderBase
     {
@@ -115,7 +115,7 @@ detail::GraphCutSeamFinder
 --------------------------
 .. ocv:class:: detail::GraphCutSeamFinder
 
-Minimum graph cut-based seam estimator. ::
+Minimum graph cut-based seam estimator. See details in [V03]_. ::
 
     class CV_EXPORTS GraphCutSeamFinder : public GraphCutSeamFinderBase, public SeamFinder
     {

modules/stitching/doc/warpers.rst

@@ -198,6 +198,15 @@ Warper that maps an image onto the z = 1 plane. ::
 
 .. seealso:: :ocv:class:`detail::RotationWarper`
 
+detail::PlaneWarper::PlaneWarper
+--------------------------------
+
+Construct an instance of the plane warper class.
+
+.. ocv:function:: void detail::PlaneWarper::PlaneWarper(float scale = 1.f)
+
+    :param scale: Projected image scale multiplier
+
 detail::SphericalWarper
 -----------------------
 .. ocv:class:: detail::SphericalWarper
@@ -214,6 +223,15 @@ Warper that maps an image onto the unit sphere located at the origin. ::
     };
 
 .. seealso:: :ocv:class:`detail::RotationWarper`
+
+detail::SphericalWarper::SphericalWarper
+----------------------------------------
+
+Construct an instance of the spherical warper class.
+
+.. ocv:function:: void detail::SphericalWarper::SphericalWarper(float scale)
+
+    :param scale: Projected image scale multiplier
    
 detail::CylindricalWarper
 -------------------------
@@ -235,3 +253,11 @@ Warper that maps an image onto the x*x + z*z = 1 cylinder. ::
 
 .. seealso:: :ocv:class:`detail::RotationWarper`
 
+detail::CylindricalWarper::CylindricalWarper
+--------------------------------------------
+
+Construct an instance of the cylindrical warper class.
+
+.. ocv:function:: void detail::CylindricalWarper::CylindricalWarper(float scale)
+
+    :param scale: Projected image scale multiplier