mirror/opencv
1
0
Fork 0
mirror of https://github.com/opencv/opencv.git synced 2025-06-12 20:42:53 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #9979 from fakabbir:ImproveDoc

Browse Source 
* Improve Documentation
Fixes Spelling Mistakes.
This commit is contained in:
Fakabbir Amin 2017-11-08 22:25:48 +05:30 committed by Alexander Alekhin
parent 22dfc1daf1
commit a0c658b012
4 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
modules/calib3d/include/opencv2/calib3d.hpp
View File

@ -396,7 +396,7 @@ and a rotation matrix.
It optionally returns three rotation matrices, one for each axis, and the three Euler angles in It optionally returns three rotation matrices, one for each axis, and the three Euler angles in
degrees (as the return value) that could be used in OpenGL. Note, there is always more than one degrees (as the return value) that could be used in OpenGL. Note, there is always more than one
sequence of rotations about the three principal axes that results in the same orientation of an sequence of rotations about the three principal axes that results in the same orientation of an
object, eg. see @cite Slabaugh . Returned tree rotation matrices and corresponding three Euler angles object, e.g. see @cite Slabaugh . Returned tree rotation matrices and corresponding three Euler angles
are only one of the possible solutions. are only one of the possible solutions.
*/ */
CV_EXPORTS_W Vec3d RQDecomp3x3( InputArray src, OutputArray mtxR, OutputArray mtxQ, CV_EXPORTS_W Vec3d RQDecomp3x3( InputArray src, OutputArray mtxR, OutputArray mtxQ,
@ -421,8 +421,8 @@ matrix and the position of a camera.
It optionally returns three rotation matrices, one for each axis, and three Euler angles that could It optionally returns three rotation matrices, one for each axis, and three Euler angles that could
be used in OpenGL. Note, there is always more than one sequence of rotations about the three be used in OpenGL. Note, there is always more than one sequence of rotations about the three
principal axes that results in the same orientation of an object, eg. see @cite Slabaugh . Returned principal axes that results in the same orientation of an object, e.g. see @cite Slabaugh . Returned
tree rotation matrices and corresponding three Euler angules are only one of the possible solutions. tree rotation matrices and corresponding three Euler angles are only one of the possible solutions.
The function is based on RQDecomp3x3 . The function is based on RQDecomp3x3 .
*/ */
@ -1205,7 +1205,7 @@ findFundamentalMat .
@param threshold Optional threshold used to filter out the outliers. If the parameter is greater @param threshold Optional threshold used to filter out the outliers. If the parameter is greater
than zero, all the point pairs that do not comply with the epipolar geometry (that is, the points than zero, all the point pairs that do not comply with the epipolar geometry (that is, the points
for which \f$|\texttt{points2[i]}^T*\texttt{F}*\texttt{points1[i]}|>\texttt{threshold}\f$ ) are for which \f$|\texttt{points2[i]}^T*\texttt{F}*\texttt{points1[i]}|>\texttt{threshold}\f$ ) are
rejected prior to computing the homographies. Otherwise,all the points are considered inliers. rejected prior to computing the homographies. Otherwise, all the points are considered inliers.
The function computes the rectification transformations without knowing intrinsic parameters of the The function computes the rectification transformations without knowing intrinsic parameters of the
cameras and their relative position in the space, which explains the suffix "uncalibrated". Another cameras and their relative position in the space, which explains the suffix "uncalibrated". Another
@ -1249,7 +1249,7 @@ assumed.
@param alpha Free scaling parameter between 0 (when all the pixels in the undistorted image are @param alpha Free scaling parameter between 0 (when all the pixels in the undistorted image are
valid) and 1 (when all the source image pixels are retained in the undistorted image). See valid) and 1 (when all the source image pixels are retained in the undistorted image). See
stereoRectify for details. stereoRectify for details.
@param newImgSize Image size after rectification. By default,it is set to imageSize . @param newImgSize Image size after rectification. By default, it is set to imageSize .
@param validPixROI Optional output rectangle that outlines all-good-pixels region in the @param validPixROI Optional output rectangle that outlines all-good-pixels region in the
undistorted image. See roi1, roi2 description in stereoRectify . undistorted image. See roi1, roi2 description in stereoRectify .
@param centerPrincipalPoint Optional flag that indicates whether in the new camera matrix the @param centerPrincipalPoint Optional flag that indicates whether in the new camera matrix the
@ -1260,7 +1260,7 @@ best fit a subset of the source image (determined by alpha) to the corrected ima
The function computes and returns the optimal new camera matrix based on the free scaling parameter. The function computes and returns the optimal new camera matrix based on the free scaling parameter.
By varying this parameter, you may retrieve only sensible pixels alpha=0 , keep all the original By varying this parameter, you may retrieve only sensible pixels alpha=0 , keep all the original
image pixels if there is valuable information in the corners alpha=1 , or get something in between. image pixels if there is valuable information in the corners alpha=1 , or get something in between.
When alpha\>0 , the undistortion result is likely to have some black pixels corresponding to When alpha\>0 , the undistorted result is likely to have some black pixels corresponding to
"virtual" pixels outside of the captured distorted image. The original camera matrix, distortion "virtual" pixels outside of the captured distorted image. The original camera matrix, distortion
coefficients, the computed new camera matrix, and newImageSize should be passed to coefficients, the computed new camera matrix, and newImageSize should be passed to
initUndistortRectifyMap to produce the maps for remap . initUndistortRectifyMap to produce the maps for remap .
@ -1456,7 +1456,7 @@ floating-point (single or double precision).
Note that this function assumes that points1 and points2 are feature points from cameras with the Note that this function assumes that points1 and points2 are feature points from cameras with the
same camera matrix. same camera matrix.
@param R Recovered relative rotation. @param R Recovered relative rotation.
@param t Recoverd relative translation. @param t Recovered relative translation.
@param mask Input/output mask for inliers in points1 and points2. @param mask Input/output mask for inliers in points1 and points2.
: If it is not empty, then it marks inliers in points1 and points2 for then given essential : If it is not empty, then it marks inliers in points1 and points2 for then given essential
matrix E. Only these inliers will be used to recover pose. In the output mask only inliers matrix E. Only these inliers will be used to recover pose. In the output mask only inliers
@ -1499,7 +1499,7 @@ CV_EXPORTS_W int recoverPose( InputArray E, InputArray points1, InputArray point
floating-point (single or double precision). floating-point (single or double precision).
@param points2 Array of the second image points of the same size and format as points1 . @param points2 Array of the second image points of the same size and format as points1 .
@param R Recovered relative rotation. @param R Recovered relative rotation.
@param t Recoverd relative translation. @param t Recovered relative translation.
@param focal Focal length of the camera. Note that this function assumes that points1 and points2 @param focal Focal length of the camera. Note that this function assumes that points1 and points2
are feature points from cameras with same focal length and principal point. are feature points from cameras with same focal length and principal point.
@param pp principal point of the camera. @param pp principal point of the camera.
@ -1532,7 +1532,7 @@ floating-point (single or double precision).
Note that this function assumes that points1 and points2 are feature points from cameras with the Note that this function assumes that points1 and points2 are feature points from cameras with the
same camera matrix. same camera matrix.
@param R Recovered relative rotation. @param R Recovered relative rotation.
@param t Recoverd relative translation. @param t Recovered relative translation.
@param distanceThresh threshold distance which is used to filter out far away points (i.e. infinite points). @param distanceThresh threshold distance which is used to filter out far away points (i.e. infinite points).
@param mask Input/output mask for inliers in points1 and points2. @param mask Input/output mask for inliers in points1 and points2.
: If it is not empty, then it marks inliers in points1 and points2 for then given essential : If it is not empty, then it marks inliers in points1 and points2 for then given essential

8
modules/imgproc/include/opencv2/imgproc.hpp
View File

@ -1257,7 +1257,7 @@ to edit those, as to tailor it for their own application.
@param _sigma_scale Sigma for Gaussian filter. It is computed as sigma = _sigma_scale/_scale. @param _sigma_scale Sigma for Gaussian filter. It is computed as sigma = _sigma_scale/_scale.
@param _quant Bound to the quantization error on the gradient norm. @param _quant Bound to the quantization error on the gradient norm.
@param _ang_th Gradient angle tolerance in degrees. @param _ang_th Gradient angle tolerance in degrees.
@param _log_eps Detection threshold: -log10(NFA) \> log_eps. Used only when advancent refinement @param _log_eps Detection threshold: -log10(NFA) \> log_eps. Used only when advance refinement
is chosen. is chosen.
@param _density_th Minimal density of aligned region points in the enclosing rectangle. @param _density_th Minimal density of aligned region points in the enclosing rectangle.
@param _n_bins Number of bins in pseudo-ordering of gradient modulus. @param _n_bins Number of bins in pseudo-ordering of gradient modulus.
@ -1699,7 +1699,7 @@ CV_EXPORTS_W void Laplacian( InputArray src, OutputArray dst, int ddepth,
/** @brief Finds edges in an image using the Canny algorithm @cite Canny86 . /** @brief Finds edges in an image using the Canny algorithm @cite Canny86 .
The function finds edges in the input image image and marks them in the output map edges using the The function finds edges in the input image and marks them in the output map edges using the
Canny algorithm. The smallest value between threshold1 and threshold2 is used for edge linking. The Canny algorithm. The smallest value between threshold1 and threshold2 is used for edge linking. The
largest value is used to find initial segments of strong edges. See largest value is used to find initial segments of strong edges. See
<http://en.wikipedia.org/wiki/Canny_edge_detector> <http://en.wikipedia.org/wiki/Canny_edge_detector>
@ -2352,7 +2352,7 @@ borderMode=BORDER_TRANSPARENT, it means that the pixels in the destination image
corresponds to the "outliers" in the source image are not modified by the function. corresponds to the "outliers" in the source image are not modified by the function.
@param borderValue Value used in case of a constant border. By default, it is 0. @param borderValue Value used in case of a constant border. By default, it is 0.
@note @note
Due to current implementaion limitations the size of an input and output images should be less than 32767x32767. Due to current implementation limitations the size of an input and output images should be less than 32767x32767.
*/ */
CV_EXPORTS_W void remap( InputArray src, OutputArray dst, CV_EXPORTS_W void remap( InputArray src, OutputArray dst,
InputArray map1, InputArray map2, InputArray map1, InputArray map2,
@ -4212,7 +4212,7 @@ intersecting region and the red vertices are returned by the function.
@param rect1 First rectangle @param rect1 First rectangle
@param rect2 Second rectangle @param rect2 Second rectangle
@param intersectingRegion The output array of the verticies of the intersecting region. It returns @param intersectingRegion The output array of the vertices of the intersecting region. It returns
at most 8 vertices. Stored as std::vector\<cv::Point2f\> or cv::Mat as Mx1 of type CV_32FC2. at most 8 vertices. Stored as std::vector\<cv::Point2f\> or cv::Mat as Mx1 of type CV_32FC2.
@returns One of cv::RectanglesIntersectTypes @returns One of cv::RectanglesIntersectTypes
*/ */

2
modules/videostab/include/opencv2/videostab/global_motion.hpp
View File

@ -288,7 +288,7 @@ private:
@param from Source frame index. @param from Source frame index.
@param to Destination frame index. @param to Destination frame index.
@param motions Pair-wise motions. motions[i] denotes motion from the frame i to the frame i+1 @param motions Pair-wise motions. motions[i] denotes motion from the frame i to the frame i+1
@return Motion from the frame from to the frame to. @return Motion from the Source frame to the Destination frame.
*/ */
CV_EXPORTS Mat getMotion(int from, int to, const std::vector<Mat> &motions); CV_EXPORTS Mat getMotion(int from, int to, const std::vector<Mat> &motions);

2
modules/viz/src/widget.cpp
View File

@ -227,7 +227,7 @@ double cv::viz::Widget::getRenderingProperty(int property) const
} }
/////////////////////////////////////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////////////////////////////////////
/// widget accessor implementaion /// widget accessor implementation
vtkSmartPointer<vtkProp> cv::viz::WidgetAccessor::getProp(const Widget& widget) vtkSmartPointer<vtkProp> cv::viz::WidgetAccessor::getProp(const Widget& widget)
{ {