CLAHE Python bindings
[profile/ivi/opencv.git] / modules / photo / doc / inpainting.rst
1 Inpainting
2 ==========
3
4 .. highlight:: cpp
5
6 inpaint
7 -----------
8 Restores the selected region in an image using the region neighborhood.
9
10 .. ocv:function:: void inpaint( InputArray src, InputArray inpaintMask, OutputArray dst, double inpaintRadius, int flags )
11
12 .. ocv:pyfunction:: cv2.inpaint(src, inpaintMask, inpaintRadius, flags[, dst]) -> dst
13
14 .. ocv:cfunction:: void cvInpaint( const CvArr* src, const CvArr* inpaint_mask, CvArr* dst, double inpaintRange, int flags )
15 .. ocv:pyoldfunction:: cv.Inpaint(src, mask, dst, inpaintRadius, flags) -> None
16
17     :param src: Input 8-bit 1-channel or 3-channel image.
18
19     :param inpaintMask: Inpainting mask, 8-bit 1-channel image. Non-zero pixels indicate the area that needs to be inpainted.
20
21     :param dst: Output image with the same size and type as  ``src`` .
22
23     :param inpaintRadius: Radius of a circular neighborhood of each point inpainted that is considered by the algorithm.
24
25     :param flags: Inpainting method that could be one of the following:
26
27             * **INPAINT_NS**     Navier-Stokes based method.
28
29             * **INPAINT_TELEA**     Method by Alexandru Telea  [Telea04]_.
30
31 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
32 http://en.wikipedia.org/wiki/Inpainting
33 for more details.