From 692d807fa09e5e2794810aaa3a4fd299da51993a Mon Sep 17 00:00:00 2001 From: abidrahmank Date: Sat, 20 Jul 2013 00:15:28 +0530 Subject: [PATCH 1/7] gabor filter docs Bug#1894 --- modules/imgproc/doc/filtering.rst | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/modules/imgproc/doc/filtering.rst b/modules/imgproc/doc/filtering.rst index 2465ac9a45..b7c90792d7 100755 --- a/modules/imgproc/doc/filtering.rst +++ b/modules/imgproc/doc/filtering.rst @@ -947,7 +947,7 @@ Returns Gaussian filter coefficients. :param ksize: Aperture size. It should be odd ( :math:`\texttt{ksize} \mod 2 = 1` ) and positive. :param sigma: Gaussian standard deviation. If it is non-positive, it is computed from ``ksize`` as \ ``sigma = 0.3*((ksize-1)*0.5 - 1) + 0.8`` . - :param ktype: Type of filter coefficients. It can be ``CV_32f`` or ``CV_64F`` . + :param ktype: Type of filter coefficients. It can be ``CV_32F`` or ``CV_64F`` . The function computes and returns the :math:`\texttt{ksize} \times 1` matrix of Gaussian filter coefficients: @@ -976,6 +976,32 @@ Two of such generated kernels can be passed to +getGaborKernel +----------------- +Returns Gabor filter coefficients. + +.. ocv:function:: Mat getGaborKernel( Size ksize, double sigma, double theta, double lambd, double gamma, double psi = CV_PI*0.5, int ktype = CV_64F ) + +.. ocv:pyfunction:: cv2.getGaborKernel(ksize, sigma, theta, lambd, gamma[, psi[, ktype]]) -> retval + + :param ksize: Size of the filter returned. + + :param sigma: Standard deviation of the gaussian envelope. + + :param theta: Orientation of the normal to the parallel stripes of a Gabor function. + + :param lambd: Wavelength of the sinusoidal factor. + + :param gamma: Spatial aspect ratio. + + :param psi: Phase offset. + + :param ktype: Type of filter coefficients. It can be ``CV_32F`` or ``CV_64F`` . + +For more details about gabor filter equations and parameters, see: `Gabor Filter `_. + + + getKernelType ------------- Returns the kernel type. From f36b9940e84772a54055c9611c510a0d62f250cb Mon Sep 17 00:00:00 2001 From: abidrahmank Date: Sat, 20 Jul 2013 14:07:19 +0530 Subject: [PATCH 2/7] ref in inpainting docs --- modules/photo/doc/inpainting.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/modules/photo/doc/inpainting.rst b/modules/photo/doc/inpainting.rst index 9b66266136..9c46517d03 100644 --- a/modules/photo/doc/inpainting.rst +++ b/modules/photo/doc/inpainting.rst @@ -23,10 +23,14 @@ Restores the selected region in an image using the region neighborhood. :param flags: Inpainting method that could be one of the following: - * **INPAINT_NS** Navier-Stokes based method. + * **INPAINT_NS** Navier-Stokes based method [Navier01] * **INPAINT_TELEA** Method by Alexandru Telea [Telea04]_. The function reconstructs the selected image area from the pixel near the area boundary. The function may be used to remove dust and scratches from a scanned photo, or to remove undesirable objects from still images or video. See http://en.wikipedia.org/wiki/Inpainting for more details. + +.. [Telea04] Telea, Alexandru. "An image inpainting technique based on the fast marching method." Journal of graphics tools 9, no. 1 (2004): 23-34. + +.. [Navier01] Bertalmio, Marcelo, Andrea L. Bertozzi, and Guillermo Sapiro. "Navier-stokes, fluid dynamics, and image and video inpainting." In Computer Vision and Pattern Recognition, 2001. CVPR 2001. Proceedings of the 2001 IEEE Computer Society Conference on, vol. 1, pp. I-355. IEEE, 2001. From 297b67d2b11bcdb639fc35760c410777f31d4f6a Mon Sep 17 00:00:00 2001 From: abidrahmank Date: Sun, 21 Jul 2013 13:40:11 +0530 Subject: [PATCH 3/7] pydocs for cv2.findTransformECC --- modules/video/doc/motion_analysis_and_object_tracking.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/modules/video/doc/motion_analysis_and_object_tracking.rst b/modules/video/doc/motion_analysis_and_object_tracking.rst index aef1ba4e94..f6a0438d20 100644 --- a/modules/video/doc/motion_analysis_and_object_tracking.rst +++ b/modules/video/doc/motion_analysis_and_object_tracking.rst @@ -158,6 +158,8 @@ Finds the geometric transform (warp) between two images in terms of the ECC crit .. ocv:function:: double findTransformECC( InputArray templateImage, InputArray inputImage, InputOutputArray warpMatrix, int motionType=MOTION_AFFINE, TermCriteria criteria=TermCriteria(TermCriteria::COUNT+TermCriteria::EPS, 50, 0.001)) +.. ocv:pyfunction:: cv2.findTransformECC(templateImage, inputImage, warpMatrix[, motionType[, criteria]]) -> retval, warpMatrix + :param templateImage: single-channel template image; ``CV_8U`` or ``CV_32F`` array. :param inputImage: single-channel input image which should be warped with the final ``warpMatrix`` in order to provide an image similar to ``templateImage``, same type as ``temlateImage``. From 29ddbbaa86a3b04aab9ecf30390a592d447b6347 Mon Sep 17 00:00:00 2001 From: abidrahmank Date: Tue, 30 Jul 2013 00:27:58 +0530 Subject: [PATCH 4/7] epilines pydocs --- .../calib3d/doc/camera_calibration_and_3d_reconstruction.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/modules/calib3d/doc/camera_calibration_and_3d_reconstruction.rst b/modules/calib3d/doc/camera_calibration_and_3d_reconstruction.rst index f2fbfd1d98..13effbdd65 100644 --- a/modules/calib3d/doc/camera_calibration_and_3d_reconstruction.rst +++ b/modules/calib3d/doc/camera_calibration_and_3d_reconstruction.rst @@ -277,6 +277,8 @@ For points in an image of a stereo pair, computes the corresponding epilines in .. ocv:cfunction:: void cvComputeCorrespondEpilines( const CvMat* points, int which_image, const CvMat* fundamental_matrix, CvMat* correspondent_lines ) +.. ocv:pyfunction:: cv2.computeCorrespondEpilines(points, whichImage, F[, lines]) -> lines + :param points: Input points. :math:`N \times 1` or :math:`1 \times N` matrix of type ``CV_32FC2`` or ``vector`` . :param whichImage: Index of the image (1 or 2) that contains the ``points`` . From 9628bb0b44d6de3391bfbbec3eead6179485e090 Mon Sep 17 00:00:00 2001 From: abidrahmank Date: Tue, 30 Jul 2013 06:46:59 +0530 Subject: [PATCH 5/7] morphologyex docs bug#2169 --- modules/imgproc/doc/filtering.rst | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/modules/imgproc/doc/filtering.rst b/modules/imgproc/doc/filtering.rst index b7c90792d7..635a3b1308 100755 --- a/modules/imgproc/doc/filtering.rst +++ b/modules/imgproc/doc/filtering.rst @@ -755,7 +755,7 @@ Dilates an image by using a specific structuring element. :param dst: output image of the same size and type as ``src``. - :param element: structuring element used for dilation; if ``element=Mat()`` , a ``3 x 3`` rectangular structuring element is used. + :param kernel: structuring element used for dilation; if ``element=Mat()`` , a ``3 x 3`` rectangular structuring element is used. Kernel can be created using :ocv:func:`getStructuringElement` :param anchor: position of the anchor within the element; default value ``(-1, -1)`` means that the anchor is at the element center. @@ -778,7 +778,8 @@ The function supports the in-place mode. Dilation can be applied several ( ``ite :ocv:func:`erode`, :ocv:func:`morphologyEx`, :ocv:func:`createMorphologyFilter` - + :ocv:func:`getStructuringElement` + erode ----- @@ -794,7 +795,7 @@ Erodes an image by using a specific structuring element. :param dst: output image of the same size and type as ``src``. - :param element: structuring element used for erosion; if ``element=Mat()`` , a ``3 x 3`` rectangular structuring element is used. + :param kernel: structuring element used for erosion; if ``element=Mat()`` , a ``3 x 3`` rectangular structuring element is used. Kernel can be created using :ocv:func:`getStructuringElement`. :param anchor: position of the anchor within the element; default value ``(-1, -1)`` means that the anchor is at the element center. @@ -816,7 +817,8 @@ The function supports the in-place mode. Erosion can be applied several ( ``iter :ocv:func:`dilate`, :ocv:func:`morphologyEx`, - :ocv:func:`createMorphologyFilter` + :ocv:func:`createMorphologyFilter`, + :ocv:func:`getStructuringElement` @@ -1116,7 +1118,9 @@ Performs advanced morphological transformations. :param dst: Destination image of the same size and type as ``src`` . - :param element: Structuring element. + :param kernel: Structuring element. It can be created using :ocv:func:`getStructuringElement`. + + :param anchor: Anchor position with the kernel. Negative values mean that the anchor is at the kernel center. :param op: Type of a morphological operation that can be one of the following: @@ -1174,7 +1178,8 @@ Any of the operations can be done in-place. In case of multi-channel images, eac :ocv:func:`dilate`, :ocv:func:`erode`, - :ocv:func:`createMorphologyFilter` + :ocv:func:`createMorphologyFilter`, + :ocv:func:`getStructuringElement` Laplacian From fa1b96bd365d89df92cfdceb049bb4accc31a412 Mon Sep 17 00:00:00 2001 From: abidrahmank Date: Tue, 30 Jul 2013 07:00:51 +0530 Subject: [PATCH 6/7] imshow docs improvement bug#2490 --- modules/highgui/doc/user_interface.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/modules/highgui/doc/user_interface.rst b/modules/highgui/doc/user_interface.rst index e4276718b1..b511c5296c 100644 --- a/modules/highgui/doc/user_interface.rst +++ b/modules/highgui/doc/user_interface.rst @@ -75,6 +75,7 @@ The function ``imshow`` displays an image in the specified window. If the window * If the image is 32-bit floating-point, the pixel values are multiplied by 255. That is, the value range [0,1] is mapped to [0,255]. +This function should be followed by ``waitKey`` function which displays the image for specified milliseconds. Otherwise, it won't display the image. namedWindow --------------- From 1b93ecfae810cfcac2a7969f537cebb63d5721b5 Mon Sep 17 00:00:00 2001 From: abidrahmank Date: Tue, 13 Aug 2013 22:07:44 +0530 Subject: [PATCH 7/7] docs changes --- modules/imgproc/doc/miscellaneous_transformations.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/modules/imgproc/doc/miscellaneous_transformations.rst b/modules/imgproc/doc/miscellaneous_transformations.rst index 20e9be67a4..1fc4d68cce 100644 --- a/modules/imgproc/doc/miscellaneous_transformations.rst +++ b/modules/imgproc/doc/miscellaneous_transformations.rst @@ -799,7 +799,6 @@ See the sample ``grabcut.cpp`` to learn how to use the function. .. [Meyer92] Meyer, F. *Color Image Segmentation*, ICIP92, 1992 -.. [Telea04] Alexandru Telea, *An Image Inpainting Technique Based on the Fast Marching Method*. Journal of Graphics, GPU, and Game Tools 9 1, pp 23-34 (2004) .. Sample code::