potok/opencv
1
0
Fork 0
mirror of https://github.com/opencv/opencv.git synced 2026-07-31 08:13:04 +04:00
Code Packages Releases Wiki Activity

New bunch of documentation fixes

Browse Source
This commit is contained in:
Andrey Kamaev
2012-05-28 14:36:15 +00:00
parent 4aaaef5967
commit 78329b0dfe
16 changed files with 328 additions and 272 deletions
Download Patch File Download Diff File Expand all files Collapse all files
modules/stitching/doc/exposure_compensation.rst
+11 -11
View File
@@ -3,9 +3,9 @@ Exposure Compensation
.. highlight:: cpp
detail::ExposureCompensation
detail::ExposureCompensator
----------------------------
.. ocv:class:: detail::ExposureCompensation
.. ocv:class:: detail::ExposureCompensator
Base class for all exposure compensators. ::
@@ -24,12 +24,12 @@ Base class for all exposure compensators. ::
virtual void apply(int index, Point corner, Mat &image, const Mat &mask) = 0;
};
detail::ExposureCompensation::feed
detail::ExposureCompensator::feed
----------------------------------
.. ocv:function:: void detail::ExposureCompensation::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<Mat> &images, const std::vector<Mat> &masks)
.. ocv:function:: void detail::ExposureCompensation::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<Mat> &images, const std::vector<std::pair<Mat,uchar> > &masks)
:param corners: Source image top-left corners
@@ -37,12 +37,12 @@ detail::ExposureCompensation::feed
: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
detil::ExposureCompensator::apply
----------------------------------
Compensate exposure in the specified image.
.. ocv:function:: void detail::ExposureCompensation::apply(int index, Point corner, Mat &image, const Mat &mask)
.. ocv:function:: void detail::ExposureCompensator::apply(int index, Point corner, Mat &image, const Mat &mask)
:param index: Image index
@@ -66,7 +66,7 @@ Stub exposure compensator which does nothing. ::
void apply(int /*index*/, Point /*corner*/, Mat &/*image*/, const Mat &/*mask*/) {};
};
.. seealso:: :ocv:class:`detail::ExposureCompensation`
.. seealso:: :ocv:class:`detail::ExposureCompensator`
detail::GainCompensator
-----------------------
@@ -86,7 +86,7 @@ Exposure compensator which tries to remove exposure related artifacts by adjusti
/* hidden */
};
.. seealso:: :ocv:class:`detail::ExposureCompensation`
.. seealso:: :ocv:class:`detail::ExposureCompensator`
detail::BlocksGainCompensator
-----------------------------
@@ -97,7 +97,7 @@ Exposure compensator which tries to remove exposure related artifacts by adjusti
class CV_EXPORTS BlocksGainCompensator : public ExposureCompensator
{
public:
BlocksGainCompensator(int bl_width = 32, int bl_height = 32)
BlocksGainCompensator(int bl_width = 32, int bl_height = 32)
: bl_width_(bl_width), bl_height_(bl_height) {}
void feed(const std::vector<Point> &corners, const std::vector<Mat> &images,
const std::vector<std::pair<Mat,uchar> > &masks);
@@ -107,5 +107,5 @@ Exposure compensator which tries to remove exposure related artifacts by adjusti
/* hidden */
};
.. seealso:: :ocv:class:`detail::ExposureCompensation`
.. seealso:: :ocv:class:`detail::ExposureCompensator`
modules/stitching/doc/motion_estimation.rst
-1
View File
@@ -221,7 +221,6 @@ Implementation of the camera parameters refinement algorithm which minimizes sum
detail::WaveCorrectKind
-----------------------
.. ocv:class:: detail::WaveCorrectKind
Wave correction kind. ::
modules/stitching/doc/warpers.rst
+13 -13
View File
@@ -20,7 +20,7 @@ Rotation-only model image warper interface. ::
virtual Point warp(const Mat &src, const Mat &K, const Mat &R, int interp_mode, int border_mode,
Mat &dst) = 0;
virtual void warpBackward(const Mat &src, const Mat &K, const Mat &R, int interp_mode, int border_mode,
Size dst_size, Mat &dst) = 0;
@@ -35,7 +35,7 @@ Projects the image point.
.. ocv:function:: Point2f detail::RotationWarper::warpPoint(const Point2f &pt, const Mat &K, const Mat &R)
:param pt: Source point
:param K: Camera intrinsic parameters
:param R: Camera rotation matrix
@@ -50,7 +50,7 @@ Builds the projection maps according to the given camera data.
.. ocv:function:: Rect detail::RotationWarper::buildMaps(Size src_size, const Mat &K, const Mat &R, Mat &xmap, Mat &ymap)
:param src_size: Source image size
:param K: Camera intrinsic parameters
:param R: Camera rotation matrix
@@ -69,7 +69,7 @@ Projects the image.
.. ocv:function:: Point detal::RotationWarper::warp(const Mat &src, const Mat &K, const Mat &R, int interp_mode, int border_mode, Mat &dst)
:param src: Source image
:param K: Camera intrinsic parameters
:param R: Camera rotation matrix
@@ -109,7 +109,7 @@ detail::RotationWarper::warpRoi
.. ocv:function:: Rect detail::RotationWarper::warpRoi(Size src_size, const Mat &K, const Mat &R)
:param src_size: Source image bounding box
:param K: Camera intrinsic parameters
:param R: Camera rotation matrix
@@ -124,8 +124,8 @@ Base class for warping logic implementation. ::
struct CV_EXPORTS ProjectorBase
{
void setCameraParams(const Mat &K = Mat::eye(3, 3, CV_32F),
const Mat &R = Mat::eye(3, 3, CV_32F),
void setCameraParams(const Mat &K = Mat::eye(3, 3, CV_32F),
const Mat &R = Mat::eye(3, 3, CV_32F),
const Mat &T = Mat::zeros(3, 1, CV_32F));
float scale;
@@ -144,10 +144,10 @@ Base class for rotation-based warper using a `detail::ProjectorBase`_ derived cl
template <class P>
class CV_EXPORTS RotationWarperBase : public RotationWarper
{
{
public:
Point2f warpPoint(const Point2f &pt, const Mat &K, const Mat &R);
Rect buildMaps(Size src_size, const Mat &K, const Mat &R, Mat &xmap, Mat &ymap);
Point warp(const Mat &src, const Mat &K, const Mat &R, int interp_mode, int border_mode,
@@ -232,13 +232,13 @@ Construct an instance of the spherical warper class.
.. ocv:function:: void detail::SphericalWarper::SphericalWarper(float scale)
:param scale: Projected image scale multiplier
detail::CylindricalWarper
-------------------------
.. ocv:class:: detail::CylindricalWarper : public RotationWarperBase<CylindricalProjector>
Warper that maps an image onto the x*x + z*z = 1 cylinder. ::
class CV_EXPORTS CylindricalWarper : public RotationWarperBase<CylindricalProjector>
{
public:
@@ -246,8 +246,8 @@ Warper that maps an image onto the x*x + z*z = 1 cylinder. ::
protected:
void detectResultRoi(Size src_size, Point &dst_tl, Point &dst_br)
{
RotationWarperBase<CylindricalProjector>::detectResultRoiByBorder(src_size, dst_tl, dst_br);
{
RotationWarperBase<CylindricalProjector>::detectResultRoiByBorder(src_size, dst_tl, dst_br);
}
};