Added a helpful comment on the scale parameter of the spherical
authoremiswelt <emiswelt@gmail.com>
Tue, 19 Jan 2016 15:39:07 +0000 (15:39 +0000)
committeremiswelt <emiswelt@gmail.com>
Tue, 19 Jan 2016 15:39:07 +0000 (15:39 +0000)
warper.

modules/stitching/include/opencv2/stitching/detail/warpers.hpp

index ee8e824cbf1aa7b388b8ff77cf42e13cd38f7f54..2327699f8f88411c53af7b5fc7ae8527f77e0174 100644 (file)
@@ -214,7 +214,8 @@ struct CV_EXPORTS SphericalProjector : ProjectorBase
 
 /** @brief Warper that maps an image onto the unit sphere located at the origin.
 
- Projects image onto unit sphere with origin at (0, 0, 0).
+ Projects image onto unit sphere with origin at (0, 0, 0) and radius scale, measured in pixels. 
+ A 360° panorama would therefore have a resulting width of 2 * scale * PI pixels. 
  Poles are located at (0, -1, 0) and (0, 1, 0) points.
 */
 class CV_EXPORTS SphericalWarper : public RotationWarperBase<SphericalProjector>
@@ -222,7 +223,8 @@ class CV_EXPORTS SphericalWarper : public RotationWarperBase<SphericalProjector>
 public:
     /** @brief Construct an instance of the spherical warper class.
 
-    @param scale Projected image scale multiplier
+    @param scale Radius of the projected sphere, in pixels. An image spanning the
+                 whole sphere will have a width of 2 * scale * PI pixels.  
      */
     SphericalWarper(float scale) { projector_.scale = scale; }