From cc3b2f619740c933a1d8376045e2b455966f9a69 Mon Sep 17 00:00:00 2001 From: emiswelt Date: Tue, 19 Jan 2016 15:39:07 +0000 Subject: [PATCH] Added a helpful comment on the scale parameter of the spherical warper. --- .../stitching/include/opencv2/stitching/detail/warpers.hpp | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/modules/stitching/include/opencv2/stitching/detail/warpers.hpp b/modules/stitching/include/opencv2/stitching/detail/warpers.hpp index ee8e824cbf..2327699f8f 100644 --- a/modules/stitching/include/opencv2/stitching/detail/warpers.hpp +++ b/modules/stitching/include/opencv2/stitching/detail/warpers.hpp @@ -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 @@ -222,7 +223,8 @@ class CV_EXPORTS SphericalWarper : public RotationWarperBase 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; }