Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
Tetragramm
GitHub Repository: Tetragramm/opencv
Path: blob/master/modules/imgproc/include/opencv2/imgproc.hpp
16339 views
1
/*M///////////////////////////////////////////////////////////////////////////////////////
2
//
3
// IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING.
4
//
5
// By downloading, copying, installing or using the software you agree to this license.
6
// If you do not agree to this license, do not download, install,
7
// copy or use the software.
8
//
9
//
10
// License Agreement
11
// For Open Source Computer Vision Library
12
//
13
// Copyright (C) 2000-2008, Intel Corporation, all rights reserved.
14
// Copyright (C) 2009, Willow Garage Inc., all rights reserved.
15
// Third party copyrights are property of their respective owners.
16
//
17
// Redistribution and use in source and binary forms, with or without modification,
18
// are permitted provided that the following conditions are met:
19
//
20
// * Redistribution's of source code must retain the above copyright notice,
21
// this list of conditions and the following disclaimer.
22
//
23
// * Redistribution's in binary form must reproduce the above copyright notice,
24
// this list of conditions and the following disclaimer in the documentation
25
// and/or other materials provided with the distribution.
26
//
27
// * The name of the copyright holders may not be used to endorse or promote products
28
// derived from this software without specific prior written permission.
29
//
30
// This software is provided by the copyright holders and contributors "as is" and
31
// any express or implied warranties, including, but not limited to, the implied
32
// warranties of merchantability and fitness for a particular purpose are disclaimed.
33
// In no event shall the Intel Corporation or contributors be liable for any direct,
34
// indirect, incidental, special, exemplary, or consequential damages
35
// (including, but not limited to, procurement of substitute goods or services;
36
// loss of use, data, or profits; or business interruption) however caused
37
// and on any theory of liability, whether in contract, strict liability,
38
// or tort (including negligence or otherwise) arising in any way out of
39
// the use of this software, even if advised of the possibility of such damage.
40
//
41
//M*/
42
43
#ifndef OPENCV_IMGPROC_HPP
44
#define OPENCV_IMGPROC_HPP
45
46
#include "opencv2/core.hpp"
47
48
/**
49
@defgroup imgproc Image processing
50
@{
51
@defgroup imgproc_filter Image Filtering
52
53
Functions and classes described in this section are used to perform various linear or non-linear
54
filtering operations on 2D images (represented as Mat's). It means that for each pixel location
55
\f$(x,y)\f$ in the source image (normally, rectangular), its neighborhood is considered and used to
56
compute the response. In case of a linear filter, it is a weighted sum of pixel values. In case of
57
morphological operations, it is the minimum or maximum values, and so on. The computed response is
58
stored in the destination image at the same location \f$(x,y)\f$. It means that the output image
59
will be of the same size as the input image. Normally, the functions support multi-channel arrays,
60
in which case every channel is processed independently. Therefore, the output image will also have
61
the same number of channels as the input one.
62
63
Another common feature of the functions and classes described in this section is that, unlike
64
simple arithmetic functions, they need to extrapolate values of some non-existing pixels. For
65
example, if you want to smooth an image using a Gaussian \f$3 \times 3\f$ filter, then, when
66
processing the left-most pixels in each row, you need pixels to the left of them, that is, outside
67
of the image. You can let these pixels be the same as the left-most image pixels ("replicated
68
border" extrapolation method), or assume that all the non-existing pixels are zeros ("constant
69
border" extrapolation method), and so on. OpenCV enables you to specify the extrapolation method.
70
For details, see #BorderTypes
71
72
@anchor filter_depths
73
### Depth combinations
74
Input depth (src.depth()) | Output depth (ddepth)
75
--------------------------|----------------------
76
CV_8U | -1/CV_16S/CV_32F/CV_64F
77
CV_16U/CV_16S | -1/CV_32F/CV_64F
78
CV_32F | -1/CV_32F/CV_64F
79
CV_64F | -1/CV_64F
80
81
@note when ddepth=-1, the output image will have the same depth as the source.
82
83
@defgroup imgproc_transform Geometric Image Transformations
84
85
The functions in this section perform various geometrical transformations of 2D images. They do not
86
change the image content but deform the pixel grid and map this deformed grid to the destination
87
image. In fact, to avoid sampling artifacts, the mapping is done in the reverse order, from
88
destination to the source. That is, for each pixel \f$(x, y)\f$ of the destination image, the
89
functions compute coordinates of the corresponding "donor" pixel in the source image and copy the
90
pixel value:
91
92
\f[\texttt{dst} (x,y)= \texttt{src} (f_x(x,y), f_y(x,y))\f]
93
94
In case when you specify the forward mapping \f$\left<g_x, g_y\right>: \texttt{src} \rightarrow
95
\texttt{dst}\f$, the OpenCV functions first compute the corresponding inverse mapping
96
\f$\left<f_x, f_y\right>: \texttt{dst} \rightarrow \texttt{src}\f$ and then use the above formula.
97
98
The actual implementations of the geometrical transformations, from the most generic remap and to
99
the simplest and the fastest resize, need to solve two main problems with the above formula:
100
101
- Extrapolation of non-existing pixels. Similarly to the filtering functions described in the
102
previous section, for some \f$(x,y)\f$, either one of \f$f_x(x,y)\f$, or \f$f_y(x,y)\f$, or both
103
of them may fall outside of the image. In this case, an extrapolation method needs to be used.
104
OpenCV provides the same selection of extrapolation methods as in the filtering functions. In
105
addition, it provides the method #BORDER_TRANSPARENT. This means that the corresponding pixels in
106
the destination image will not be modified at all.
107
108
- Interpolation of pixel values. Usually \f$f_x(x,y)\f$ and \f$f_y(x,y)\f$ are floating-point
109
numbers. This means that \f$\left<f_x, f_y\right>\f$ can be either an affine or perspective
110
transformation, or radial lens distortion correction, and so on. So, a pixel value at fractional
111
coordinates needs to be retrieved. In the simplest case, the coordinates can be just rounded to the
112
nearest integer coordinates and the corresponding pixel can be used. This is called a
113
nearest-neighbor interpolation. However, a better result can be achieved by using more
114
sophisticated [interpolation methods](http://en.wikipedia.org/wiki/Multivariate_interpolation) ,
115
where a polynomial function is fit into some neighborhood of the computed pixel \f$(f_x(x,y),
116
f_y(x,y))\f$, and then the value of the polynomial at \f$(f_x(x,y), f_y(x,y))\f$ is taken as the
117
interpolated pixel value. In OpenCV, you can choose between several interpolation methods. See
118
resize for details.
119
120
@note The geometrical transformations do not work with `CV_8S` or `CV_32S` images.
121
122
@defgroup imgproc_misc Miscellaneous Image Transformations
123
@defgroup imgproc_draw Drawing Functions
124
125
Drawing functions work with matrices/images of arbitrary depth. The boundaries of the shapes can be
126
rendered with antialiasing (implemented only for 8-bit images for now). All the functions include
127
the parameter color that uses an RGB value (that may be constructed with the Scalar constructor )
128
for color images and brightness for grayscale images. For color images, the channel ordering is
129
normally *Blue, Green, Red*. This is what imshow, imread, and imwrite expect. So, if you form a
130
color using the Scalar constructor, it should look like:
131
132
\f[\texttt{Scalar} (blue \_ component, green \_ component, red \_ component[, alpha \_ component])\f]
133
134
If you are using your own image rendering and I/O functions, you can use any channel ordering. The
135
drawing functions process each channel independently and do not depend on the channel order or even
136
on the used color space. The whole image can be converted from BGR to RGB or to a different color
137
space using cvtColor .
138
139
If a drawn figure is partially or completely outside the image, the drawing functions clip it. Also,
140
many drawing functions can handle pixel coordinates specified with sub-pixel accuracy. This means
141
that the coordinates can be passed as fixed-point numbers encoded as integers. The number of
142
fractional bits is specified by the shift parameter and the real point coordinates are calculated as
143
\f$\texttt{Point}(x,y)\rightarrow\texttt{Point2f}(x*2^{-shift},y*2^{-shift})\f$ . This feature is
144
especially effective when rendering antialiased shapes.
145
146
@note The functions do not support alpha-transparency when the target image is 4-channel. In this
147
case, the color[3] is simply copied to the repainted pixels. Thus, if you want to paint
148
semi-transparent shapes, you can paint them in a separate buffer and then blend it with the main
149
image.
150
151
@defgroup imgproc_colormap ColorMaps in OpenCV
152
153
The human perception isn't built for observing fine changes in grayscale images. Human eyes are more
154
sensitive to observing changes between colors, so you often need to recolor your grayscale images to
155
get a clue about them. OpenCV now comes with various colormaps to enhance the visualization in your
156
computer vision application.
157
158
In OpenCV you only need applyColorMap to apply a colormap on a given image. The following sample
159
code reads the path to an image from command line, applies a Jet colormap on it and shows the
160
result:
161
162
@include snippets/imgproc_applyColorMap.cpp
163
164
@see #ColormapTypes
165
166
@defgroup imgproc_subdiv2d Planar Subdivision
167
168
The Subdiv2D class described in this section is used to perform various planar subdivision on
169
a set of 2D points (represented as vector of Point2f). OpenCV subdivides a plane into triangles
170
using the Delaunay's algorithm, which corresponds to the dual graph of the Voronoi diagram.
171
In the figure below, the Delaunay's triangulation is marked with black lines and the Voronoi
172
diagram with red lines.
173
174
![Delaunay triangulation (black) and Voronoi (red)](pics/delaunay_voronoi.png)
175
176
The subdivisions can be used for the 3D piece-wise transformation of a plane, morphing, fast
177
location of points on the plane, building special graphs (such as NNG,RNG), and so forth.
178
179
@defgroup imgproc_hist Histograms
180
@defgroup imgproc_shape Structural Analysis and Shape Descriptors
181
@defgroup imgproc_motion Motion Analysis and Object Tracking
182
@defgroup imgproc_feature Feature Detection
183
@defgroup imgproc_object Object Detection
184
@defgroup imgproc_c C API
185
@defgroup imgproc_hal Hardware Acceleration Layer
186
@{
187
@defgroup imgproc_hal_functions Functions
188
@defgroup imgproc_hal_interface Interface
189
@}
190
@}
191
*/
192
193
namespace cv
194
{
195
196
/** @addtogroup imgproc
197
@{
198
*/
199
200
//! @addtogroup imgproc_filter
201
//! @{
202
203
//! type of morphological operation
204
enum MorphTypes{
205
MORPH_ERODE = 0, //!< see #erode
206
MORPH_DILATE = 1, //!< see #dilate
207
MORPH_OPEN = 2, //!< an opening operation
208
//!< \f[\texttt{dst} = \mathrm{open} ( \texttt{src} , \texttt{element} )= \mathrm{dilate} ( \mathrm{erode} ( \texttt{src} , \texttt{element} ))\f]
209
MORPH_CLOSE = 3, //!< a closing operation
210
//!< \f[\texttt{dst} = \mathrm{close} ( \texttt{src} , \texttt{element} )= \mathrm{erode} ( \mathrm{dilate} ( \texttt{src} , \texttt{element} ))\f]
211
MORPH_GRADIENT = 4, //!< a morphological gradient
212
//!< \f[\texttt{dst} = \mathrm{morph\_grad} ( \texttt{src} , \texttt{element} )= \mathrm{dilate} ( \texttt{src} , \texttt{element} )- \mathrm{erode} ( \texttt{src} , \texttt{element} )\f]
213
MORPH_TOPHAT = 5, //!< "top hat"
214
//!< \f[\texttt{dst} = \mathrm{tophat} ( \texttt{src} , \texttt{element} )= \texttt{src} - \mathrm{open} ( \texttt{src} , \texttt{element} )\f]
215
MORPH_BLACKHAT = 6, //!< "black hat"
216
//!< \f[\texttt{dst} = \mathrm{blackhat} ( \texttt{src} , \texttt{element} )= \mathrm{close} ( \texttt{src} , \texttt{element} )- \texttt{src}\f]
217
MORPH_HITMISS = 7 //!< "hit or miss"
218
//!< .- Only supported for CV_8UC1 binary images. A tutorial can be found in the documentation
219
};
220
221
//! shape of the structuring element
222
enum MorphShapes {
223
MORPH_RECT = 0, //!< a rectangular structuring element: \f[E_{ij}=1\f]
224
MORPH_CROSS = 1, //!< a cross-shaped structuring element:
225
//!< \f[E_{ij} = \fork{1}{if i=\texttt{anchor.y} or j=\texttt{anchor.x}}{0}{otherwise}\f]
226
MORPH_ELLIPSE = 2 //!< an elliptic structuring element, that is, a filled ellipse inscribed
227
//!< into the rectangle Rect(0, 0, esize.width, 0.esize.height)
228
};
229
230
//! @} imgproc_filter
231
232
//! @addtogroup imgproc_transform
233
//! @{
234
235
//! interpolation algorithm
236
enum InterpolationFlags{
237
/** nearest neighbor interpolation */
238
INTER_NEAREST = 0,
239
/** bilinear interpolation */
240
INTER_LINEAR = 1,
241
/** bicubic interpolation */
242
INTER_CUBIC = 2,
243
/** resampling using pixel area relation. It may be a preferred method for image decimation, as
244
it gives moire'-free results. But when the image is zoomed, it is similar to the INTER_NEAREST
245
method. */
246
INTER_AREA = 3,
247
/** Lanczos interpolation over 8x8 neighborhood */
248
INTER_LANCZOS4 = 4,
249
/** Bit exact bilinear interpolation */
250
INTER_LINEAR_EXACT = 5,
251
/** mask for interpolation codes */
252
INTER_MAX = 7,
253
/** flag, fills all of the destination image pixels. If some of them correspond to outliers in the
254
source image, they are set to zero */
255
WARP_FILL_OUTLIERS = 8,
256
/** flag, inverse transformation
257
258
For example, #linearPolar or #logPolar transforms:
259
- flag is __not__ set: \f$dst( \rho , \phi ) = src(x,y)\f$
260
- flag is set: \f$dst(x,y) = src( \rho , \phi )\f$
261
*/
262
WARP_INVERSE_MAP = 16
263
};
264
265
/** \brief Specify the polar mapping mode
266
@sa warpPolar
267
*/
268
enum WarpPolarMode
269
{
270
WARP_POLAR_LINEAR = 0, ///< Remaps an image to/from polar space.
271
WARP_POLAR_LOG = 256 ///< Remaps an image to/from semilog-polar space.
272
};
273
274
enum InterpolationMasks {
275
INTER_BITS = 5,
276
INTER_BITS2 = INTER_BITS * 2,
277
INTER_TAB_SIZE = 1 << INTER_BITS,
278
INTER_TAB_SIZE2 = INTER_TAB_SIZE * INTER_TAB_SIZE
279
};
280
281
//! @} imgproc_transform
282
283
//! @addtogroup imgproc_misc
284
//! @{
285
286
//! Distance types for Distance Transform and M-estimators
287
//! @see distanceTransform, fitLine
288
enum DistanceTypes {
289
DIST_USER = -1, //!< User defined distance
290
DIST_L1 = 1, //!< distance = |x1-x2| + |y1-y2|
291
DIST_L2 = 2, //!< the simple euclidean distance
292
DIST_C = 3, //!< distance = max(|x1-x2|,|y1-y2|)
293
DIST_L12 = 4, //!< L1-L2 metric: distance = 2(sqrt(1+x*x/2) - 1))
294
DIST_FAIR = 5, //!< distance = c^2(|x|/c-log(1+|x|/c)), c = 1.3998
295
DIST_WELSCH = 6, //!< distance = c^2/2(1-exp(-(x/c)^2)), c = 2.9846
296
DIST_HUBER = 7 //!< distance = |x|<c ? x^2/2 : c(|x|-c/2), c=1.345
297
};
298
299
//! Mask size for distance transform
300
enum DistanceTransformMasks {
301
DIST_MASK_3 = 3, //!< mask=3
302
DIST_MASK_5 = 5, //!< mask=5
303
DIST_MASK_PRECISE = 0 //!<
304
};
305
306
//! type of the threshold operation
307
//! ![threshold types](pics/threshold.png)
308
enum ThresholdTypes {
309
THRESH_BINARY = 0, //!< \f[\texttt{dst} (x,y) = \fork{\texttt{maxval}}{if \(\texttt{src}(x,y) > \texttt{thresh}\)}{0}{otherwise}\f]
310
THRESH_BINARY_INV = 1, //!< \f[\texttt{dst} (x,y) = \fork{0}{if \(\texttt{src}(x,y) > \texttt{thresh}\)}{\texttt{maxval}}{otherwise}\f]
311
THRESH_TRUNC = 2, //!< \f[\texttt{dst} (x,y) = \fork{\texttt{threshold}}{if \(\texttt{src}(x,y) > \texttt{thresh}\)}{\texttt{src}(x,y)}{otherwise}\f]
312
THRESH_TOZERO = 3, //!< \f[\texttt{dst} (x,y) = \fork{\texttt{src}(x,y)}{if \(\texttt{src}(x,y) > \texttt{thresh}\)}{0}{otherwise}\f]
313
THRESH_TOZERO_INV = 4, //!< \f[\texttt{dst} (x,y) = \fork{0}{if \(\texttt{src}(x,y) > \texttt{thresh}\)}{\texttt{src}(x,y)}{otherwise}\f]
314
THRESH_MASK = 7,
315
THRESH_OTSU = 8, //!< flag, use Otsu algorithm to choose the optimal threshold value
316
THRESH_TRIANGLE = 16 //!< flag, use Triangle algorithm to choose the optimal threshold value
317
};
318
319
//! adaptive threshold algorithm
320
//! @see adaptiveThreshold
321
enum AdaptiveThresholdTypes {
322
/** the threshold value \f$T(x,y)\f$ is a mean of the \f$\texttt{blockSize} \times
323
\texttt{blockSize}\f$ neighborhood of \f$(x, y)\f$ minus C */
324
ADAPTIVE_THRESH_MEAN_C = 0,
325
/** the threshold value \f$T(x, y)\f$ is a weighted sum (cross-correlation with a Gaussian
326
window) of the \f$\texttt{blockSize} \times \texttt{blockSize}\f$ neighborhood of \f$(x, y)\f$
327
minus C . The default sigma (standard deviation) is used for the specified blockSize . See
328
#getGaussianKernel*/
329
ADAPTIVE_THRESH_GAUSSIAN_C = 1
330
};
331
332
//! class of the pixel in GrabCut algorithm
333
enum GrabCutClasses {
334
GC_BGD = 0, //!< an obvious background pixels
335
GC_FGD = 1, //!< an obvious foreground (object) pixel
336
GC_PR_BGD = 2, //!< a possible background pixel
337
GC_PR_FGD = 3 //!< a possible foreground pixel
338
};
339
340
//! GrabCut algorithm flags
341
enum GrabCutModes {
342
/** The function initializes the state and the mask using the provided rectangle. After that it
343
runs iterCount iterations of the algorithm. */
344
GC_INIT_WITH_RECT = 0,
345
/** The function initializes the state using the provided mask. Note that GC_INIT_WITH_RECT
346
and GC_INIT_WITH_MASK can be combined. Then, all the pixels outside of the ROI are
347
automatically initialized with GC_BGD .*/
348
GC_INIT_WITH_MASK = 1,
349
/** The value means that the algorithm should just resume. */
350
GC_EVAL = 2,
351
/** The value means that the algorithm should just run the grabCut algorithm (a single iteration) with the fixed model */
352
GC_EVAL_FREEZE_MODEL = 3
353
};
354
355
//! distanceTransform algorithm flags
356
enum DistanceTransformLabelTypes {
357
/** each connected component of zeros in src (as well as all the non-zero pixels closest to the
358
connected component) will be assigned the same label */
359
DIST_LABEL_CCOMP = 0,
360
/** each zero pixel (and all the non-zero pixels closest to it) gets its own label. */
361
DIST_LABEL_PIXEL = 1
362
};
363
364
//! floodfill algorithm flags
365
enum FloodFillFlags {
366
/** If set, the difference between the current pixel and seed pixel is considered. Otherwise,
367
the difference between neighbor pixels is considered (that is, the range is floating). */
368
FLOODFILL_FIXED_RANGE = 1 << 16,
369
/** If set, the function does not change the image ( newVal is ignored), and only fills the
370
mask with the value specified in bits 8-16 of flags as described above. This option only make
371
sense in function variants that have the mask parameter. */
372
FLOODFILL_MASK_ONLY = 1 << 17
373
};
374
375
//! @} imgproc_misc
376
377
//! @addtogroup imgproc_shape
378
//! @{
379
380
//! connected components algorithm output formats
381
enum ConnectedComponentsTypes {
382
CC_STAT_LEFT = 0, //!< The leftmost (x) coordinate which is the inclusive start of the bounding
383
//!< box in the horizontal direction.
384
CC_STAT_TOP = 1, //!< The topmost (y) coordinate which is the inclusive start of the bounding
385
//!< box in the vertical direction.
386
CC_STAT_WIDTH = 2, //!< The horizontal size of the bounding box
387
CC_STAT_HEIGHT = 3, //!< The vertical size of the bounding box
388
CC_STAT_AREA = 4, //!< The total area (in pixels) of the connected component
389
CC_STAT_MAX = 5
390
};
391
392
//! connected components algorithm
393
enum ConnectedComponentsAlgorithmsTypes {
394
CCL_WU = 0, //!< SAUF algorithm for 8-way connectivity, SAUF algorithm for 4-way connectivity
395
CCL_DEFAULT = -1, //!< BBDT algorithm for 8-way connectivity, SAUF algorithm for 4-way connectivity
396
CCL_GRANA = 1 //!< BBDT algorithm for 8-way connectivity, SAUF algorithm for 4-way connectivity
397
};
398
399
//! mode of the contour retrieval algorithm
400
enum RetrievalModes {
401
/** retrieves only the extreme outer contours. It sets `hierarchy[i][2]=hierarchy[i][3]=-1` for
402
all the contours. */
403
RETR_EXTERNAL = 0,
404
/** retrieves all of the contours without establishing any hierarchical relationships. */
405
RETR_LIST = 1,
406
/** retrieves all of the contours and organizes them into a two-level hierarchy. At the top
407
level, there are external boundaries of the components. At the second level, there are
408
boundaries of the holes. If there is another contour inside a hole of a connected component, it
409
is still put at the top level. */
410
RETR_CCOMP = 2,
411
/** retrieves all of the contours and reconstructs a full hierarchy of nested contours.*/
412
RETR_TREE = 3,
413
RETR_FLOODFILL = 4 //!<
414
};
415
416
//! the contour approximation algorithm
417
enum ContourApproximationModes {
418
/** stores absolutely all the contour points. That is, any 2 subsequent points (x1,y1) and
419
(x2,y2) of the contour will be either horizontal, vertical or diagonal neighbors, that is,
420
max(abs(x1-x2),abs(y2-y1))==1. */
421
CHAIN_APPROX_NONE = 1,
422
/** compresses horizontal, vertical, and diagonal segments and leaves only their end points.
423
For example, an up-right rectangular contour is encoded with 4 points. */
424
CHAIN_APPROX_SIMPLE = 2,
425
/** applies one of the flavors of the Teh-Chin chain approximation algorithm @cite TehChin89 */
426
CHAIN_APPROX_TC89_L1 = 3,
427
/** applies one of the flavors of the Teh-Chin chain approximation algorithm @cite TehChin89 */
428
CHAIN_APPROX_TC89_KCOS = 4
429
};
430
431
/** @brief Shape matching methods
432
433
\f$A\f$ denotes object1,\f$B\f$ denotes object2
434
435
\f$\begin{array}{l} m^A_i = \mathrm{sign} (h^A_i) \cdot \log{h^A_i} \\ m^B_i = \mathrm{sign} (h^B_i) \cdot \log{h^B_i} \end{array}\f$
436
437
and \f$h^A_i, h^B_i\f$ are the Hu moments of \f$A\f$ and \f$B\f$ , respectively.
438
*/
439
enum ShapeMatchModes {
440
CONTOURS_MATCH_I1 =1, //!< \f[I_1(A,B) = \sum _{i=1...7} \left | \frac{1}{m^A_i} - \frac{1}{m^B_i} \right |\f]
441
CONTOURS_MATCH_I2 =2, //!< \f[I_2(A,B) = \sum _{i=1...7} \left | m^A_i - m^B_i \right |\f]
442
CONTOURS_MATCH_I3 =3 //!< \f[I_3(A,B) = \max _{i=1...7} \frac{ \left| m^A_i - m^B_i \right| }{ \left| m^A_i \right| }\f]
443
};
444
445
//! @} imgproc_shape
446
447
//! Variants of a Hough transform
448
enum HoughModes {
449
450
/** classical or standard Hough transform. Every line is represented by two floating-point
451
numbers \f$(\rho, \theta)\f$ , where \f$\rho\f$ is a distance between (0,0) point and the line,
452
and \f$\theta\f$ is the angle between x-axis and the normal to the line. Thus, the matrix must
453
be (the created sequence will be) of CV_32FC2 type */
454
HOUGH_STANDARD = 0,
455
/** probabilistic Hough transform (more efficient in case if the picture contains a few long
456
linear segments). It returns line segments rather than the whole line. Each segment is
457
represented by starting and ending points, and the matrix must be (the created sequence will
458
be) of the CV_32SC4 type. */
459
HOUGH_PROBABILISTIC = 1,
460
/** multi-scale variant of the classical Hough transform. The lines are encoded the same way as
461
HOUGH_STANDARD. */
462
HOUGH_MULTI_SCALE = 2,
463
HOUGH_GRADIENT = 3 //!< basically *21HT*, described in @cite Yuen90
464
};
465
466
//! Variants of Line Segment %Detector
467
//! @ingroup imgproc_feature
468
enum LineSegmentDetectorModes {
469
LSD_REFINE_NONE = 0, //!< No refinement applied
470
LSD_REFINE_STD = 1, //!< Standard refinement is applied. E.g. breaking arches into smaller straighter line approximations.
471
LSD_REFINE_ADV = 2 //!< Advanced refinement. Number of false alarms is calculated, lines are
472
//!< refined through increase of precision, decrement in size, etc.
473
};
474
475
/** Histogram comparison methods
476
@ingroup imgproc_hist
477
*/
478
enum HistCompMethods {
479
/** Correlation
480
\f[d(H_1,H_2) = \frac{\sum_I (H_1(I) - \bar{H_1}) (H_2(I) - \bar{H_2})}{\sqrt{\sum_I(H_1(I) - \bar{H_1})^2 \sum_I(H_2(I) - \bar{H_2})^2}}\f]
481
where
482
\f[\bar{H_k} = \frac{1}{N} \sum _J H_k(J)\f]
483
and \f$N\f$ is a total number of histogram bins. */
484
HISTCMP_CORREL = 0,
485
/** Chi-Square
486
\f[d(H_1,H_2) = \sum _I \frac{\left(H_1(I)-H_2(I)\right)^2}{H_1(I)}\f] */
487
HISTCMP_CHISQR = 1,
488
/** Intersection
489
\f[d(H_1,H_2) = \sum _I \min (H_1(I), H_2(I))\f] */
490
HISTCMP_INTERSECT = 2,
491
/** Bhattacharyya distance
492
(In fact, OpenCV computes Hellinger distance, which is related to Bhattacharyya coefficient.)
493
\f[d(H_1,H_2) = \sqrt{1 - \frac{1}{\sqrt{\bar{H_1} \bar{H_2} N^2}} \sum_I \sqrt{H_1(I) \cdot H_2(I)}}\f] */
494
HISTCMP_BHATTACHARYYA = 3,
495
HISTCMP_HELLINGER = HISTCMP_BHATTACHARYYA, //!< Synonym for HISTCMP_BHATTACHARYYA
496
/** Alternative Chi-Square
497
\f[d(H_1,H_2) = 2 * \sum _I \frac{\left(H_1(I)-H_2(I)\right)^2}{H_1(I)+H_2(I)}\f]
498
This alternative formula is regularly used for texture comparison. See e.g. @cite Puzicha1997 */
499
HISTCMP_CHISQR_ALT = 4,
500
/** Kullback-Leibler divergence
501
\f[d(H_1,H_2) = \sum _I H_1(I) \log \left(\frac{H_1(I)}{H_2(I)}\right)\f] */
502
HISTCMP_KL_DIV = 5
503
};
504
505
/** the color conversion code
506
@see @ref imgproc_color_conversions
507
@ingroup imgproc_misc
508
*/
509
enum ColorConversionCodes {
510
COLOR_BGR2BGRA = 0, //!< add alpha channel to RGB or BGR image
511
COLOR_RGB2RGBA = COLOR_BGR2BGRA,
512
513
COLOR_BGRA2BGR = 1, //!< remove alpha channel from RGB or BGR image
514
COLOR_RGBA2RGB = COLOR_BGRA2BGR,
515
516
COLOR_BGR2RGBA = 2, //!< convert between RGB and BGR color spaces (with or without alpha channel)
517
COLOR_RGB2BGRA = COLOR_BGR2RGBA,
518
519
COLOR_RGBA2BGR = 3,
520
COLOR_BGRA2RGB = COLOR_RGBA2BGR,
521
522
COLOR_BGR2RGB = 4,
523
COLOR_RGB2BGR = COLOR_BGR2RGB,
524
525
COLOR_BGRA2RGBA = 5,
526
COLOR_RGBA2BGRA = COLOR_BGRA2RGBA,
527
528
COLOR_BGR2GRAY = 6, //!< convert between RGB/BGR and grayscale, @ref color_convert_rgb_gray "color conversions"
529
COLOR_RGB2GRAY = 7,
530
COLOR_GRAY2BGR = 8,
531
COLOR_GRAY2RGB = COLOR_GRAY2BGR,
532
COLOR_GRAY2BGRA = 9,
533
COLOR_GRAY2RGBA = COLOR_GRAY2BGRA,
534
COLOR_BGRA2GRAY = 10,
535
COLOR_RGBA2GRAY = 11,
536
537
COLOR_BGR2BGR565 = 12, //!< convert between RGB/BGR and BGR565 (16-bit images)
538
COLOR_RGB2BGR565 = 13,
539
COLOR_BGR5652BGR = 14,
540
COLOR_BGR5652RGB = 15,
541
COLOR_BGRA2BGR565 = 16,
542
COLOR_RGBA2BGR565 = 17,
543
COLOR_BGR5652BGRA = 18,
544
COLOR_BGR5652RGBA = 19,
545
546
COLOR_GRAY2BGR565 = 20, //!< convert between grayscale to BGR565 (16-bit images)
547
COLOR_BGR5652GRAY = 21,
548
549
COLOR_BGR2BGR555 = 22, //!< convert between RGB/BGR and BGR555 (16-bit images)
550
COLOR_RGB2BGR555 = 23,
551
COLOR_BGR5552BGR = 24,
552
COLOR_BGR5552RGB = 25,
553
COLOR_BGRA2BGR555 = 26,
554
COLOR_RGBA2BGR555 = 27,
555
COLOR_BGR5552BGRA = 28,
556
COLOR_BGR5552RGBA = 29,
557
558
COLOR_GRAY2BGR555 = 30, //!< convert between grayscale and BGR555 (16-bit images)
559
COLOR_BGR5552GRAY = 31,
560
561
COLOR_BGR2XYZ = 32, //!< convert RGB/BGR to CIE XYZ, @ref color_convert_rgb_xyz "color conversions"
562
COLOR_RGB2XYZ = 33,
563
COLOR_XYZ2BGR = 34,
564
COLOR_XYZ2RGB = 35,
565
566
COLOR_BGR2YCrCb = 36, //!< convert RGB/BGR to luma-chroma (aka YCC), @ref color_convert_rgb_ycrcb "color conversions"
567
COLOR_RGB2YCrCb = 37,
568
COLOR_YCrCb2BGR = 38,
569
COLOR_YCrCb2RGB = 39,
570
571
COLOR_BGR2HSV = 40, //!< convert RGB/BGR to HSV (hue saturation value), @ref color_convert_rgb_hsv "color conversions"
572
COLOR_RGB2HSV = 41,
573
574
COLOR_BGR2Lab = 44, //!< convert RGB/BGR to CIE Lab, @ref color_convert_rgb_lab "color conversions"
575
COLOR_RGB2Lab = 45,
576
577
COLOR_BGR2Luv = 50, //!< convert RGB/BGR to CIE Luv, @ref color_convert_rgb_luv "color conversions"
578
COLOR_RGB2Luv = 51,
579
COLOR_BGR2HLS = 52, //!< convert RGB/BGR to HLS (hue lightness saturation), @ref color_convert_rgb_hls "color conversions"
580
COLOR_RGB2HLS = 53,
581
582
COLOR_HSV2BGR = 54, //!< backward conversions to RGB/BGR
583
COLOR_HSV2RGB = 55,
584
585
COLOR_Lab2BGR = 56,
586
COLOR_Lab2RGB = 57,
587
COLOR_Luv2BGR = 58,
588
COLOR_Luv2RGB = 59,
589
COLOR_HLS2BGR = 60,
590
COLOR_HLS2RGB = 61,
591
592
COLOR_BGR2HSV_FULL = 66, //!<
593
COLOR_RGB2HSV_FULL = 67,
594
COLOR_BGR2HLS_FULL = 68,
595
COLOR_RGB2HLS_FULL = 69,
596
597
COLOR_HSV2BGR_FULL = 70,
598
COLOR_HSV2RGB_FULL = 71,
599
COLOR_HLS2BGR_FULL = 72,
600
COLOR_HLS2RGB_FULL = 73,
601
602
COLOR_LBGR2Lab = 74,
603
COLOR_LRGB2Lab = 75,
604
COLOR_LBGR2Luv = 76,
605
COLOR_LRGB2Luv = 77,
606
607
COLOR_Lab2LBGR = 78,
608
COLOR_Lab2LRGB = 79,
609
COLOR_Luv2LBGR = 80,
610
COLOR_Luv2LRGB = 81,
611
612
COLOR_BGR2YUV = 82, //!< convert between RGB/BGR and YUV
613
COLOR_RGB2YUV = 83,
614
COLOR_YUV2BGR = 84,
615
COLOR_YUV2RGB = 85,
616
617
//! YUV 4:2:0 family to RGB
618
COLOR_YUV2RGB_NV12 = 90,
619
COLOR_YUV2BGR_NV12 = 91,
620
COLOR_YUV2RGB_NV21 = 92,
621
COLOR_YUV2BGR_NV21 = 93,
622
COLOR_YUV420sp2RGB = COLOR_YUV2RGB_NV21,
623
COLOR_YUV420sp2BGR = COLOR_YUV2BGR_NV21,
624
625
COLOR_YUV2RGBA_NV12 = 94,
626
COLOR_YUV2BGRA_NV12 = 95,
627
COLOR_YUV2RGBA_NV21 = 96,
628
COLOR_YUV2BGRA_NV21 = 97,
629
COLOR_YUV420sp2RGBA = COLOR_YUV2RGBA_NV21,
630
COLOR_YUV420sp2BGRA = COLOR_YUV2BGRA_NV21,
631
632
COLOR_YUV2RGB_YV12 = 98,
633
COLOR_YUV2BGR_YV12 = 99,
634
COLOR_YUV2RGB_IYUV = 100,
635
COLOR_YUV2BGR_IYUV = 101,
636
COLOR_YUV2RGB_I420 = COLOR_YUV2RGB_IYUV,
637
COLOR_YUV2BGR_I420 = COLOR_YUV2BGR_IYUV,
638
COLOR_YUV420p2RGB = COLOR_YUV2RGB_YV12,
639
COLOR_YUV420p2BGR = COLOR_YUV2BGR_YV12,
640
641
COLOR_YUV2RGBA_YV12 = 102,
642
COLOR_YUV2BGRA_YV12 = 103,
643
COLOR_YUV2RGBA_IYUV = 104,
644
COLOR_YUV2BGRA_IYUV = 105,
645
COLOR_YUV2RGBA_I420 = COLOR_YUV2RGBA_IYUV,
646
COLOR_YUV2BGRA_I420 = COLOR_YUV2BGRA_IYUV,
647
COLOR_YUV420p2RGBA = COLOR_YUV2RGBA_YV12,
648
COLOR_YUV420p2BGRA = COLOR_YUV2BGRA_YV12,
649
650
COLOR_YUV2GRAY_420 = 106,
651
COLOR_YUV2GRAY_NV21 = COLOR_YUV2GRAY_420,
652
COLOR_YUV2GRAY_NV12 = COLOR_YUV2GRAY_420,
653
COLOR_YUV2GRAY_YV12 = COLOR_YUV2GRAY_420,
654
COLOR_YUV2GRAY_IYUV = COLOR_YUV2GRAY_420,
655
COLOR_YUV2GRAY_I420 = COLOR_YUV2GRAY_420,
656
COLOR_YUV420sp2GRAY = COLOR_YUV2GRAY_420,
657
COLOR_YUV420p2GRAY = COLOR_YUV2GRAY_420,
658
659
//! YUV 4:2:2 family to RGB
660
COLOR_YUV2RGB_UYVY = 107,
661
COLOR_YUV2BGR_UYVY = 108,
662
//COLOR_YUV2RGB_VYUY = 109,
663
//COLOR_YUV2BGR_VYUY = 110,
664
COLOR_YUV2RGB_Y422 = COLOR_YUV2RGB_UYVY,
665
COLOR_YUV2BGR_Y422 = COLOR_YUV2BGR_UYVY,
666
COLOR_YUV2RGB_UYNV = COLOR_YUV2RGB_UYVY,
667
COLOR_YUV2BGR_UYNV = COLOR_YUV2BGR_UYVY,
668
669
COLOR_YUV2RGBA_UYVY = 111,
670
COLOR_YUV2BGRA_UYVY = 112,
671
//COLOR_YUV2RGBA_VYUY = 113,
672
//COLOR_YUV2BGRA_VYUY = 114,
673
COLOR_YUV2RGBA_Y422 = COLOR_YUV2RGBA_UYVY,
674
COLOR_YUV2BGRA_Y422 = COLOR_YUV2BGRA_UYVY,
675
COLOR_YUV2RGBA_UYNV = COLOR_YUV2RGBA_UYVY,
676
COLOR_YUV2BGRA_UYNV = COLOR_YUV2BGRA_UYVY,
677
678
COLOR_YUV2RGB_YUY2 = 115,
679
COLOR_YUV2BGR_YUY2 = 116,
680
COLOR_YUV2RGB_YVYU = 117,
681
COLOR_YUV2BGR_YVYU = 118,
682
COLOR_YUV2RGB_YUYV = COLOR_YUV2RGB_YUY2,
683
COLOR_YUV2BGR_YUYV = COLOR_YUV2BGR_YUY2,
684
COLOR_YUV2RGB_YUNV = COLOR_YUV2RGB_YUY2,
685
COLOR_YUV2BGR_YUNV = COLOR_YUV2BGR_YUY2,
686
687
COLOR_YUV2RGBA_YUY2 = 119,
688
COLOR_YUV2BGRA_YUY2 = 120,
689
COLOR_YUV2RGBA_YVYU = 121,
690
COLOR_YUV2BGRA_YVYU = 122,
691
COLOR_YUV2RGBA_YUYV = COLOR_YUV2RGBA_YUY2,
692
COLOR_YUV2BGRA_YUYV = COLOR_YUV2BGRA_YUY2,
693
COLOR_YUV2RGBA_YUNV = COLOR_YUV2RGBA_YUY2,
694
COLOR_YUV2BGRA_YUNV = COLOR_YUV2BGRA_YUY2,
695
696
COLOR_YUV2GRAY_UYVY = 123,
697
COLOR_YUV2GRAY_YUY2 = 124,
698
//CV_YUV2GRAY_VYUY = CV_YUV2GRAY_UYVY,
699
COLOR_YUV2GRAY_Y422 = COLOR_YUV2GRAY_UYVY,
700
COLOR_YUV2GRAY_UYNV = COLOR_YUV2GRAY_UYVY,
701
COLOR_YUV2GRAY_YVYU = COLOR_YUV2GRAY_YUY2,
702
COLOR_YUV2GRAY_YUYV = COLOR_YUV2GRAY_YUY2,
703
COLOR_YUV2GRAY_YUNV = COLOR_YUV2GRAY_YUY2,
704
705
//! alpha premultiplication
706
COLOR_RGBA2mRGBA = 125,
707
COLOR_mRGBA2RGBA = 126,
708
709
//! RGB to YUV 4:2:0 family
710
COLOR_RGB2YUV_I420 = 127,
711
COLOR_BGR2YUV_I420 = 128,
712
COLOR_RGB2YUV_IYUV = COLOR_RGB2YUV_I420,
713
COLOR_BGR2YUV_IYUV = COLOR_BGR2YUV_I420,
714
715
COLOR_RGBA2YUV_I420 = 129,
716
COLOR_BGRA2YUV_I420 = 130,
717
COLOR_RGBA2YUV_IYUV = COLOR_RGBA2YUV_I420,
718
COLOR_BGRA2YUV_IYUV = COLOR_BGRA2YUV_I420,
719
COLOR_RGB2YUV_YV12 = 131,
720
COLOR_BGR2YUV_YV12 = 132,
721
COLOR_RGBA2YUV_YV12 = 133,
722
COLOR_BGRA2YUV_YV12 = 134,
723
724
//! Demosaicing
725
COLOR_BayerBG2BGR = 46,
726
COLOR_BayerGB2BGR = 47,
727
COLOR_BayerRG2BGR = 48,
728
COLOR_BayerGR2BGR = 49,
729
730
COLOR_BayerBG2RGB = COLOR_BayerRG2BGR,
731
COLOR_BayerGB2RGB = COLOR_BayerGR2BGR,
732
COLOR_BayerRG2RGB = COLOR_BayerBG2BGR,
733
COLOR_BayerGR2RGB = COLOR_BayerGB2BGR,
734
735
COLOR_BayerBG2GRAY = 86,
736
COLOR_BayerGB2GRAY = 87,
737
COLOR_BayerRG2GRAY = 88,
738
COLOR_BayerGR2GRAY = 89,
739
740
//! Demosaicing using Variable Number of Gradients
741
COLOR_BayerBG2BGR_VNG = 62,
742
COLOR_BayerGB2BGR_VNG = 63,
743
COLOR_BayerRG2BGR_VNG = 64,
744
COLOR_BayerGR2BGR_VNG = 65,
745
746
COLOR_BayerBG2RGB_VNG = COLOR_BayerRG2BGR_VNG,
747
COLOR_BayerGB2RGB_VNG = COLOR_BayerGR2BGR_VNG,
748
COLOR_BayerRG2RGB_VNG = COLOR_BayerBG2BGR_VNG,
749
COLOR_BayerGR2RGB_VNG = COLOR_BayerGB2BGR_VNG,
750
751
//! Edge-Aware Demosaicing
752
COLOR_BayerBG2BGR_EA = 135,
753
COLOR_BayerGB2BGR_EA = 136,
754
COLOR_BayerRG2BGR_EA = 137,
755
COLOR_BayerGR2BGR_EA = 138,
756
757
COLOR_BayerBG2RGB_EA = COLOR_BayerRG2BGR_EA,
758
COLOR_BayerGB2RGB_EA = COLOR_BayerGR2BGR_EA,
759
COLOR_BayerRG2RGB_EA = COLOR_BayerBG2BGR_EA,
760
COLOR_BayerGR2RGB_EA = COLOR_BayerGB2BGR_EA,
761
762
//! Demosaicing with alpha channel
763
COLOR_BayerBG2BGRA = 139,
764
COLOR_BayerGB2BGRA = 140,
765
COLOR_BayerRG2BGRA = 141,
766
COLOR_BayerGR2BGRA = 142,
767
768
COLOR_BayerBG2RGBA = COLOR_BayerRG2BGRA,
769
COLOR_BayerGB2RGBA = COLOR_BayerGR2BGRA,
770
COLOR_BayerRG2RGBA = COLOR_BayerBG2BGRA,
771
COLOR_BayerGR2RGBA = COLOR_BayerGB2BGRA,
772
773
COLOR_COLORCVT_MAX = 143
774
};
775
776
/** types of intersection between rectangles
777
@ingroup imgproc_shape
778
*/
779
enum RectanglesIntersectTypes {
780
INTERSECT_NONE = 0, //!< No intersection
781
INTERSECT_PARTIAL = 1, //!< There is a partial intersection
782
INTERSECT_FULL = 2 //!< One of the rectangle is fully enclosed in the other
783
};
784
785
786
/** types of line
787
@ingroup imgproc_draw
788
*/
789
enum LineTypes {
790
FILLED = -1,
791
LINE_4 = 4, //!< 4-connected line
792
LINE_8 = 8, //!< 8-connected line
793
LINE_AA = 16 //!< antialiased line
794
};
795
796
/** Only a subset of Hershey fonts <https://en.wikipedia.org/wiki/Hershey_fonts> are supported
797
@ingroup imgproc_draw
798
*/
799
enum HersheyFonts {
800
FONT_HERSHEY_SIMPLEX = 0, //!< normal size sans-serif font
801
FONT_HERSHEY_PLAIN = 1, //!< small size sans-serif font
802
FONT_HERSHEY_DUPLEX = 2, //!< normal size sans-serif font (more complex than FONT_HERSHEY_SIMPLEX)
803
FONT_HERSHEY_COMPLEX = 3, //!< normal size serif font
804
FONT_HERSHEY_TRIPLEX = 4, //!< normal size serif font (more complex than FONT_HERSHEY_COMPLEX)
805
FONT_HERSHEY_COMPLEX_SMALL = 5, //!< smaller version of FONT_HERSHEY_COMPLEX
806
FONT_HERSHEY_SCRIPT_SIMPLEX = 6, //!< hand-writing style font
807
FONT_HERSHEY_SCRIPT_COMPLEX = 7, //!< more complex variant of FONT_HERSHEY_SCRIPT_SIMPLEX
808
FONT_ITALIC = 16 //!< flag for italic font
809
};
810
811
/** Possible set of marker types used for the cv::drawMarker function
812
@ingroup imgproc_draw
813
*/
814
enum MarkerTypes
815
{
816
MARKER_CROSS = 0, //!< A crosshair marker shape
817
MARKER_TILTED_CROSS = 1, //!< A 45 degree tilted crosshair marker shape
818
MARKER_STAR = 2, //!< A star marker shape, combination of cross and tilted cross
819
MARKER_DIAMOND = 3, //!< A diamond marker shape
820
MARKER_SQUARE = 4, //!< A square marker shape
821
MARKER_TRIANGLE_UP = 5, //!< An upwards pointing triangle marker shape
822
MARKER_TRIANGLE_DOWN = 6 //!< A downwards pointing triangle marker shape
823
};
824
825
//! finds arbitrary template in the grayscale image using Generalized Hough Transform
826
class CV_EXPORTS_W GeneralizedHough : public Algorithm
827
{
828
public:
829
//! set template to search
830
CV_WRAP virtual void setTemplate(InputArray templ, Point templCenter = Point(-1, -1)) = 0;
831
CV_WRAP virtual void setTemplate(InputArray edges, InputArray dx, InputArray dy, Point templCenter = Point(-1, -1)) = 0;
832
833
//! find template on image
834
CV_WRAP virtual void detect(InputArray image, OutputArray positions, OutputArray votes = noArray()) = 0;
835
CV_WRAP virtual void detect(InputArray edges, InputArray dx, InputArray dy, OutputArray positions, OutputArray votes = noArray()) = 0;
836
837
//! Canny low threshold.
838
CV_WRAP virtual void setCannyLowThresh(int cannyLowThresh) = 0;
839
CV_WRAP virtual int getCannyLowThresh() const = 0;
840
841
//! Canny high threshold.
842
CV_WRAP virtual void setCannyHighThresh(int cannyHighThresh) = 0;
843
CV_WRAP virtual int getCannyHighThresh() const = 0;
844
845
//! Minimum distance between the centers of the detected objects.
846
CV_WRAP virtual void setMinDist(double minDist) = 0;
847
CV_WRAP virtual double getMinDist() const = 0;
848
849
//! Inverse ratio of the accumulator resolution to the image resolution.
850
CV_WRAP virtual void setDp(double dp) = 0;
851
CV_WRAP virtual double getDp() const = 0;
852
853
//! Maximal size of inner buffers.
854
CV_WRAP virtual void setMaxBufferSize(int maxBufferSize) = 0;
855
CV_WRAP virtual int getMaxBufferSize() const = 0;
856
};
857
858
//! Ballard, D.H. (1981). Generalizing the Hough transform to detect arbitrary shapes. Pattern Recognition 13 (2): 111-122.
859
//! Detects position only without translation and rotation
860
class CV_EXPORTS_W GeneralizedHoughBallard : public GeneralizedHough
861
{
862
public:
863
//! R-Table levels.
864
CV_WRAP virtual void setLevels(int levels) = 0;
865
CV_WRAP virtual int getLevels() const = 0;
866
867
//! The accumulator threshold for the template centers at the detection stage. The smaller it is, the more false positions may be detected.
868
CV_WRAP virtual void setVotesThreshold(int votesThreshold) = 0;
869
CV_WRAP virtual int getVotesThreshold() const = 0;
870
};
871
872
//! Guil, N., González-Linares, J.M. and Zapata, E.L. (1999). Bidimensional shape detection using an invariant approach. Pattern Recognition 32 (6): 1025-1038.
873
//! Detects position, translation and rotation
874
class CV_EXPORTS_W GeneralizedHoughGuil : public GeneralizedHough
875
{
876
public:
877
//! Angle difference in degrees between two points in feature.
878
virtual void setXi(double xi) = 0;
879
virtual double getXi() const = 0;
880
881
//! Feature table levels.
882
virtual void setLevels(int levels) = 0;
883
virtual int getLevels() const = 0;
884
885
//! Maximal difference between angles that treated as equal.
886
virtual void setAngleEpsilon(double angleEpsilon) = 0;
887
virtual double getAngleEpsilon() const = 0;
888
889
//! Minimal rotation angle to detect in degrees.
890
virtual void setMinAngle(double minAngle) = 0;
891
virtual double getMinAngle() const = 0;
892
893
//! Maximal rotation angle to detect in degrees.
894
virtual void setMaxAngle(double maxAngle) = 0;
895
virtual double getMaxAngle() const = 0;
896
897
//! Angle step in degrees.
898
virtual void setAngleStep(double angleStep) = 0;
899
virtual double getAngleStep() const = 0;
900
901
//! Angle votes threshold.
902
virtual void setAngleThresh(int angleThresh) = 0;
903
virtual int getAngleThresh() const = 0;
904
905
//! Minimal scale to detect.
906
virtual void setMinScale(double minScale) = 0;
907
virtual double getMinScale() const = 0;
908
909
//! Maximal scale to detect.
910
virtual void setMaxScale(double maxScale) = 0;
911
virtual double getMaxScale() const = 0;
912
913
//! Scale step.
914
virtual void setScaleStep(double scaleStep) = 0;
915
virtual double getScaleStep() const = 0;
916
917
//! Scale votes threshold.
918
virtual void setScaleThresh(int scaleThresh) = 0;
919
virtual int getScaleThresh() const = 0;
920
921
//! Position votes threshold.
922
virtual void setPosThresh(int posThresh) = 0;
923
virtual int getPosThresh() const = 0;
924
};
925
926
/** @brief Base class for Contrast Limited Adaptive Histogram Equalization. :
927
*/
928
class CV_EXPORTS_W CLAHE : public Algorithm
929
{
930
public:
931
/** @brief Equalizes the histogram of a grayscale image using Contrast Limited Adaptive Histogram Equalization.
932
933
@param src Source image with CV_8UC1 type.
934
@param dst Destination image.
935
*/
936
CV_WRAP virtual void apply(InputArray src, OutputArray dst) = 0;
937
938
/** @brief Sets threshold for contrast limiting.
939
940
@param clipLimit threshold value.
941
*/
942
CV_WRAP virtual void setClipLimit(double clipLimit) = 0;
943
944
//! Returns threshold value for contrast limiting.
945
CV_WRAP virtual double getClipLimit() const = 0;
946
947
/** @brief Sets size of grid for histogram equalization. Input image will be divided into
948
equally sized rectangular tiles.
949
950
@param tileGridSize defines the number of tiles in row and column.
951
*/
952
CV_WRAP virtual void setTilesGridSize(Size tileGridSize) = 0;
953
954
//!@brief Returns Size defines the number of tiles in row and column.
955
CV_WRAP virtual Size getTilesGridSize() const = 0;
956
957
CV_WRAP virtual void collectGarbage() = 0;
958
};
959
960
961
//! @addtogroup imgproc_subdiv2d
962
//! @{
963
964
class CV_EXPORTS_W Subdiv2D
965
{
966
public:
967
/** Subdiv2D point location cases */
968
enum { PTLOC_ERROR = -2, //!< Point location error
969
PTLOC_OUTSIDE_RECT = -1, //!< Point outside the subdivision bounding rect
970
PTLOC_INSIDE = 0, //!< Point inside some facet
971
PTLOC_VERTEX = 1, //!< Point coincides with one of the subdivision vertices
972
PTLOC_ON_EDGE = 2 //!< Point on some edge
973
};
974
975
/** Subdiv2D edge type navigation (see: getEdge()) */
976
enum { NEXT_AROUND_ORG = 0x00,
977
NEXT_AROUND_DST = 0x22,
978
PREV_AROUND_ORG = 0x11,
979
PREV_AROUND_DST = 0x33,
980
NEXT_AROUND_LEFT = 0x13,
981
NEXT_AROUND_RIGHT = 0x31,
982
PREV_AROUND_LEFT = 0x20,
983
PREV_AROUND_RIGHT = 0x02
984
};
985
986
/** creates an empty Subdiv2D object.
987
To create a new empty Delaunay subdivision you need to use the #initDelaunay function.
988
*/
989
CV_WRAP Subdiv2D();
990
991
/** @overload
992
993
@param rect Rectangle that includes all of the 2D points that are to be added to the subdivision.
994
995
The function creates an empty Delaunay subdivision where 2D points can be added using the function
996
insert() . All of the points to be added must be within the specified rectangle, otherwise a runtime
997
error is raised.
998
*/
999
CV_WRAP Subdiv2D(Rect rect);
1000
1001
/** @brief Creates a new empty Delaunay subdivision
1002
1003
@param rect Rectangle that includes all of the 2D points that are to be added to the subdivision.
1004
1005
*/
1006
CV_WRAP void initDelaunay(Rect rect);
1007
1008
/** @brief Insert a single point into a Delaunay triangulation.
1009
1010
@param pt Point to insert.
1011
1012
The function inserts a single point into a subdivision and modifies the subdivision topology
1013
appropriately. If a point with the same coordinates exists already, no new point is added.
1014
@returns the ID of the point.
1015
1016
@note If the point is outside of the triangulation specified rect a runtime error is raised.
1017
*/
1018
CV_WRAP int insert(Point2f pt);
1019
1020
/** @brief Insert multiple points into a Delaunay triangulation.
1021
1022
@param ptvec Points to insert.
1023
1024
The function inserts a vector of points into a subdivision and modifies the subdivision topology
1025
appropriately.
1026
*/
1027
CV_WRAP void insert(const std::vector<Point2f>& ptvec);
1028
1029
/** @brief Returns the location of a point within a Delaunay triangulation.
1030
1031
@param pt Point to locate.
1032
@param edge Output edge that the point belongs to or is located to the right of it.
1033
@param vertex Optional output vertex the input point coincides with.
1034
1035
The function locates the input point within the subdivision and gives one of the triangle edges
1036
or vertices.
1037
1038
@returns an integer which specify one of the following five cases for point location:
1039
- The point falls into some facet. The function returns #PTLOC_INSIDE and edge will contain one of
1040
edges of the facet.
1041
- The point falls onto the edge. The function returns #PTLOC_ON_EDGE and edge will contain this edge.
1042
- The point coincides with one of the subdivision vertices. The function returns #PTLOC_VERTEX and
1043
vertex will contain a pointer to the vertex.
1044
- The point is outside the subdivision reference rectangle. The function returns #PTLOC_OUTSIDE_RECT
1045
and no pointers are filled.
1046
- One of input arguments is invalid. A runtime error is raised or, if silent or "parent" error
1047
processing mode is selected, #PTLOC_ERROR is returned.
1048
*/
1049
CV_WRAP int locate(Point2f pt, CV_OUT int& edge, CV_OUT int& vertex);
1050
1051
/** @brief Finds the subdivision vertex closest to the given point.
1052
1053
@param pt Input point.
1054
@param nearestPt Output subdivision vertex point.
1055
1056
The function is another function that locates the input point within the subdivision. It finds the
1057
subdivision vertex that is the closest to the input point. It is not necessarily one of vertices
1058
of the facet containing the input point, though the facet (located using locate() ) is used as a
1059
starting point.
1060
1061
@returns vertex ID.
1062
*/
1063
CV_WRAP int findNearest(Point2f pt, CV_OUT Point2f* nearestPt = 0);
1064
1065
/** @brief Returns a list of all edges.
1066
1067
@param edgeList Output vector.
1068
1069
The function gives each edge as a 4 numbers vector, where each two are one of the edge
1070
vertices. i.e. org_x = v[0], org_y = v[1], dst_x = v[2], dst_y = v[3].
1071
*/
1072
CV_WRAP void getEdgeList(CV_OUT std::vector<Vec4f>& edgeList) const;
1073
1074
/** @brief Returns a list of the leading edge ID connected to each triangle.
1075
1076
@param leadingEdgeList Output vector.
1077
1078
The function gives one edge ID for each triangle.
1079
*/
1080
CV_WRAP void getLeadingEdgeList(CV_OUT std::vector<int>& leadingEdgeList) const;
1081
1082
/** @brief Returns a list of all triangles.
1083
1084
@param triangleList Output vector.
1085
1086
The function gives each triangle as a 6 numbers vector, where each two are one of the triangle
1087
vertices. i.e. p1_x = v[0], p1_y = v[1], p2_x = v[2], p2_y = v[3], p3_x = v[4], p3_y = v[5].
1088
*/
1089
CV_WRAP void getTriangleList(CV_OUT std::vector<Vec6f>& triangleList) const;
1090
1091
/** @brief Returns a list of all Voroni facets.
1092
1093
@param idx Vector of vertices IDs to consider. For all vertices you can pass empty vector.
1094
@param facetList Output vector of the Voroni facets.
1095
@param facetCenters Output vector of the Voroni facets center points.
1096
1097
*/
1098
CV_WRAP void getVoronoiFacetList(const std::vector<int>& idx, CV_OUT std::vector<std::vector<Point2f> >& facetList,
1099
CV_OUT std::vector<Point2f>& facetCenters);
1100
1101
/** @brief Returns vertex location from vertex ID.
1102
1103
@param vertex vertex ID.
1104
@param firstEdge Optional. The first edge ID which is connected to the vertex.
1105
@returns vertex (x,y)
1106
1107
*/
1108
CV_WRAP Point2f getVertex(int vertex, CV_OUT int* firstEdge = 0) const;
1109
1110
/** @brief Returns one of the edges related to the given edge.
1111
1112
@param edge Subdivision edge ID.
1113
@param nextEdgeType Parameter specifying which of the related edges to return.
1114
The following values are possible:
1115
- NEXT_AROUND_ORG next around the edge origin ( eOnext on the picture below if e is the input edge)
1116
- NEXT_AROUND_DST next around the edge vertex ( eDnext )
1117
- PREV_AROUND_ORG previous around the edge origin (reversed eRnext )
1118
- PREV_AROUND_DST previous around the edge destination (reversed eLnext )
1119
- NEXT_AROUND_LEFT next around the left facet ( eLnext )
1120
- NEXT_AROUND_RIGHT next around the right facet ( eRnext )
1121
- PREV_AROUND_LEFT previous around the left facet (reversed eOnext )
1122
- PREV_AROUND_RIGHT previous around the right facet (reversed eDnext )
1123
1124
![sample output](pics/quadedge.png)
1125
1126
@returns edge ID related to the input edge.
1127
*/
1128
CV_WRAP int getEdge( int edge, int nextEdgeType ) const;
1129
1130
/** @brief Returns next edge around the edge origin.
1131
1132
@param edge Subdivision edge ID.
1133
1134
@returns an integer which is next edge ID around the edge origin: eOnext on the
1135
picture above if e is the input edge).
1136
*/
1137
CV_WRAP int nextEdge(int edge) const;
1138
1139
/** @brief Returns another edge of the same quad-edge.
1140
1141
@param edge Subdivision edge ID.
1142
@param rotate Parameter specifying which of the edges of the same quad-edge as the input
1143
one to return. The following values are possible:
1144
- 0 - the input edge ( e on the picture below if e is the input edge)
1145
- 1 - the rotated edge ( eRot )
1146
- 2 - the reversed edge (reversed e (in green))
1147
- 3 - the reversed rotated edge (reversed eRot (in green))
1148
1149
@returns one of the edges ID of the same quad-edge as the input edge.
1150
*/
1151
CV_WRAP int rotateEdge(int edge, int rotate) const;
1152
CV_WRAP int symEdge(int edge) const;
1153
1154
/** @brief Returns the edge origin.
1155
1156
@param edge Subdivision edge ID.
1157
@param orgpt Output vertex location.
1158
1159
@returns vertex ID.
1160
*/
1161
CV_WRAP int edgeOrg(int edge, CV_OUT Point2f* orgpt = 0) const;
1162
1163
/** @brief Returns the edge destination.
1164
1165
@param edge Subdivision edge ID.
1166
@param dstpt Output vertex location.
1167
1168
@returns vertex ID.
1169
*/
1170
CV_WRAP int edgeDst(int edge, CV_OUT Point2f* dstpt = 0) const;
1171
1172
protected:
1173
int newEdge();
1174
void deleteEdge(int edge);
1175
int newPoint(Point2f pt, bool isvirtual, int firstEdge = 0);
1176
void deletePoint(int vtx);
1177
void setEdgePoints( int edge, int orgPt, int dstPt );
1178
void splice( int edgeA, int edgeB );
1179
int connectEdges( int edgeA, int edgeB );
1180
void swapEdges( int edge );
1181
int isRightOf(Point2f pt, int edge) const;
1182
void calcVoronoi();
1183
void clearVoronoi();
1184
void checkSubdiv() const;
1185
1186
struct CV_EXPORTS Vertex
1187
{
1188
Vertex();
1189
Vertex(Point2f pt, bool _isvirtual, int _firstEdge=0);
1190
bool isvirtual() const;
1191
bool isfree() const;
1192
1193
int firstEdge;
1194
int type;
1195
Point2f pt;
1196
};
1197
1198
struct CV_EXPORTS QuadEdge
1199
{
1200
QuadEdge();
1201
QuadEdge(int edgeidx);
1202
bool isfree() const;
1203
1204
int next[4];
1205
int pt[4];
1206
};
1207
1208
//! All of the vertices
1209
std::vector<Vertex> vtx;
1210
//! All of the edges
1211
std::vector<QuadEdge> qedges;
1212
int freeQEdge;
1213
int freePoint;
1214
bool validGeometry;
1215
1216
int recentEdge;
1217
//! Top left corner of the bounding rect
1218
Point2f topLeft;
1219
//! Bottom right corner of the bounding rect
1220
Point2f bottomRight;
1221
};
1222
1223
//! @} imgproc_subdiv2d
1224
1225
//! @addtogroup imgproc_feature
1226
//! @{
1227
1228
/** @example samples/cpp/lsd_lines.cpp
1229
An example using the LineSegmentDetector
1230
\image html building_lsd.png "Sample output image" width=434 height=300
1231
*/
1232
1233
/** @brief Line segment detector class
1234
1235
following the algorithm described at @cite Rafael12 .
1236
*/
1237
class CV_EXPORTS_W LineSegmentDetector : public Algorithm
1238
{
1239
public:
1240
1241
/** @brief Finds lines in the input image.
1242
1243
This is the output of the default parameters of the algorithm on the above shown image.
1244
1245
![image](pics/building_lsd.png)
1246
1247
@param _image A grayscale (CV_8UC1) input image. If only a roi needs to be selected, use:
1248
`lsd_ptr-\>detect(image(roi), lines, ...); lines += Scalar(roi.x, roi.y, roi.x, roi.y);`
1249
@param _lines A vector of Vec4i or Vec4f elements specifying the beginning and ending point of a line. Where
1250
Vec4i/Vec4f is (x1, y1, x2, y2), point 1 is the start, point 2 - end. Returned lines are strictly
1251
oriented depending on the gradient.
1252
@param width Vector of widths of the regions, where the lines are found. E.g. Width of line.
1253
@param prec Vector of precisions with which the lines are found.
1254
@param nfa Vector containing number of false alarms in the line region, with precision of 10%. The
1255
bigger the value, logarithmically better the detection.
1256
- -1 corresponds to 10 mean false alarms
1257
- 0 corresponds to 1 mean false alarm
1258
- 1 corresponds to 0.1 mean false alarms
1259
This vector will be calculated only when the objects type is #LSD_REFINE_ADV.
1260
*/
1261
CV_WRAP virtual void detect(InputArray _image, OutputArray _lines,
1262
OutputArray width = noArray(), OutputArray prec = noArray(),
1263
OutputArray nfa = noArray()) = 0;
1264
1265
/** @brief Draws the line segments on a given image.
1266
@param _image The image, where the lines will be drawn. Should be bigger or equal to the image,
1267
where the lines were found.
1268
@param lines A vector of the lines that needed to be drawn.
1269
*/
1270
CV_WRAP virtual void drawSegments(InputOutputArray _image, InputArray lines) = 0;
1271
1272
/** @brief Draws two groups of lines in blue and red, counting the non overlapping (mismatching) pixels.
1273
1274
@param size The size of the image, where lines1 and lines2 were found.
1275
@param lines1 The first group of lines that needs to be drawn. It is visualized in blue color.
1276
@param lines2 The second group of lines. They visualized in red color.
1277
@param _image Optional image, where the lines will be drawn. The image should be color(3-channel)
1278
in order for lines1 and lines2 to be drawn in the above mentioned colors.
1279
*/
1280
CV_WRAP virtual int compareSegments(const Size& size, InputArray lines1, InputArray lines2, InputOutputArray _image = noArray()) = 0;
1281
1282
virtual ~LineSegmentDetector() { }
1283
};
1284
1285
/** @brief Creates a smart pointer to a LineSegmentDetector object and initializes it.
1286
1287
The LineSegmentDetector algorithm is defined using the standard values. Only advanced users may want
1288
to edit those, as to tailor it for their own application.
1289
1290
@param _refine The way found lines will be refined, see #LineSegmentDetectorModes
1291
@param _scale The scale of the image that will be used to find the lines. Range (0..1].
1292
@param _sigma_scale Sigma for Gaussian filter. It is computed as sigma = _sigma_scale/_scale.
1293
@param _quant Bound to the quantization error on the gradient norm.
1294
@param _ang_th Gradient angle tolerance in degrees.
1295
@param _log_eps Detection threshold: -log10(NFA) \> log_eps. Used only when advance refinement
1296
is chosen.
1297
@param _density_th Minimal density of aligned region points in the enclosing rectangle.
1298
@param _n_bins Number of bins in pseudo-ordering of gradient modulus.
1299
*/
1300
CV_EXPORTS_W Ptr<LineSegmentDetector> createLineSegmentDetector(
1301
int _refine = LSD_REFINE_STD, double _scale = 0.8,
1302
double _sigma_scale = 0.6, double _quant = 2.0, double _ang_th = 22.5,
1303
double _log_eps = 0, double _density_th = 0.7, int _n_bins = 1024);
1304
1305
//! @} imgproc_feature
1306
1307
//! @addtogroup imgproc_filter
1308
//! @{
1309
1310
/** @brief Returns Gaussian filter coefficients.
1311
1312
The function computes and returns the \f$\texttt{ksize} \times 1\f$ matrix of Gaussian filter
1313
coefficients:
1314
1315
\f[G_i= \alpha *e^{-(i-( \texttt{ksize} -1)/2)^2/(2* \texttt{sigma}^2)},\f]
1316
1317
where \f$i=0..\texttt{ksize}-1\f$ and \f$\alpha\f$ is the scale factor chosen so that \f$\sum_i G_i=1\f$.
1318
1319
Two of such generated kernels can be passed to sepFilter2D. Those functions automatically recognize
1320
smoothing kernels (a symmetrical kernel with sum of weights equal to 1) and handle them accordingly.
1321
You may also use the higher-level GaussianBlur.
1322
@param ksize Aperture size. It should be odd ( \f$\texttt{ksize} \mod 2 = 1\f$ ) and positive.
1323
@param sigma Gaussian standard deviation. If it is non-positive, it is computed from ksize as
1324
`sigma = 0.3*((ksize-1)*0.5 - 1) + 0.8`.
1325
@param ktype Type of filter coefficients. It can be CV_32F or CV_64F .
1326
@sa sepFilter2D, getDerivKernels, getStructuringElement, GaussianBlur
1327
*/
1328
CV_EXPORTS_W Mat getGaussianKernel( int ksize, double sigma, int ktype = CV_64F );
1329
1330
/** @brief Returns filter coefficients for computing spatial image derivatives.
1331
1332
The function computes and returns the filter coefficients for spatial image derivatives. When
1333
`ksize=CV_SCHARR`, the Scharr \f$3 \times 3\f$ kernels are generated (see #Scharr). Otherwise, Sobel
1334
kernels are generated (see #Sobel). The filters are normally passed to #sepFilter2D or to
1335
1336
@param kx Output matrix of row filter coefficients. It has the type ktype .
1337
@param ky Output matrix of column filter coefficients. It has the type ktype .
1338
@param dx Derivative order in respect of x.
1339
@param dy Derivative order in respect of y.
1340
@param ksize Aperture size. It can be CV_SCHARR, 1, 3, 5, or 7.
1341
@param normalize Flag indicating whether to normalize (scale down) the filter coefficients or not.
1342
Theoretically, the coefficients should have the denominator \f$=2^{ksize*2-dx-dy-2}\f$. If you are
1343
going to filter floating-point images, you are likely to use the normalized kernels. But if you
1344
compute derivatives of an 8-bit image, store the results in a 16-bit image, and wish to preserve
1345
all the fractional bits, you may want to set normalize=false .
1346
@param ktype Type of filter coefficients. It can be CV_32f or CV_64F .
1347
*/
1348
CV_EXPORTS_W void getDerivKernels( OutputArray kx, OutputArray ky,
1349
int dx, int dy, int ksize,
1350
bool normalize = false, int ktype = CV_32F );
1351
1352
/** @brief Returns Gabor filter coefficients.
1353
1354
For more details about gabor filter equations and parameters, see: [Gabor
1355
Filter](http://en.wikipedia.org/wiki/Gabor_filter).
1356
1357
@param ksize Size of the filter returned.
1358
@param sigma Standard deviation of the gaussian envelope.
1359
@param theta Orientation of the normal to the parallel stripes of a Gabor function.
1360
@param lambd Wavelength of the sinusoidal factor.
1361
@param gamma Spatial aspect ratio.
1362
@param psi Phase offset.
1363
@param ktype Type of filter coefficients. It can be CV_32F or CV_64F .
1364
*/
1365
CV_EXPORTS_W Mat getGaborKernel( Size ksize, double sigma, double theta, double lambd,
1366
double gamma, double psi = CV_PI*0.5, int ktype = CV_64F );
1367
1368
//! returns "magic" border value for erosion and dilation. It is automatically transformed to Scalar::all(-DBL_MAX) for dilation.
1369
static inline Scalar morphologyDefaultBorderValue() { return Scalar::all(DBL_MAX); }
1370
1371
/** @brief Returns a structuring element of the specified size and shape for morphological operations.
1372
1373
The function constructs and returns the structuring element that can be further passed to #erode,
1374
#dilate or #morphologyEx. But you can also construct an arbitrary binary mask yourself and use it as
1375
the structuring element.
1376
1377
@param shape Element shape that could be one of #MorphShapes
1378
@param ksize Size of the structuring element.
1379
@param anchor Anchor position within the element. The default value \f$(-1, -1)\f$ means that the
1380
anchor is at the center. Note that only the shape of a cross-shaped element depends on the anchor
1381
position. In other cases the anchor just regulates how much the result of the morphological
1382
operation is shifted.
1383
*/
1384
CV_EXPORTS_W Mat getStructuringElement(int shape, Size ksize, Point anchor = Point(-1,-1));
1385
1386
/** @example samples/cpp/tutorial_code/ImgProc/Smoothing/Smoothing.cpp
1387
Sample code for simple filters
1388
![Sample screenshot](Smoothing_Tutorial_Result_Median_Filter.jpg)
1389
Check @ref tutorial_gausian_median_blur_bilateral_filter "the corresponding tutorial" for more details
1390
*/
1391
1392
/** @brief Blurs an image using the median filter.
1393
1394
The function smoothes an image using the median filter with the \f$\texttt{ksize} \times
1395
\texttt{ksize}\f$ aperture. Each channel of a multi-channel image is processed independently.
1396
In-place operation is supported.
1397
1398
@note The median filter uses #BORDER_REPLICATE internally to cope with border pixels, see #BorderTypes
1399
1400
@param src input 1-, 3-, or 4-channel image; when ksize is 3 or 5, the image depth should be
1401
CV_8U, CV_16U, or CV_32F, for larger aperture sizes, it can only be CV_8U.
1402
@param dst destination array of the same size and type as src.
1403
@param ksize aperture linear size; it must be odd and greater than 1, for example: 3, 5, 7 ...
1404
@sa bilateralFilter, blur, boxFilter, GaussianBlur
1405
*/
1406
CV_EXPORTS_W void medianBlur( InputArray src, OutputArray dst, int ksize );
1407
1408
/** @brief Blurs an image using a Gaussian filter.
1409
1410
The function convolves the source image with the specified Gaussian kernel. In-place filtering is
1411
supported.
1412
1413
@param src input image; the image can have any number of channels, which are processed
1414
independently, but the depth should be CV_8U, CV_16U, CV_16S, CV_32F or CV_64F.
1415
@param dst output image of the same size and type as src.
1416
@param ksize Gaussian kernel size. ksize.width and ksize.height can differ but they both must be
1417
positive and odd. Or, they can be zero's and then they are computed from sigma.
1418
@param sigmaX Gaussian kernel standard deviation in X direction.
1419
@param sigmaY Gaussian kernel standard deviation in Y direction; if sigmaY is zero, it is set to be
1420
equal to sigmaX, if both sigmas are zeros, they are computed from ksize.width and ksize.height,
1421
respectively (see #getGaussianKernel for details); to fully control the result regardless of
1422
possible future modifications of all this semantics, it is recommended to specify all of ksize,
1423
sigmaX, and sigmaY.
1424
@param borderType pixel extrapolation method, see #BorderTypes
1425
1426
@sa sepFilter2D, filter2D, blur, boxFilter, bilateralFilter, medianBlur
1427
*/
1428
CV_EXPORTS_W void GaussianBlur( InputArray src, OutputArray dst, Size ksize,
1429
double sigmaX, double sigmaY = 0,
1430
int borderType = BORDER_DEFAULT );
1431
1432
/** @brief Applies the bilateral filter to an image.
1433
1434
The function applies bilateral filtering to the input image, as described in
1435
http://www.dai.ed.ac.uk/CVonline/LOCAL_COPIES/MANDUCHI1/Bilateral_Filtering.html
1436
bilateralFilter can reduce unwanted noise very well while keeping edges fairly sharp. However, it is
1437
very slow compared to most filters.
1438
1439
_Sigma values_: For simplicity, you can set the 2 sigma values to be the same. If they are small (\<
1440
10), the filter will not have much effect, whereas if they are large (\> 150), they will have a very
1441
strong effect, making the image look "cartoonish".
1442
1443
_Filter size_: Large filters (d \> 5) are very slow, so it is recommended to use d=5 for real-time
1444
applications, and perhaps d=9 for offline applications that need heavy noise filtering.
1445
1446
This filter does not work inplace.
1447
@param src Source 8-bit or floating-point, 1-channel or 3-channel image.
1448
@param dst Destination image of the same size and type as src .
1449
@param d Diameter of each pixel neighborhood that is used during filtering. If it is non-positive,
1450
it is computed from sigmaSpace.
1451
@param sigmaColor Filter sigma in the color space. A larger value of the parameter means that
1452
farther colors within the pixel neighborhood (see sigmaSpace) will be mixed together, resulting
1453
in larger areas of semi-equal color.
1454
@param sigmaSpace Filter sigma in the coordinate space. A larger value of the parameter means that
1455
farther pixels will influence each other as long as their colors are close enough (see sigmaColor
1456
). When d\>0, it specifies the neighborhood size regardless of sigmaSpace. Otherwise, d is
1457
proportional to sigmaSpace.
1458
@param borderType border mode used to extrapolate pixels outside of the image, see #BorderTypes
1459
*/
1460
CV_EXPORTS_W void bilateralFilter( InputArray src, OutputArray dst, int d,
1461
double sigmaColor, double sigmaSpace,
1462
int borderType = BORDER_DEFAULT );
1463
1464
/** @brief Blurs an image using the box filter.
1465
1466
The function smooths an image using the kernel:
1467
1468
\f[\texttt{K} = \alpha \begin{bmatrix} 1 & 1 & 1 & \cdots & 1 & 1 \\ 1 & 1 & 1 & \cdots & 1 & 1 \\ \hdotsfor{6} \\ 1 & 1 & 1 & \cdots & 1 & 1 \end{bmatrix}\f]
1469
1470
where
1471
1472
\f[\alpha = \fork{\frac{1}{\texttt{ksize.width*ksize.height}}}{when \texttt{normalize=true}}{1}{otherwise}\f]
1473
1474
Unnormalized box filter is useful for computing various integral characteristics over each pixel
1475
neighborhood, such as covariance matrices of image derivatives (used in dense optical flow
1476
algorithms, and so on). If you need to compute pixel sums over variable-size windows, use #integral.
1477
1478
@param src input image.
1479
@param dst output image of the same size and type as src.
1480
@param ddepth the output image depth (-1 to use src.depth()).
1481
@param ksize blurring kernel size.
1482
@param anchor anchor point; default value Point(-1,-1) means that the anchor is at the kernel
1483
center.
1484
@param normalize flag, specifying whether the kernel is normalized by its area or not.
1485
@param borderType border mode used to extrapolate pixels outside of the image, see #BorderTypes
1486
@sa blur, bilateralFilter, GaussianBlur, medianBlur, integral
1487
*/
1488
CV_EXPORTS_W void boxFilter( InputArray src, OutputArray dst, int ddepth,
1489
Size ksize, Point anchor = Point(-1,-1),
1490
bool normalize = true,
1491
int borderType = BORDER_DEFAULT );
1492
1493
/** @brief Calculates the normalized sum of squares of the pixel values overlapping the filter.
1494
1495
For every pixel \f$ (x, y) \f$ in the source image, the function calculates the sum of squares of those neighboring
1496
pixel values which overlap the filter placed over the pixel \f$ (x, y) \f$.
1497
1498
The unnormalized square box filter can be useful in computing local image statistics such as the the local
1499
variance and standard deviation around the neighborhood of a pixel.
1500
1501
@param _src input image
1502
@param _dst output image of the same size and type as _src
1503
@param ddepth the output image depth (-1 to use src.depth())
1504
@param ksize kernel size
1505
@param anchor kernel anchor point. The default value of Point(-1, -1) denotes that the anchor is at the kernel
1506
center.
1507
@param normalize flag, specifying whether the kernel is to be normalized by it's area or not.
1508
@param borderType border mode used to extrapolate pixels outside of the image, see #BorderTypes
1509
@sa boxFilter
1510
*/
1511
CV_EXPORTS_W void sqrBoxFilter( InputArray _src, OutputArray _dst, int ddepth,
1512
Size ksize, Point anchor = Point(-1, -1),
1513
bool normalize = true,
1514
int borderType = BORDER_DEFAULT );
1515
1516
/** @brief Blurs an image using the normalized box filter.
1517
1518
The function smooths an image using the kernel:
1519
1520
\f[\texttt{K} = \frac{1}{\texttt{ksize.width*ksize.height}} \begin{bmatrix} 1 & 1 & 1 & \cdots & 1 & 1 \\ 1 & 1 & 1 & \cdots & 1 & 1 \\ \hdotsfor{6} \\ 1 & 1 & 1 & \cdots & 1 & 1 \\ \end{bmatrix}\f]
1521
1522
The call `blur(src, dst, ksize, anchor, borderType)` is equivalent to `boxFilter(src, dst, src.type(),
1523
anchor, true, borderType)`.
1524
1525
@param src input image; it can have any number of channels, which are processed independently, but
1526
the depth should be CV_8U, CV_16U, CV_16S, CV_32F or CV_64F.
1527
@param dst output image of the same size and type as src.
1528
@param ksize blurring kernel size.
1529
@param anchor anchor point; default value Point(-1,-1) means that the anchor is at the kernel
1530
center.
1531
@param borderType border mode used to extrapolate pixels outside of the image, see #BorderTypes
1532
@sa boxFilter, bilateralFilter, GaussianBlur, medianBlur
1533
*/
1534
CV_EXPORTS_W void blur( InputArray src, OutputArray dst,
1535
Size ksize, Point anchor = Point(-1,-1),
1536
int borderType = BORDER_DEFAULT );
1537
1538
/** @brief Convolves an image with the kernel.
1539
1540
The function applies an arbitrary linear filter to an image. In-place operation is supported. When
1541
the aperture is partially outside the image, the function interpolates outlier pixel values
1542
according to the specified border mode.
1543
1544
The function does actually compute correlation, not the convolution:
1545
1546
\f[\texttt{dst} (x,y) = \sum _{ \stackrel{0\leq x' < \texttt{kernel.cols},}{0\leq y' < \texttt{kernel.rows}} } \texttt{kernel} (x',y')* \texttt{src} (x+x'- \texttt{anchor.x} ,y+y'- \texttt{anchor.y} )\f]
1547
1548
That is, the kernel is not mirrored around the anchor point. If you need a real convolution, flip
1549
the kernel using #flip and set the new anchor to `(kernel.cols - anchor.x - 1, kernel.rows -
1550
anchor.y - 1)`.
1551
1552
The function uses the DFT-based algorithm in case of sufficiently large kernels (~`11 x 11` or
1553
larger) and the direct algorithm for small kernels.
1554
1555
@param src input image.
1556
@param dst output image of the same size and the same number of channels as src.
1557
@param ddepth desired depth of the destination image, see @ref filter_depths "combinations"
1558
@param kernel convolution kernel (or rather a correlation kernel), a single-channel floating point
1559
matrix; if you want to apply different kernels to different channels, split the image into
1560
separate color planes using split and process them individually.
1561
@param anchor anchor of the kernel that indicates the relative position of a filtered point within
1562
the kernel; the anchor should lie within the kernel; default value (-1,-1) means that the anchor
1563
is at the kernel center.
1564
@param delta optional value added to the filtered pixels before storing them in dst.
1565
@param borderType pixel extrapolation method, see #BorderTypes
1566
@sa sepFilter2D, dft, matchTemplate
1567
*/
1568
CV_EXPORTS_W void filter2D( InputArray src, OutputArray dst, int ddepth,
1569
InputArray kernel, Point anchor = Point(-1,-1),
1570
double delta = 0, int borderType = BORDER_DEFAULT );
1571
1572
/** @brief Applies a separable linear filter to an image.
1573
1574
The function applies a separable linear filter to the image. That is, first, every row of src is
1575
filtered with the 1D kernel kernelX. Then, every column of the result is filtered with the 1D
1576
kernel kernelY. The final result shifted by delta is stored in dst .
1577
1578
@param src Source image.
1579
@param dst Destination image of the same size and the same number of channels as src .
1580
@param ddepth Destination image depth, see @ref filter_depths "combinations"
1581
@param kernelX Coefficients for filtering each row.
1582
@param kernelY Coefficients for filtering each column.
1583
@param anchor Anchor position within the kernel. The default value \f$(-1,-1)\f$ means that the anchor
1584
is at the kernel center.
1585
@param delta Value added to the filtered results before storing them.
1586
@param borderType Pixel extrapolation method, see #BorderTypes
1587
@sa filter2D, Sobel, GaussianBlur, boxFilter, blur
1588
*/
1589
CV_EXPORTS_W void sepFilter2D( InputArray src, OutputArray dst, int ddepth,
1590
InputArray kernelX, InputArray kernelY,
1591
Point anchor = Point(-1,-1),
1592
double delta = 0, int borderType = BORDER_DEFAULT );
1593
1594
/** @example samples/cpp/tutorial_code/ImgTrans/Sobel_Demo.cpp
1595
Sample code using Sobel and/or Scharr OpenCV functions to make a simple Edge Detector
1596
![Sample screenshot](Sobel_Derivatives_Tutorial_Result.jpg)
1597
Check @ref tutorial_sobel_derivatives "the corresponding tutorial" for more details
1598
*/
1599
1600
/** @brief Calculates the first, second, third, or mixed image derivatives using an extended Sobel operator.
1601
1602
In all cases except one, the \f$\texttt{ksize} \times \texttt{ksize}\f$ separable kernel is used to
1603
calculate the derivative. When \f$\texttt{ksize = 1}\f$, the \f$3 \times 1\f$ or \f$1 \times 3\f$
1604
kernel is used (that is, no Gaussian smoothing is done). `ksize = 1` can only be used for the first
1605
or the second x- or y- derivatives.
1606
1607
There is also the special value `ksize = #CV_SCHARR (-1)` that corresponds to the \f$3\times3\f$ Scharr
1608
filter that may give more accurate results than the \f$3\times3\f$ Sobel. The Scharr aperture is
1609
1610
\f[\vecthreethree{-3}{0}{3}{-10}{0}{10}{-3}{0}{3}\f]
1611
1612
for the x-derivative, or transposed for the y-derivative.
1613
1614
The function calculates an image derivative by convolving the image with the appropriate kernel:
1615
1616
\f[\texttt{dst} = \frac{\partial^{xorder+yorder} \texttt{src}}{\partial x^{xorder} \partial y^{yorder}}\f]
1617
1618
The Sobel operators combine Gaussian smoothing and differentiation, so the result is more or less
1619
resistant to the noise. Most often, the function is called with ( xorder = 1, yorder = 0, ksize = 3)
1620
or ( xorder = 0, yorder = 1, ksize = 3) to calculate the first x- or y- image derivative. The first
1621
case corresponds to a kernel of:
1622
1623
\f[\vecthreethree{-1}{0}{1}{-2}{0}{2}{-1}{0}{1}\f]
1624
1625
The second case corresponds to a kernel of:
1626
1627
\f[\vecthreethree{-1}{-2}{-1}{0}{0}{0}{1}{2}{1}\f]
1628
1629
@param src input image.
1630
@param dst output image of the same size and the same number of channels as src .
1631
@param ddepth output image depth, see @ref filter_depths "combinations"; in the case of
1632
8-bit input images it will result in truncated derivatives.
1633
@param dx order of the derivative x.
1634
@param dy order of the derivative y.
1635
@param ksize size of the extended Sobel kernel; it must be 1, 3, 5, or 7.
1636
@param scale optional scale factor for the computed derivative values; by default, no scaling is
1637
applied (see #getDerivKernels for details).
1638
@param delta optional delta value that is added to the results prior to storing them in dst.
1639
@param borderType pixel extrapolation method, see #BorderTypes
1640
@sa Scharr, Laplacian, sepFilter2D, filter2D, GaussianBlur, cartToPolar
1641
*/
1642
CV_EXPORTS_W void Sobel( InputArray src, OutputArray dst, int ddepth,
1643
int dx, int dy, int ksize = 3,
1644
double scale = 1, double delta = 0,
1645
int borderType = BORDER_DEFAULT );
1646
1647
/** @brief Calculates the first order image derivative in both x and y using a Sobel operator
1648
1649
Equivalent to calling:
1650
1651
@code
1652
Sobel( src, dx, CV_16SC1, 1, 0, 3 );
1653
Sobel( src, dy, CV_16SC1, 0, 1, 3 );
1654
@endcode
1655
1656
@param src input image.
1657
@param dx output image with first-order derivative in x.
1658
@param dy output image with first-order derivative in y.
1659
@param ksize size of Sobel kernel. It must be 3.
1660
@param borderType pixel extrapolation method, see #BorderTypes
1661
1662
@sa Sobel
1663
*/
1664
1665
CV_EXPORTS_W void spatialGradient( InputArray src, OutputArray dx,
1666
OutputArray dy, int ksize = 3,
1667
int borderType = BORDER_DEFAULT );
1668
1669
/** @brief Calculates the first x- or y- image derivative using Scharr operator.
1670
1671
The function computes the first x- or y- spatial image derivative using the Scharr operator. The
1672
call
1673
1674
\f[\texttt{Scharr(src, dst, ddepth, dx, dy, scale, delta, borderType)}\f]
1675
1676
is equivalent to
1677
1678
\f[\texttt{Sobel(src, dst, ddepth, dx, dy, CV_SCHARR, scale, delta, borderType)} .\f]
1679
1680
@param src input image.
1681
@param dst output image of the same size and the same number of channels as src.
1682
@param ddepth output image depth, see @ref filter_depths "combinations"
1683
@param dx order of the derivative x.
1684
@param dy order of the derivative y.
1685
@param scale optional scale factor for the computed derivative values; by default, no scaling is
1686
applied (see #getDerivKernels for details).
1687
@param delta optional delta value that is added to the results prior to storing them in dst.
1688
@param borderType pixel extrapolation method, see #BorderTypes
1689
@sa cartToPolar
1690
*/
1691
CV_EXPORTS_W void Scharr( InputArray src, OutputArray dst, int ddepth,
1692
int dx, int dy, double scale = 1, double delta = 0,
1693
int borderType = BORDER_DEFAULT );
1694
1695
/** @example samples/cpp/laplace.cpp
1696
An example using Laplace transformations for edge detection
1697
*/
1698
1699
/** @brief Calculates the Laplacian of an image.
1700
1701
The function calculates the Laplacian of the source image by adding up the second x and y
1702
derivatives calculated using the Sobel operator:
1703
1704
\f[\texttt{dst} = \Delta \texttt{src} = \frac{\partial^2 \texttt{src}}{\partial x^2} + \frac{\partial^2 \texttt{src}}{\partial y^2}\f]
1705
1706
This is done when `ksize > 1`. When `ksize == 1`, the Laplacian is computed by filtering the image
1707
with the following \f$3 \times 3\f$ aperture:
1708
1709
\f[\vecthreethree {0}{1}{0}{1}{-4}{1}{0}{1}{0}\f]
1710
1711
@param src Source image.
1712
@param dst Destination image of the same size and the same number of channels as src .
1713
@param ddepth Desired depth of the destination image.
1714
@param ksize Aperture size used to compute the second-derivative filters. See #getDerivKernels for
1715
details. The size must be positive and odd.
1716
@param scale Optional scale factor for the computed Laplacian values. By default, no scaling is
1717
applied. See #getDerivKernels for details.
1718
@param delta Optional delta value that is added to the results prior to storing them in dst .
1719
@param borderType Pixel extrapolation method, see #BorderTypes
1720
@sa Sobel, Scharr
1721
*/
1722
CV_EXPORTS_W void Laplacian( InputArray src, OutputArray dst, int ddepth,
1723
int ksize = 1, double scale = 1, double delta = 0,
1724
int borderType = BORDER_DEFAULT );
1725
1726
//! @} imgproc_filter
1727
1728
//! @addtogroup imgproc_feature
1729
//! @{
1730
1731
/** @example samples/cpp/edge.cpp
1732
This program demonstrates usage of the Canny edge detector
1733
1734
Check @ref tutorial_canny_detector "the corresponding tutorial" for more details
1735
*/
1736
1737
/** @brief Finds edges in an image using the Canny algorithm @cite Canny86 .
1738
1739
The function finds edges in the input image and marks them in the output map edges using the
1740
Canny algorithm. The smallest value between threshold1 and threshold2 is used for edge linking. The
1741
largest value is used to find initial segments of strong edges. See
1742
<http://en.wikipedia.org/wiki/Canny_edge_detector>
1743
1744
@param image 8-bit input image.
1745
@param edges output edge map; single channels 8-bit image, which has the same size as image .
1746
@param threshold1 first threshold for the hysteresis procedure.
1747
@param threshold2 second threshold for the hysteresis procedure.
1748
@param apertureSize aperture size for the Sobel operator.
1749
@param L2gradient a flag, indicating whether a more accurate \f$L_2\f$ norm
1750
\f$=\sqrt{(dI/dx)^2 + (dI/dy)^2}\f$ should be used to calculate the image gradient magnitude (
1751
L2gradient=true ), or whether the default \f$L_1\f$ norm \f$=|dI/dx|+|dI/dy|\f$ is enough (
1752
L2gradient=false ).
1753
*/
1754
CV_EXPORTS_W void Canny( InputArray image, OutputArray edges,
1755
double threshold1, double threshold2,
1756
int apertureSize = 3, bool L2gradient = false );
1757
1758
/** \overload
1759
1760
Finds edges in an image using the Canny algorithm with custom image gradient.
1761
1762
@param dx 16-bit x derivative of input image (CV_16SC1 or CV_16SC3).
1763
@param dy 16-bit y derivative of input image (same type as dx).
1764
@param edges output edge map; single channels 8-bit image, which has the same size as image .
1765
@param threshold1 first threshold for the hysteresis procedure.
1766
@param threshold2 second threshold for the hysteresis procedure.
1767
@param L2gradient a flag, indicating whether a more accurate \f$L_2\f$ norm
1768
\f$=\sqrt{(dI/dx)^2 + (dI/dy)^2}\f$ should be used to calculate the image gradient magnitude (
1769
L2gradient=true ), or whether the default \f$L_1\f$ norm \f$=|dI/dx|+|dI/dy|\f$ is enough (
1770
L2gradient=false ).
1771
*/
1772
CV_EXPORTS_W void Canny( InputArray dx, InputArray dy,
1773
OutputArray edges,
1774
double threshold1, double threshold2,
1775
bool L2gradient = false );
1776
1777
/** @brief Calculates the minimal eigenvalue of gradient matrices for corner detection.
1778
1779
The function is similar to cornerEigenValsAndVecs but it calculates and stores only the minimal
1780
eigenvalue of the covariance matrix of derivatives, that is, \f$\min(\lambda_1, \lambda_2)\f$ in terms
1781
of the formulae in the cornerEigenValsAndVecs description.
1782
1783
@param src Input single-channel 8-bit or floating-point image.
1784
@param dst Image to store the minimal eigenvalues. It has the type CV_32FC1 and the same size as
1785
src .
1786
@param blockSize Neighborhood size (see the details on #cornerEigenValsAndVecs ).
1787
@param ksize Aperture parameter for the Sobel operator.
1788
@param borderType Pixel extrapolation method. See #BorderTypes.
1789
*/
1790
CV_EXPORTS_W void cornerMinEigenVal( InputArray src, OutputArray dst,
1791
int blockSize, int ksize = 3,
1792
int borderType = BORDER_DEFAULT );
1793
1794
/** @brief Harris corner detector.
1795
1796
The function runs the Harris corner detector on the image. Similarly to cornerMinEigenVal and
1797
cornerEigenValsAndVecs , for each pixel \f$(x, y)\f$ it calculates a \f$2\times2\f$ gradient covariance
1798
matrix \f$M^{(x,y)}\f$ over a \f$\texttt{blockSize} \times \texttt{blockSize}\f$ neighborhood. Then, it
1799
computes the following characteristic:
1800
1801
\f[\texttt{dst} (x,y) = \mathrm{det} M^{(x,y)} - k \cdot \left ( \mathrm{tr} M^{(x,y)} \right )^2\f]
1802
1803
Corners in the image can be found as the local maxima of this response map.
1804
1805
@param src Input single-channel 8-bit or floating-point image.
1806
@param dst Image to store the Harris detector responses. It has the type CV_32FC1 and the same
1807
size as src .
1808
@param blockSize Neighborhood size (see the details on #cornerEigenValsAndVecs ).
1809
@param ksize Aperture parameter for the Sobel operator.
1810
@param k Harris detector free parameter. See the formula above.
1811
@param borderType Pixel extrapolation method. See #BorderTypes.
1812
*/
1813
CV_EXPORTS_W void cornerHarris( InputArray src, OutputArray dst, int blockSize,
1814
int ksize, double k,
1815
int borderType = BORDER_DEFAULT );
1816
1817
/** @brief Calculates eigenvalues and eigenvectors of image blocks for corner detection.
1818
1819
For every pixel \f$p\f$ , the function cornerEigenValsAndVecs considers a blockSize \f$\times\f$ blockSize
1820
neighborhood \f$S(p)\f$ . It calculates the covariation matrix of derivatives over the neighborhood as:
1821
1822
\f[M = \begin{bmatrix} \sum _{S(p)}(dI/dx)^2 & \sum _{S(p)}dI/dx dI/dy \\ \sum _{S(p)}dI/dx dI/dy & \sum _{S(p)}(dI/dy)^2 \end{bmatrix}\f]
1823
1824
where the derivatives are computed using the Sobel operator.
1825
1826
After that, it finds eigenvectors and eigenvalues of \f$M\f$ and stores them in the destination image as
1827
\f$(\lambda_1, \lambda_2, x_1, y_1, x_2, y_2)\f$ where
1828
1829
- \f$\lambda_1, \lambda_2\f$ are the non-sorted eigenvalues of \f$M\f$
1830
- \f$x_1, y_1\f$ are the eigenvectors corresponding to \f$\lambda_1\f$
1831
- \f$x_2, y_2\f$ are the eigenvectors corresponding to \f$\lambda_2\f$
1832
1833
The output of the function can be used for robust edge or corner detection.
1834
1835
@param src Input single-channel 8-bit or floating-point image.
1836
@param dst Image to store the results. It has the same size as src and the type CV_32FC(6) .
1837
@param blockSize Neighborhood size (see details below).
1838
@param ksize Aperture parameter for the Sobel operator.
1839
@param borderType Pixel extrapolation method. See #BorderTypes.
1840
1841
@sa cornerMinEigenVal, cornerHarris, preCornerDetect
1842
*/
1843
CV_EXPORTS_W void cornerEigenValsAndVecs( InputArray src, OutputArray dst,
1844
int blockSize, int ksize,
1845
int borderType = BORDER_DEFAULT );
1846
1847
/** @brief Calculates a feature map for corner detection.
1848
1849
The function calculates the complex spatial derivative-based function of the source image
1850
1851
\f[\texttt{dst} = (D_x \texttt{src} )^2 \cdot D_{yy} \texttt{src} + (D_y \texttt{src} )^2 \cdot D_{xx} \texttt{src} - 2 D_x \texttt{src} \cdot D_y \texttt{src} \cdot D_{xy} \texttt{src}\f]
1852
1853
where \f$D_x\f$,\f$D_y\f$ are the first image derivatives, \f$D_{xx}\f$,\f$D_{yy}\f$ are the second image
1854
derivatives, and \f$D_{xy}\f$ is the mixed derivative.
1855
1856
The corners can be found as local maximums of the functions, as shown below:
1857
@code
1858
Mat corners, dilated_corners;
1859
preCornerDetect(image, corners, 3);
1860
// dilation with 3x3 rectangular structuring element
1861
dilate(corners, dilated_corners, Mat(), 1);
1862
Mat corner_mask = corners == dilated_corners;
1863
@endcode
1864
1865
@param src Source single-channel 8-bit of floating-point image.
1866
@param dst Output image that has the type CV_32F and the same size as src .
1867
@param ksize %Aperture size of the Sobel .
1868
@param borderType Pixel extrapolation method. See #BorderTypes.
1869
*/
1870
CV_EXPORTS_W void preCornerDetect( InputArray src, OutputArray dst, int ksize,
1871
int borderType = BORDER_DEFAULT );
1872
1873
/** @brief Refines the corner locations.
1874
1875
The function iterates to find the sub-pixel accurate location of corners or radial saddle points, as
1876
shown on the figure below.
1877
1878
![image](pics/cornersubpix.png)
1879
1880
Sub-pixel accurate corner locator is based on the observation that every vector from the center \f$q\f$
1881
to a point \f$p\f$ located within a neighborhood of \f$q\f$ is orthogonal to the image gradient at \f$p\f$
1882
subject to image and measurement noise. Consider the expression:
1883
1884
\f[\epsilon _i = {DI_{p_i}}^T \cdot (q - p_i)\f]
1885
1886
where \f${DI_{p_i}}\f$ is an image gradient at one of the points \f$p_i\f$ in a neighborhood of \f$q\f$ . The
1887
value of \f$q\f$ is to be found so that \f$\epsilon_i\f$ is minimized. A system of equations may be set up
1888
with \f$\epsilon_i\f$ set to zero:
1889
1890
\f[\sum _i(DI_{p_i} \cdot {DI_{p_i}}^T) \cdot q - \sum _i(DI_{p_i} \cdot {DI_{p_i}}^T \cdot p_i)\f]
1891
1892
where the gradients are summed within a neighborhood ("search window") of \f$q\f$ . Calling the first
1893
gradient term \f$G\f$ and the second gradient term \f$b\f$ gives:
1894
1895
\f[q = G^{-1} \cdot b\f]
1896
1897
The algorithm sets the center of the neighborhood window at this new center \f$q\f$ and then iterates
1898
until the center stays within a set threshold.
1899
1900
@param image Input single-channel, 8-bit or float image.
1901
@param corners Initial coordinates of the input corners and refined coordinates provided for
1902
output.
1903
@param winSize Half of the side length of the search window. For example, if winSize=Size(5,5) ,
1904
then a \f$(5*2+1) \times (5*2+1) = 11 \times 11\f$ search window is used.
1905
@param zeroZone Half of the size of the dead region in the middle of the search zone over which
1906
the summation in the formula below is not done. It is used sometimes to avoid possible
1907
singularities of the autocorrelation matrix. The value of (-1,-1) indicates that there is no such
1908
a size.
1909
@param criteria Criteria for termination of the iterative process of corner refinement. That is,
1910
the process of corner position refinement stops either after criteria.maxCount iterations or when
1911
the corner position moves by less than criteria.epsilon on some iteration.
1912
*/
1913
CV_EXPORTS_W void cornerSubPix( InputArray image, InputOutputArray corners,
1914
Size winSize, Size zeroZone,
1915
TermCriteria criteria );
1916
1917
/** @brief Determines strong corners on an image.
1918
1919
The function finds the most prominent corners in the image or in the specified image region, as
1920
described in @cite Shi94
1921
1922
- Function calculates the corner quality measure at every source image pixel using the
1923
#cornerMinEigenVal or #cornerHarris .
1924
- Function performs a non-maximum suppression (the local maximums in *3 x 3* neighborhood are
1925
retained).
1926
- The corners with the minimal eigenvalue less than
1927
\f$\texttt{qualityLevel} \cdot \max_{x,y} qualityMeasureMap(x,y)\f$ are rejected.
1928
- The remaining corners are sorted by the quality measure in the descending order.
1929
- Function throws away each corner for which there is a stronger corner at a distance less than
1930
maxDistance.
1931
1932
The function can be used to initialize a point-based tracker of an object.
1933
1934
@note If the function is called with different values A and B of the parameter qualityLevel , and
1935
A \> B, the vector of returned corners with qualityLevel=A will be the prefix of the output vector
1936
with qualityLevel=B .
1937
1938
@param image Input 8-bit or floating-point 32-bit, single-channel image.
1939
@param corners Output vector of detected corners.
1940
@param maxCorners Maximum number of corners to return. If there are more corners than are found,
1941
the strongest of them is returned. `maxCorners <= 0` implies that no limit on the maximum is set
1942
and all detected corners are returned.
1943
@param qualityLevel Parameter characterizing the minimal accepted quality of image corners. The
1944
parameter value is multiplied by the best corner quality measure, which is the minimal eigenvalue
1945
(see #cornerMinEigenVal ) or the Harris function response (see #cornerHarris ). The corners with the
1946
quality measure less than the product are rejected. For example, if the best corner has the
1947
quality measure = 1500, and the qualityLevel=0.01 , then all the corners with the quality measure
1948
less than 15 are rejected.
1949
@param minDistance Minimum possible Euclidean distance between the returned corners.
1950
@param mask Optional region of interest. If the image is not empty (it needs to have the type
1951
CV_8UC1 and the same size as image ), it specifies the region in which the corners are detected.
1952
@param blockSize Size of an average block for computing a derivative covariation matrix over each
1953
pixel neighborhood. See cornerEigenValsAndVecs .
1954
@param useHarrisDetector Parameter indicating whether to use a Harris detector (see #cornerHarris)
1955
or #cornerMinEigenVal.
1956
@param k Free parameter of the Harris detector.
1957
1958
@sa cornerMinEigenVal, cornerHarris, calcOpticalFlowPyrLK, estimateRigidTransform,
1959
*/
1960
1961
CV_EXPORTS_W void goodFeaturesToTrack( InputArray image, OutputArray corners,
1962
int maxCorners, double qualityLevel, double minDistance,
1963
InputArray mask = noArray(), int blockSize = 3,
1964
bool useHarrisDetector = false, double k = 0.04 );
1965
1966
CV_EXPORTS_W void goodFeaturesToTrack( InputArray image, OutputArray corners,
1967
int maxCorners, double qualityLevel, double minDistance,
1968
InputArray mask, int blockSize,
1969
int gradientSize, bool useHarrisDetector = false,
1970
double k = 0.04 );
1971
/** @example samples/cpp/tutorial_code/ImgTrans/houghlines.cpp
1972
An example using the Hough line detector
1973
![Sample input image](Hough_Lines_Tutorial_Original_Image.jpg) ![Output image](Hough_Lines_Tutorial_Result.jpg)
1974
*/
1975
1976
/** @brief Finds lines in a binary image using the standard Hough transform.
1977
1978
The function implements the standard or standard multi-scale Hough transform algorithm for line
1979
detection. See <http://homepages.inf.ed.ac.uk/rbf/HIPR2/hough.htm> for a good explanation of Hough
1980
transform.
1981
1982
@param image 8-bit, single-channel binary source image. The image may be modified by the function.
1983
@param lines Output vector of lines. Each line is represented by a 2 or 3 element vector
1984
\f$(\rho, \theta)\f$ or \f$(\rho, \theta, \textrm{votes})\f$ . \f$\rho\f$ is the distance from the coordinate origin \f$(0,0)\f$ (top-left corner of
1985
the image). \f$\theta\f$ is the line rotation angle in radians (
1986
\f$0 \sim \textrm{vertical line}, \pi/2 \sim \textrm{horizontal line}\f$ ).
1987
\f$\textrm{votes}\f$ is the value of accumulator.
1988
@param rho Distance resolution of the accumulator in pixels.
1989
@param theta Angle resolution of the accumulator in radians.
1990
@param threshold Accumulator threshold parameter. Only those lines are returned that get enough
1991
votes ( \f$>\texttt{threshold}\f$ ).
1992
@param srn For the multi-scale Hough transform, it is a divisor for the distance resolution rho .
1993
The coarse accumulator distance resolution is rho and the accurate accumulator resolution is
1994
rho/srn . If both srn=0 and stn=0 , the classical Hough transform is used. Otherwise, both these
1995
parameters should be positive.
1996
@param stn For the multi-scale Hough transform, it is a divisor for the distance resolution theta.
1997
@param min_theta For standard and multi-scale Hough transform, minimum angle to check for lines.
1998
Must fall between 0 and max_theta.
1999
@param max_theta For standard and multi-scale Hough transform, maximum angle to check for lines.
2000
Must fall between min_theta and CV_PI.
2001
*/
2002
CV_EXPORTS_W void HoughLines( InputArray image, OutputArray lines,
2003
double rho, double theta, int threshold,
2004
double srn = 0, double stn = 0,
2005
double min_theta = 0, double max_theta = CV_PI );
2006
2007
/** @brief Finds line segments in a binary image using the probabilistic Hough transform.
2008
2009
The function implements the probabilistic Hough transform algorithm for line detection, described
2010
in @cite Matas00
2011
2012
See the line detection example below:
2013
@include snippets/imgproc_HoughLinesP.cpp
2014
This is a sample picture the function parameters have been tuned for:
2015
2016
![image](pics/building.jpg)
2017
2018
And this is the output of the above program in case of the probabilistic Hough transform:
2019
2020
![image](pics/houghp.png)
2021
2022
@param image 8-bit, single-channel binary source image. The image may be modified by the function.
2023
@param lines Output vector of lines. Each line is represented by a 4-element vector
2024
\f$(x_1, y_1, x_2, y_2)\f$ , where \f$(x_1,y_1)\f$ and \f$(x_2, y_2)\f$ are the ending points of each detected
2025
line segment.
2026
@param rho Distance resolution of the accumulator in pixels.
2027
@param theta Angle resolution of the accumulator in radians.
2028
@param threshold Accumulator threshold parameter. Only those lines are returned that get enough
2029
votes ( \f$>\texttt{threshold}\f$ ).
2030
@param minLineLength Minimum line length. Line segments shorter than that are rejected.
2031
@param maxLineGap Maximum allowed gap between points on the same line to link them.
2032
2033
@sa LineSegmentDetector
2034
*/
2035
CV_EXPORTS_W void HoughLinesP( InputArray image, OutputArray lines,
2036
double rho, double theta, int threshold,
2037
double minLineLength = 0, double maxLineGap = 0 );
2038
2039
/** @brief Finds lines in a set of points using the standard Hough transform.
2040
2041
The function finds lines in a set of points using a modification of the Hough transform.
2042
@include snippets/imgproc_HoughLinesPointSet.cpp
2043
@param _point Input vector of points. Each vector must be encoded as a Point vector \f$(x,y)\f$. Type must be CV_32FC2 or CV_32SC2.
2044
@param _lines Output vector of found lines. Each vector is encoded as a vector<Vec3d> \f$(votes, rho, theta)\f$.
2045
The larger the value of 'votes', the higher the reliability of the Hough line.
2046
@param lines_max Max count of hough lines.
2047
@param threshold Accumulator threshold parameter. Only those lines are returned that get enough
2048
votes ( \f$>\texttt{threshold}\f$ )
2049
@param min_rho Minimum Distance value of the accumulator in pixels.
2050
@param max_rho Maximum Distance value of the accumulator in pixels.
2051
@param rho_step Distance resolution of the accumulator in pixels.
2052
@param min_theta Minimum angle value of the accumulator in radians.
2053
@param max_theta Maximum angle value of the accumulator in radians.
2054
@param theta_step Angle resolution of the accumulator in radians.
2055
*/
2056
CV_EXPORTS_W void HoughLinesPointSet( InputArray _point, OutputArray _lines, int lines_max, int threshold,
2057
double min_rho, double max_rho, double rho_step,
2058
double min_theta, double max_theta, double theta_step );
2059
2060
/** @example samples/cpp/tutorial_code/ImgTrans/houghcircles.cpp
2061
An example using the Hough circle detector
2062
*/
2063
2064
/** @brief Finds circles in a grayscale image using the Hough transform.
2065
2066
The function finds circles in a grayscale image using a modification of the Hough transform.
2067
2068
Example: :
2069
@include snippets/imgproc_HoughLinesCircles.cpp
2070
2071
@note Usually the function detects the centers of circles well. However, it may fail to find correct
2072
radii. You can assist to the function by specifying the radius range ( minRadius and maxRadius ) if
2073
you know it. Or, you may set maxRadius to a negative number to return centers only without radius
2074
search, and find the correct radius using an additional procedure.
2075
2076
@param image 8-bit, single-channel, grayscale input image.
2077
@param circles Output vector of found circles. Each vector is encoded as 3 or 4 element
2078
floating-point vector \f$(x, y, radius)\f$ or \f$(x, y, radius, votes)\f$ .
2079
@param method Detection method, see #HoughModes. Currently, the only implemented method is #HOUGH_GRADIENT
2080
@param dp Inverse ratio of the accumulator resolution to the image resolution. For example, if
2081
dp=1 , the accumulator has the same resolution as the input image. If dp=2 , the accumulator has
2082
half as big width and height.
2083
@param minDist Minimum distance between the centers of the detected circles. If the parameter is
2084
too small, multiple neighbor circles may be falsely detected in addition to a true one. If it is
2085
too large, some circles may be missed.
2086
@param param1 First method-specific parameter. In case of #HOUGH_GRADIENT , it is the higher
2087
threshold of the two passed to the Canny edge detector (the lower one is twice smaller).
2088
@param param2 Second method-specific parameter. In case of #HOUGH_GRADIENT , it is the
2089
accumulator threshold for the circle centers at the detection stage. The smaller it is, the more
2090
false circles may be detected. Circles, corresponding to the larger accumulator values, will be
2091
returned first.
2092
@param minRadius Minimum circle radius.
2093
@param maxRadius Maximum circle radius. If <= 0, uses the maximum image dimension. If < 0, returns
2094
centers without finding the radius.
2095
2096
@sa fitEllipse, minEnclosingCircle
2097
*/
2098
CV_EXPORTS_W void HoughCircles( InputArray image, OutputArray circles,
2099
int method, double dp, double minDist,
2100
double param1 = 100, double param2 = 100,
2101
int minRadius = 0, int maxRadius = 0 );
2102
2103
//! @} imgproc_feature
2104
2105
//! @addtogroup imgproc_filter
2106
//! @{
2107
2108
/** @example samples/cpp/tutorial_code/ImgProc/Morphology_2.cpp
2109
Advanced morphology Transformations sample code
2110
![Sample screenshot](Morphology_2_Tutorial_Result.jpg)
2111
Check @ref tutorial_opening_closing_hats "the corresponding tutorial" for more details
2112
*/
2113
2114
/** @brief Erodes an image by using a specific structuring element.
2115
2116
The function erodes the source image using the specified structuring element that determines the
2117
shape of a pixel neighborhood over which the minimum is taken:
2118
2119
\f[\texttt{dst} (x,y) = \min _{(x',y'): \, \texttt{element} (x',y') \ne0 } \texttt{src} (x+x',y+y')\f]
2120
2121
The function supports the in-place mode. Erosion can be applied several ( iterations ) times. In
2122
case of multi-channel images, each channel is processed independently.
2123
2124
@param src input image; the number of channels can be arbitrary, but the depth should be one of
2125
CV_8U, CV_16U, CV_16S, CV_32F or CV_64F.
2126
@param dst output image of the same size and type as src.
2127
@param kernel structuring element used for erosion; if `element=Mat()`, a `3 x 3` rectangular
2128
structuring element is used. Kernel can be created using #getStructuringElement.
2129
@param anchor position of the anchor within the element; default value (-1, -1) means that the
2130
anchor is at the element center.
2131
@param iterations number of times erosion is applied.
2132
@param borderType pixel extrapolation method, see #BorderTypes
2133
@param borderValue border value in case of a constant border
2134
@sa dilate, morphologyEx, getStructuringElement
2135
*/
2136
CV_EXPORTS_W void erode( InputArray src, OutputArray dst, InputArray kernel,
2137
Point anchor = Point(-1,-1), int iterations = 1,
2138
int borderType = BORDER_CONSTANT,
2139
const Scalar& borderValue = morphologyDefaultBorderValue() );
2140
2141
/** @example samples/cpp/tutorial_code/ImgProc/Morphology_1.cpp
2142
Erosion and Dilation sample code
2143
![Sample Screenshot-Erosion](Morphology_1_Tutorial_Erosion_Result.jpg)![Sample Screenshot-Dilation](Morphology_1_Tutorial_Dilation_Result.jpg)
2144
Check @ref tutorial_erosion_dilatation "the corresponding tutorial" for more details
2145
*/
2146
2147
/** @brief Dilates an image by using a specific structuring element.
2148
2149
The function dilates the source image using the specified structuring element that determines the
2150
shape of a pixel neighborhood over which the maximum is taken:
2151
\f[\texttt{dst} (x,y) = \max _{(x',y'): \, \texttt{element} (x',y') \ne0 } \texttt{src} (x+x',y+y')\f]
2152
2153
The function supports the in-place mode. Dilation can be applied several ( iterations ) times. In
2154
case of multi-channel images, each channel is processed independently.
2155
2156
@param src input image; the number of channels can be arbitrary, but the depth should be one of
2157
CV_8U, CV_16U, CV_16S, CV_32F or CV_64F.
2158
@param dst output image of the same size and type as src.
2159
@param kernel structuring element used for dilation; if elemenat=Mat(), a 3 x 3 rectangular
2160
structuring element is used. Kernel can be created using #getStructuringElement
2161
@param anchor position of the anchor within the element; default value (-1, -1) means that the
2162
anchor is at the element center.
2163
@param iterations number of times dilation is applied.
2164
@param borderType pixel extrapolation method, see #BorderTypes
2165
@param borderValue border value in case of a constant border
2166
@sa erode, morphologyEx, getStructuringElement
2167
*/
2168
CV_EXPORTS_W void dilate( InputArray src, OutputArray dst, InputArray kernel,
2169
Point anchor = Point(-1,-1), int iterations = 1,
2170
int borderType = BORDER_CONSTANT,
2171
const Scalar& borderValue = morphologyDefaultBorderValue() );
2172
2173
/** @brief Performs advanced morphological transformations.
2174
2175
The function cv::morphologyEx can perform advanced morphological transformations using an erosion and dilation as
2176
basic operations.
2177
2178
Any of the operations can be done in-place. In case of multi-channel images, each channel is
2179
processed independently.
2180
2181
@param src Source image. The number of channels can be arbitrary. The depth should be one of
2182
CV_8U, CV_16U, CV_16S, CV_32F or CV_64F.
2183
@param dst Destination image of the same size and type as source image.
2184
@param op Type of a morphological operation, see #MorphTypes
2185
@param kernel Structuring element. It can be created using #getStructuringElement.
2186
@param anchor Anchor position with the kernel. Negative values mean that the anchor is at the
2187
kernel center.
2188
@param iterations Number of times erosion and dilation are applied.
2189
@param borderType Pixel extrapolation method, see #BorderTypes
2190
@param borderValue Border value in case of a constant border. The default value has a special
2191
meaning.
2192
@sa dilate, erode, getStructuringElement
2193
@note The number of iterations is the number of times erosion or dilatation operation will be applied.
2194
For instance, an opening operation (#MORPH_OPEN) with two iterations is equivalent to apply
2195
successively: erode -> erode -> dilate -> dilate (and not erode -> dilate -> erode -> dilate).
2196
*/
2197
CV_EXPORTS_W void morphologyEx( InputArray src, OutputArray dst,
2198
int op, InputArray kernel,
2199
Point anchor = Point(-1,-1), int iterations = 1,
2200
int borderType = BORDER_CONSTANT,
2201
const Scalar& borderValue = morphologyDefaultBorderValue() );
2202
2203
//! @} imgproc_filter
2204
2205
//! @addtogroup imgproc_transform
2206
//! @{
2207
2208
/** @brief Resizes an image.
2209
2210
The function resize resizes the image src down to or up to the specified size. Note that the
2211
initial dst type or size are not taken into account. Instead, the size and type are derived from
2212
the `src`,`dsize`,`fx`, and `fy`. If you want to resize src so that it fits the pre-created dst,
2213
you may call the function as follows:
2214
@code
2215
// explicitly specify dsize=dst.size(); fx and fy will be computed from that.
2216
resize(src, dst, dst.size(), 0, 0, interpolation);
2217
@endcode
2218
If you want to decimate the image by factor of 2 in each direction, you can call the function this
2219
way:
2220
@code
2221
// specify fx and fy and let the function compute the destination image size.
2222
resize(src, dst, Size(), 0.5, 0.5, interpolation);
2223
@endcode
2224
To shrink an image, it will generally look best with #INTER_AREA interpolation, whereas to
2225
enlarge an image, it will generally look best with c#INTER_CUBIC (slow) or #INTER_LINEAR
2226
(faster but still looks OK).
2227
2228
@param src input image.
2229
@param dst output image; it has the size dsize (when it is non-zero) or the size computed from
2230
src.size(), fx, and fy; the type of dst is the same as of src.
2231
@param dsize output image size; if it equals zero, it is computed as:
2232
\f[\texttt{dsize = Size(round(fx*src.cols), round(fy*src.rows))}\f]
2233
Either dsize or both fx and fy must be non-zero.
2234
@param fx scale factor along the horizontal axis; when it equals 0, it is computed as
2235
\f[\texttt{(double)dsize.width/src.cols}\f]
2236
@param fy scale factor along the vertical axis; when it equals 0, it is computed as
2237
\f[\texttt{(double)dsize.height/src.rows}\f]
2238
@param interpolation interpolation method, see #InterpolationFlags
2239
2240
@sa warpAffine, warpPerspective, remap
2241
*/
2242
CV_EXPORTS_W void resize( InputArray src, OutputArray dst,
2243
Size dsize, double fx = 0, double fy = 0,
2244
int interpolation = INTER_LINEAR );
2245
2246
/** @brief Applies an affine transformation to an image.
2247
2248
The function warpAffine transforms the source image using the specified matrix:
2249
2250
\f[\texttt{dst} (x,y) = \texttt{src} ( \texttt{M} _{11} x + \texttt{M} _{12} y + \texttt{M} _{13}, \texttt{M} _{21} x + \texttt{M} _{22} y + \texttt{M} _{23})\f]
2251
2252
when the flag #WARP_INVERSE_MAP is set. Otherwise, the transformation is first inverted
2253
with #invertAffineTransform and then put in the formula above instead of M. The function cannot
2254
operate in-place.
2255
2256
@param src input image.
2257
@param dst output image that has the size dsize and the same type as src .
2258
@param M \f$2\times 3\f$ transformation matrix.
2259
@param dsize size of the output image.
2260
@param flags combination of interpolation methods (see #InterpolationFlags) and the optional
2261
flag #WARP_INVERSE_MAP that means that M is the inverse transformation (
2262
\f$\texttt{dst}\rightarrow\texttt{src}\f$ ).
2263
@param borderMode pixel extrapolation method (see #BorderTypes); when
2264
borderMode=#BORDER_TRANSPARENT, it means that the pixels in the destination image corresponding to
2265
the "outliers" in the source image are not modified by the function.
2266
@param borderValue value used in case of a constant border; by default, it is 0.
2267
2268
@sa warpPerspective, resize, remap, getRectSubPix, transform
2269
*/
2270
CV_EXPORTS_W void warpAffine( InputArray src, OutputArray dst,
2271
InputArray M, Size dsize,
2272
int flags = INTER_LINEAR,
2273
int borderMode = BORDER_CONSTANT,
2274
const Scalar& borderValue = Scalar());
2275
2276
/** @example samples/cpp/warpPerspective_demo.cpp
2277
An example program shows using cv::findHomography and cv::warpPerspective for image warping
2278
*/
2279
2280
/** @brief Applies a perspective transformation to an image.
2281
2282
The function warpPerspective transforms the source image using the specified matrix:
2283
2284
\f[\texttt{dst} (x,y) = \texttt{src} \left ( \frac{M_{11} x + M_{12} y + M_{13}}{M_{31} x + M_{32} y + M_{33}} ,
2285
\frac{M_{21} x + M_{22} y + M_{23}}{M_{31} x + M_{32} y + M_{33}} \right )\f]
2286
2287
when the flag #WARP_INVERSE_MAP is set. Otherwise, the transformation is first inverted with invert
2288
and then put in the formula above instead of M. The function cannot operate in-place.
2289
2290
@param src input image.
2291
@param dst output image that has the size dsize and the same type as src .
2292
@param M \f$3\times 3\f$ transformation matrix.
2293
@param dsize size of the output image.
2294
@param flags combination of interpolation methods (#INTER_LINEAR or #INTER_NEAREST) and the
2295
optional flag #WARP_INVERSE_MAP, that sets M as the inverse transformation (
2296
\f$\texttt{dst}\rightarrow\texttt{src}\f$ ).
2297
@param borderMode pixel extrapolation method (#BORDER_CONSTANT or #BORDER_REPLICATE).
2298
@param borderValue value used in case of a constant border; by default, it equals 0.
2299
2300
@sa warpAffine, resize, remap, getRectSubPix, perspectiveTransform
2301
*/
2302
CV_EXPORTS_W void warpPerspective( InputArray src, OutputArray dst,
2303
InputArray M, Size dsize,
2304
int flags = INTER_LINEAR,
2305
int borderMode = BORDER_CONSTANT,
2306
const Scalar& borderValue = Scalar());
2307
2308
/** @brief Applies a generic geometrical transformation to an image.
2309
2310
The function remap transforms the source image using the specified map:
2311
2312
\f[\texttt{dst} (x,y) = \texttt{src} (map_x(x,y),map_y(x,y))\f]
2313
2314
where values of pixels with non-integer coordinates are computed using one of available
2315
interpolation methods. \f$map_x\f$ and \f$map_y\f$ can be encoded as separate floating-point maps
2316
in \f$map_1\f$ and \f$map_2\f$ respectively, or interleaved floating-point maps of \f$(x,y)\f$ in
2317
\f$map_1\f$, or fixed-point maps created by using convertMaps. The reason you might want to
2318
convert from floating to fixed-point representations of a map is that they can yield much faster
2319
(\~2x) remapping operations. In the converted case, \f$map_1\f$ contains pairs (cvFloor(x),
2320
cvFloor(y)) and \f$map_2\f$ contains indices in a table of interpolation coefficients.
2321
2322
This function cannot operate in-place.
2323
2324
@param src Source image.
2325
@param dst Destination image. It has the same size as map1 and the same type as src .
2326
@param map1 The first map of either (x,y) points or just x values having the type CV_16SC2 ,
2327
CV_32FC1, or CV_32FC2. See convertMaps for details on converting a floating point
2328
representation to fixed-point for speed.
2329
@param map2 The second map of y values having the type CV_16UC1, CV_32FC1, or none (empty map
2330
if map1 is (x,y) points), respectively.
2331
@param interpolation Interpolation method (see #InterpolationFlags). The method #INTER_AREA is
2332
not supported by this function.
2333
@param borderMode Pixel extrapolation method (see #BorderTypes). When
2334
borderMode=#BORDER_TRANSPARENT, it means that the pixels in the destination image that
2335
corresponds to the "outliers" in the source image are not modified by the function.
2336
@param borderValue Value used in case of a constant border. By default, it is 0.
2337
@note
2338
Due to current implementation limitations the size of an input and output images should be less than 32767x32767.
2339
*/
2340
CV_EXPORTS_W void remap( InputArray src, OutputArray dst,
2341
InputArray map1, InputArray map2,
2342
int interpolation, int borderMode = BORDER_CONSTANT,
2343
const Scalar& borderValue = Scalar());
2344
2345
/** @brief Converts image transformation maps from one representation to another.
2346
2347
The function converts a pair of maps for remap from one representation to another. The following
2348
options ( (map1.type(), map2.type()) \f$\rightarrow\f$ (dstmap1.type(), dstmap2.type()) ) are
2349
supported:
2350
2351
- \f$\texttt{(CV_32FC1, CV_32FC1)} \rightarrow \texttt{(CV_16SC2, CV_16UC1)}\f$. This is the
2352
most frequently used conversion operation, in which the original floating-point maps (see remap )
2353
are converted to a more compact and much faster fixed-point representation. The first output array
2354
contains the rounded coordinates and the second array (created only when nninterpolation=false )
2355
contains indices in the interpolation tables.
2356
2357
- \f$\texttt{(CV_32FC2)} \rightarrow \texttt{(CV_16SC2, CV_16UC1)}\f$. The same as above but
2358
the original maps are stored in one 2-channel matrix.
2359
2360
- Reverse conversion. Obviously, the reconstructed floating-point maps will not be exactly the same
2361
as the originals.
2362
2363
@param map1 The first input map of type CV_16SC2, CV_32FC1, or CV_32FC2 .
2364
@param map2 The second input map of type CV_16UC1, CV_32FC1, or none (empty matrix),
2365
respectively.
2366
@param dstmap1 The first output map that has the type dstmap1type and the same size as src .
2367
@param dstmap2 The second output map.
2368
@param dstmap1type Type of the first output map that should be CV_16SC2, CV_32FC1, or
2369
CV_32FC2 .
2370
@param nninterpolation Flag indicating whether the fixed-point maps are used for the
2371
nearest-neighbor or for a more complex interpolation.
2372
2373
@sa remap, undistort, initUndistortRectifyMap
2374
*/
2375
CV_EXPORTS_W void convertMaps( InputArray map1, InputArray map2,
2376
OutputArray dstmap1, OutputArray dstmap2,
2377
int dstmap1type, bool nninterpolation = false );
2378
2379
/** @brief Calculates an affine matrix of 2D rotation.
2380
2381
The function calculates the following matrix:
2382
2383
\f[\begin{bmatrix} \alpha & \beta & (1- \alpha ) \cdot \texttt{center.x} - \beta \cdot \texttt{center.y} \\ - \beta & \alpha & \beta \cdot \texttt{center.x} + (1- \alpha ) \cdot \texttt{center.y} \end{bmatrix}\f]
2384
2385
where
2386
2387
\f[\begin{array}{l} \alpha = \texttt{scale} \cdot \cos \texttt{angle} , \\ \beta = \texttt{scale} \cdot \sin \texttt{angle} \end{array}\f]
2388
2389
The transformation maps the rotation center to itself. If this is not the target, adjust the shift.
2390
2391
@param center Center of the rotation in the source image.
2392
@param angle Rotation angle in degrees. Positive values mean counter-clockwise rotation (the
2393
coordinate origin is assumed to be the top-left corner).
2394
@param scale Isotropic scale factor.
2395
2396
@sa getAffineTransform, warpAffine, transform
2397
*/
2398
CV_EXPORTS_W Mat getRotationMatrix2D( Point2f center, double angle, double scale );
2399
2400
/** @brief Calculates an affine transform from three pairs of the corresponding points.
2401
2402
The function calculates the \f$2 \times 3\f$ matrix of an affine transform so that:
2403
2404
\f[\begin{bmatrix} x'_i \\ y'_i \end{bmatrix} = \texttt{map_matrix} \cdot \begin{bmatrix} x_i \\ y_i \\ 1 \end{bmatrix}\f]
2405
2406
where
2407
2408
\f[dst(i)=(x'_i,y'_i), src(i)=(x_i, y_i), i=0,1,2\f]
2409
2410
@param src Coordinates of triangle vertices in the source image.
2411
@param dst Coordinates of the corresponding triangle vertices in the destination image.
2412
2413
@sa warpAffine, transform
2414
*/
2415
CV_EXPORTS Mat getAffineTransform( const Point2f src[], const Point2f dst[] );
2416
2417
/** @brief Inverts an affine transformation.
2418
2419
The function computes an inverse affine transformation represented by \f$2 \times 3\f$ matrix M:
2420
2421
\f[\begin{bmatrix} a_{11} & a_{12} & b_1 \\ a_{21} & a_{22} & b_2 \end{bmatrix}\f]
2422
2423
The result is also a \f$2 \times 3\f$ matrix of the same type as M.
2424
2425
@param M Original affine transformation.
2426
@param iM Output reverse affine transformation.
2427
*/
2428
CV_EXPORTS_W void invertAffineTransform( InputArray M, OutputArray iM );
2429
2430
/** @brief Calculates a perspective transform from four pairs of the corresponding points.
2431
2432
The function calculates the \f$3 \times 3\f$ matrix of a perspective transform so that:
2433
2434
\f[\begin{bmatrix} t_i x'_i \\ t_i y'_i \\ t_i \end{bmatrix} = \texttt{map_matrix} \cdot \begin{bmatrix} x_i \\ y_i \\ 1 \end{bmatrix}\f]
2435
2436
where
2437
2438
\f[dst(i)=(x'_i,y'_i), src(i)=(x_i, y_i), i=0,1,2,3\f]
2439
2440
@param src Coordinates of quadrangle vertices in the source image.
2441
@param dst Coordinates of the corresponding quadrangle vertices in the destination image.
2442
@param solveMethod method passed to cv::solve (#DecompTypes)
2443
2444
@sa findHomography, warpPerspective, perspectiveTransform
2445
*/
2446
CV_EXPORTS_W Mat getPerspectiveTransform(InputArray src, InputArray dst, int solveMethod = DECOMP_LU);
2447
2448
/** @overload */
2449
CV_EXPORTS Mat getPerspectiveTransform(const Point2f src[], const Point2f dst[], int solveMethod = DECOMP_LU);
2450
2451
2452
CV_EXPORTS_W Mat getAffineTransform( InputArray src, InputArray dst );
2453
2454
/** @brief Retrieves a pixel rectangle from an image with sub-pixel accuracy.
2455
2456
The function getRectSubPix extracts pixels from src:
2457
2458
\f[patch(x, y) = src(x + \texttt{center.x} - ( \texttt{dst.cols} -1)*0.5, y + \texttt{center.y} - ( \texttt{dst.rows} -1)*0.5)\f]
2459
2460
where the values of the pixels at non-integer coordinates are retrieved using bilinear
2461
interpolation. Every channel of multi-channel images is processed independently. Also
2462
the image should be a single channel or three channel image. While the center of the
2463
rectangle must be inside the image, parts of the rectangle may be outside.
2464
2465
@param image Source image.
2466
@param patchSize Size of the extracted patch.
2467
@param center Floating point coordinates of the center of the extracted rectangle within the
2468
source image. The center must be inside the image.
2469
@param patch Extracted patch that has the size patchSize and the same number of channels as src .
2470
@param patchType Depth of the extracted pixels. By default, they have the same depth as src .
2471
2472
@sa warpAffine, warpPerspective
2473
*/
2474
CV_EXPORTS_W void getRectSubPix( InputArray image, Size patchSize,
2475
Point2f center, OutputArray patch, int patchType = -1 );
2476
2477
/** @example samples/cpp/polar_transforms.cpp
2478
An example using the cv::linearPolar and cv::logPolar operations
2479
*/
2480
2481
/** @brief Remaps an image to semilog-polar coordinates space.
2482
2483
@deprecated This function produces same result as cv::warpPolar(src, dst, src.size(), center, maxRadius, flags+WARP_POLAR_LOG);
2484
2485
@internal
2486
Transform the source image using the following transformation (See @ref polar_remaps_reference_image "Polar remaps reference image d)"):
2487
\f[\begin{array}{l}
2488
dst( \rho , \phi ) = src(x,y) \\
2489
dst.size() \leftarrow src.size()
2490
\end{array}\f]
2491
2492
where
2493
\f[\begin{array}{l}
2494
I = (dx,dy) = (x - center.x,y - center.y) \\
2495
\rho = M \cdot log_e(\texttt{magnitude} (I)) ,\\
2496
\phi = Kangle \cdot \texttt{angle} (I) \\
2497
\end{array}\f]
2498
2499
and
2500
\f[\begin{array}{l}
2501
M = src.cols / log_e(maxRadius) \\
2502
Kangle = src.rows / 2\Pi \\
2503
\end{array}\f]
2504
2505
The function emulates the human "foveal" vision and can be used for fast scale and
2506
rotation-invariant template matching, for object tracking and so forth.
2507
@param src Source image
2508
@param dst Destination image. It will have same size and type as src.
2509
@param center The transformation center; where the output precision is maximal
2510
@param M Magnitude scale parameter. It determines the radius of the bounding circle to transform too.
2511
@param flags A combination of interpolation methods, see #InterpolationFlags
2512
2513
@note
2514
- The function can not operate in-place.
2515
- To calculate magnitude and angle in degrees #cartToPolar is used internally thus angles are measured from 0 to 360 with accuracy about 0.3 degrees.
2516
2517
@sa cv::linearPolar
2518
@endinternal
2519
*/
2520
CV_EXPORTS_W void logPolar( InputArray src, OutputArray dst,
2521
Point2f center, double M, int flags );
2522
2523
/** @brief Remaps an image to polar coordinates space.
2524
2525
@deprecated This function produces same result as cv::warpPolar(src, dst, src.size(), center, maxRadius, flags)
2526
2527
@internal
2528
Transform the source image using the following transformation (See @ref polar_remaps_reference_image "Polar remaps reference image c)"):
2529
\f[\begin{array}{l}
2530
dst( \rho , \phi ) = src(x,y) \\
2531
dst.size() \leftarrow src.size()
2532
\end{array}\f]
2533
2534
where
2535
\f[\begin{array}{l}
2536
I = (dx,dy) = (x - center.x,y - center.y) \\
2537
\rho = Kmag \cdot \texttt{magnitude} (I) ,\\
2538
\phi = angle \cdot \texttt{angle} (I)
2539
\end{array}\f]
2540
2541
and
2542
\f[\begin{array}{l}
2543
Kx = src.cols / maxRadius \\
2544
Ky = src.rows / 2\Pi
2545
\end{array}\f]
2546
2547
2548
@param src Source image
2549
@param dst Destination image. It will have same size and type as src.
2550
@param center The transformation center;
2551
@param maxRadius The radius of the bounding circle to transform. It determines the inverse magnitude scale parameter too.
2552
@param flags A combination of interpolation methods, see #InterpolationFlags
2553
2554
@note
2555
- The function can not operate in-place.
2556
- To calculate magnitude and angle in degrees #cartToPolar is used internally thus angles are measured from 0 to 360 with accuracy about 0.3 degrees.
2557
2558
@sa cv::logPolar
2559
@endinternal
2560
*/
2561
CV_EXPORTS_W void linearPolar( InputArray src, OutputArray dst,
2562
Point2f center, double maxRadius, int flags );
2563
2564
2565
/** \brief Remaps an image to polar or semilog-polar coordinates space
2566
2567
@anchor polar_remaps_reference_image
2568
![Polar remaps reference](pics/polar_remap_doc.png)
2569
2570
Transform the source image using the following transformation:
2571
\f[
2572
dst(\rho , \phi ) = src(x,y)
2573
\f]
2574
2575
where
2576
\f[
2577
\begin{array}{l}
2578
\vec{I} = (x - center.x, \;y - center.y) \\
2579
\phi = Kangle \cdot \texttt{angle} (\vec{I}) \\
2580
\rho = \left\{\begin{matrix}
2581
Klin \cdot \texttt{magnitude} (\vec{I}) & default \\
2582
Klog \cdot log_e(\texttt{magnitude} (\vec{I})) & if \; semilog \\
2583
\end{matrix}\right.
2584
\end{array}
2585
\f]
2586
2587
and
2588
\f[
2589
\begin{array}{l}
2590
Kangle = dsize.height / 2\Pi \\
2591
Klin = dsize.width / maxRadius \\
2592
Klog = dsize.width / log_e(maxRadius) \\
2593
\end{array}
2594
\f]
2595
2596
2597
\par Linear vs semilog mapping
2598
2599
Polar mapping can be linear or semi-log. Add one of #WarpPolarMode to `flags` to specify the polar mapping mode.
2600
2601
Linear is the default mode.
2602
2603
The semilog mapping emulates the human "foveal" vision that permit very high acuity on the line of sight (central vision)
2604
in contrast to peripheral vision where acuity is minor.
2605
2606
\par Option on `dsize`:
2607
2608
- if both values in `dsize <=0 ` (default),
2609
the destination image will have (almost) same area of source bounding circle:
2610
\f[\begin{array}{l}
2611
dsize.area \leftarrow (maxRadius^2 \cdot \Pi) \\
2612
dsize.width = \texttt{cvRound}(maxRadius) \\
2613
dsize.height = \texttt{cvRound}(maxRadius \cdot \Pi) \\
2614
\end{array}\f]
2615
2616
2617
- if only `dsize.height <= 0`,
2618
the destination image area will be proportional to the bounding circle area but scaled by `Kx * Kx`:
2619
\f[\begin{array}{l}
2620
dsize.height = \texttt{cvRound}(dsize.width \cdot \Pi) \\
2621
\end{array}
2622
\f]
2623
2624
- if both values in `dsize > 0 `,
2625
the destination image will have the given size therefore the area of the bounding circle will be scaled to `dsize`.
2626
2627
2628
\par Reverse mapping
2629
2630
You can get reverse mapping adding #WARP_INVERSE_MAP to `flags`
2631
\snippet polar_transforms.cpp InverseMap
2632
2633
In addiction, to calculate the original coordinate from a polar mapped coordinate \f$(rho, phi)->(x, y)\f$:
2634
\snippet polar_transforms.cpp InverseCoordinate
2635
2636
@param src Source image.
2637
@param dst Destination image. It will have same type as src.
2638
@param dsize The destination image size (see description for valid options).
2639
@param center The transformation center.
2640
@param maxRadius The radius of the bounding circle to transform. It determines the inverse magnitude scale parameter too.
2641
@param flags A combination of interpolation methods, #InterpolationFlags + #WarpPolarMode.
2642
- Add #WARP_POLAR_LINEAR to select linear polar mapping (default)
2643
- Add #WARP_POLAR_LOG to select semilog polar mapping
2644
- Add #WARP_INVERSE_MAP for reverse mapping.
2645
@note
2646
- The function can not operate in-place.
2647
- To calculate magnitude and angle in degrees #cartToPolar is used internally thus angles are measured from 0 to 360 with accuracy about 0.3 degrees.
2648
- This function uses #remap. Due to current implementation limitations the size of an input and output images should be less than 32767x32767.
2649
2650
@sa cv::remap
2651
*/
2652
CV_EXPORTS_W void warpPolar(InputArray src, OutputArray dst, Size dsize,
2653
Point2f center, double maxRadius, int flags);
2654
2655
2656
//! @} imgproc_transform
2657
2658
//! @addtogroup imgproc_misc
2659
//! @{
2660
2661
/** @overload */
2662
CV_EXPORTS_W void integral( InputArray src, OutputArray sum, int sdepth = -1 );
2663
2664
/** @overload */
2665
CV_EXPORTS_AS(integral2) void integral( InputArray src, OutputArray sum,
2666
OutputArray sqsum, int sdepth = -1, int sqdepth = -1 );
2667
2668
/** @brief Calculates the integral of an image.
2669
2670
The function calculates one or more integral images for the source image as follows:
2671
2672
\f[\texttt{sum} (X,Y) = \sum _{x<X,y<Y} \texttt{image} (x,y)\f]
2673
2674
\f[\texttt{sqsum} (X,Y) = \sum _{x<X,y<Y} \texttt{image} (x,y)^2\f]
2675
2676
\f[\texttt{tilted} (X,Y) = \sum _{y<Y,abs(x-X+1) \leq Y-y-1} \texttt{image} (x,y)\f]
2677
2678
Using these integral images, you can calculate sum, mean, and standard deviation over a specific
2679
up-right or rotated rectangular region of the image in a constant time, for example:
2680
2681
\f[\sum _{x_1 \leq x < x_2, \, y_1 \leq y < y_2} \texttt{image} (x,y) = \texttt{sum} (x_2,y_2)- \texttt{sum} (x_1,y_2)- \texttt{sum} (x_2,y_1)+ \texttt{sum} (x_1,y_1)\f]
2682
2683
It makes possible to do a fast blurring or fast block correlation with a variable window size, for
2684
example. In case of multi-channel images, sums for each channel are accumulated independently.
2685
2686
As a practical example, the next figure shows the calculation of the integral of a straight
2687
rectangle Rect(3,3,3,2) and of a tilted rectangle Rect(5,1,2,3) . The selected pixels in the
2688
original image are shown, as well as the relative pixels in the integral images sum and tilted .
2689
2690
![integral calculation example](pics/integral.png)
2691
2692
@param src input image as \f$W \times H\f$, 8-bit or floating-point (32f or 64f).
2693
@param sum integral image as \f$(W+1)\times (H+1)\f$ , 32-bit integer or floating-point (32f or 64f).
2694
@param sqsum integral image for squared pixel values; it is \f$(W+1)\times (H+1)\f$, double-precision
2695
floating-point (64f) array.
2696
@param tilted integral for the image rotated by 45 degrees; it is \f$(W+1)\times (H+1)\f$ array with
2697
the same data type as sum.
2698
@param sdepth desired depth of the integral and the tilted integral images, CV_32S, CV_32F, or
2699
CV_64F.
2700
@param sqdepth desired depth of the integral image of squared pixel values, CV_32F or CV_64F.
2701
*/
2702
CV_EXPORTS_AS(integral3) void integral( InputArray src, OutputArray sum,
2703
OutputArray sqsum, OutputArray tilted,
2704
int sdepth = -1, int sqdepth = -1 );
2705
2706
//! @} imgproc_misc
2707
2708
//! @addtogroup imgproc_motion
2709
//! @{
2710
2711
/** @brief Adds an image to the accumulator image.
2712
2713
The function adds src or some of its elements to dst :
2714
2715
\f[\texttt{dst} (x,y) \leftarrow \texttt{dst} (x,y) + \texttt{src} (x,y) \quad \text{if} \quad \texttt{mask} (x,y) \ne 0\f]
2716
2717
The function supports multi-channel images. Each channel is processed independently.
2718
2719
The function cv::accumulate can be used, for example, to collect statistics of a scene background
2720
viewed by a still camera and for the further foreground-background segmentation.
2721
2722
@param src Input image of type CV_8UC(n), CV_16UC(n), CV_32FC(n) or CV_64FC(n), where n is a positive integer.
2723
@param dst %Accumulator image with the same number of channels as input image, and a depth of CV_32F or CV_64F.
2724
@param mask Optional operation mask.
2725
2726
@sa accumulateSquare, accumulateProduct, accumulateWeighted
2727
*/
2728
CV_EXPORTS_W void accumulate( InputArray src, InputOutputArray dst,
2729
InputArray mask = noArray() );
2730
2731
/** @brief Adds the square of a source image to the accumulator image.
2732
2733
The function adds the input image src or its selected region, raised to a power of 2, to the
2734
accumulator dst :
2735
2736
\f[\texttt{dst} (x,y) \leftarrow \texttt{dst} (x,y) + \texttt{src} (x,y)^2 \quad \text{if} \quad \texttt{mask} (x,y) \ne 0\f]
2737
2738
The function supports multi-channel images. Each channel is processed independently.
2739
2740
@param src Input image as 1- or 3-channel, 8-bit or 32-bit floating point.
2741
@param dst %Accumulator image with the same number of channels as input image, 32-bit or 64-bit
2742
floating-point.
2743
@param mask Optional operation mask.
2744
2745
@sa accumulateSquare, accumulateProduct, accumulateWeighted
2746
*/
2747
CV_EXPORTS_W void accumulateSquare( InputArray src, InputOutputArray dst,
2748
InputArray mask = noArray() );
2749
2750
/** @brief Adds the per-element product of two input images to the accumulator image.
2751
2752
The function adds the product of two images or their selected regions to the accumulator dst :
2753
2754
\f[\texttt{dst} (x,y) \leftarrow \texttt{dst} (x,y) + \texttt{src1} (x,y) \cdot \texttt{src2} (x,y) \quad \text{if} \quad \texttt{mask} (x,y) \ne 0\f]
2755
2756
The function supports multi-channel images. Each channel is processed independently.
2757
2758
@param src1 First input image, 1- or 3-channel, 8-bit or 32-bit floating point.
2759
@param src2 Second input image of the same type and the same size as src1 .
2760
@param dst %Accumulator image with the same number of channels as input images, 32-bit or 64-bit
2761
floating-point.
2762
@param mask Optional operation mask.
2763
2764
@sa accumulate, accumulateSquare, accumulateWeighted
2765
*/
2766
CV_EXPORTS_W void accumulateProduct( InputArray src1, InputArray src2,
2767
InputOutputArray dst, InputArray mask=noArray() );
2768
2769
/** @brief Updates a running average.
2770
2771
The function calculates the weighted sum of the input image src and the accumulator dst so that dst
2772
becomes a running average of a frame sequence:
2773
2774
\f[\texttt{dst} (x,y) \leftarrow (1- \texttt{alpha} ) \cdot \texttt{dst} (x,y) + \texttt{alpha} \cdot \texttt{src} (x,y) \quad \text{if} \quad \texttt{mask} (x,y) \ne 0\f]
2775
2776
That is, alpha regulates the update speed (how fast the accumulator "forgets" about earlier images).
2777
The function supports multi-channel images. Each channel is processed independently.
2778
2779
@param src Input image as 1- or 3-channel, 8-bit or 32-bit floating point.
2780
@param dst %Accumulator image with the same number of channels as input image, 32-bit or 64-bit
2781
floating-point.
2782
@param alpha Weight of the input image.
2783
@param mask Optional operation mask.
2784
2785
@sa accumulate, accumulateSquare, accumulateProduct
2786
*/
2787
CV_EXPORTS_W void accumulateWeighted( InputArray src, InputOutputArray dst,
2788
double alpha, InputArray mask = noArray() );
2789
2790
/** @brief The function is used to detect translational shifts that occur between two images.
2791
2792
The operation takes advantage of the Fourier shift theorem for detecting the translational shift in
2793
the frequency domain. It can be used for fast image registration as well as motion estimation. For
2794
more information please see <http://en.wikipedia.org/wiki/Phase_correlation>
2795
2796
Calculates the cross-power spectrum of two supplied source arrays. The arrays are padded if needed
2797
with getOptimalDFTSize.
2798
2799
The function performs the following equations:
2800
- First it applies a Hanning window (see <http://en.wikipedia.org/wiki/Hann_function>) to each
2801
image to remove possible edge effects. This window is cached until the array size changes to speed
2802
up processing time.
2803
- Next it computes the forward DFTs of each source array:
2804
\f[\mathbf{G}_a = \mathcal{F}\{src_1\}, \; \mathbf{G}_b = \mathcal{F}\{src_2\}\f]
2805
where \f$\mathcal{F}\f$ is the forward DFT.
2806
- It then computes the cross-power spectrum of each frequency domain array:
2807
\f[R = \frac{ \mathbf{G}_a \mathbf{G}_b^*}{|\mathbf{G}_a \mathbf{G}_b^*|}\f]
2808
- Next the cross-correlation is converted back into the time domain via the inverse DFT:
2809
\f[r = \mathcal{F}^{-1}\{R\}\f]
2810
- Finally, it computes the peak location and computes a 5x5 weighted centroid around the peak to
2811
achieve sub-pixel accuracy.
2812
\f[(\Delta x, \Delta y) = \texttt{weightedCentroid} \{\arg \max_{(x, y)}\{r\}\}\f]
2813
- If non-zero, the response parameter is computed as the sum of the elements of r within the 5x5
2814
centroid around the peak location. It is normalized to a maximum of 1 (meaning there is a single
2815
peak) and will be smaller when there are multiple peaks.
2816
2817
@param src1 Source floating point array (CV_32FC1 or CV_64FC1)
2818
@param src2 Source floating point array (CV_32FC1 or CV_64FC1)
2819
@param window Floating point array with windowing coefficients to reduce edge effects (optional).
2820
@param response Signal power within the 5x5 centroid around the peak, between 0 and 1 (optional).
2821
@returns detected phase shift (sub-pixel) between the two arrays.
2822
2823
@sa dft, getOptimalDFTSize, idft, mulSpectrums createHanningWindow
2824
*/
2825
CV_EXPORTS_W Point2d phaseCorrelate(InputArray src1, InputArray src2,
2826
InputArray window = noArray(), CV_OUT double* response = 0);
2827
2828
/** @brief This function computes a Hanning window coefficients in two dimensions.
2829
2830
See (http://en.wikipedia.org/wiki/Hann_function) and (http://en.wikipedia.org/wiki/Window_function)
2831
for more information.
2832
2833
An example is shown below:
2834
@code
2835
// create hanning window of size 100x100 and type CV_32F
2836
Mat hann;
2837
createHanningWindow(hann, Size(100, 100), CV_32F);
2838
@endcode
2839
@param dst Destination array to place Hann coefficients in
2840
@param winSize The window size specifications (both width and height must be > 1)
2841
@param type Created array type
2842
*/
2843
CV_EXPORTS_W void createHanningWindow(OutputArray dst, Size winSize, int type);
2844
2845
//! @} imgproc_motion
2846
2847
//! @addtogroup imgproc_misc
2848
//! @{
2849
2850
/** @brief Applies a fixed-level threshold to each array element.
2851
2852
The function applies fixed-level thresholding to a multiple-channel array. The function is typically
2853
used to get a bi-level (binary) image out of a grayscale image ( #compare could be also used for
2854
this purpose) or for removing a noise, that is, filtering out pixels with too small or too large
2855
values. There are several types of thresholding supported by the function. They are determined by
2856
type parameter.
2857
2858
Also, the special values #THRESH_OTSU or #THRESH_TRIANGLE may be combined with one of the
2859
above values. In these cases, the function determines the optimal threshold value using the Otsu's
2860
or Triangle algorithm and uses it instead of the specified thresh.
2861
2862
@note Currently, the Otsu's and Triangle methods are implemented only for 8-bit single-channel images.
2863
2864
@param src input array (multiple-channel, 8-bit or 32-bit floating point).
2865
@param dst output array of the same size and type and the same number of channels as src.
2866
@param thresh threshold value.
2867
@param maxval maximum value to use with the #THRESH_BINARY and #THRESH_BINARY_INV thresholding
2868
types.
2869
@param type thresholding type (see #ThresholdTypes).
2870
@return the computed threshold value if Otsu's or Triangle methods used.
2871
2872
@sa adaptiveThreshold, findContours, compare, min, max
2873
*/
2874
CV_EXPORTS_W double threshold( InputArray src, OutputArray dst,
2875
double thresh, double maxval, int type );
2876
2877
2878
/** @brief Applies an adaptive threshold to an array.
2879
2880
The function transforms a grayscale image to a binary image according to the formulae:
2881
- **THRESH_BINARY**
2882
\f[dst(x,y) = \fork{\texttt{maxValue}}{if \(src(x,y) > T(x,y)\)}{0}{otherwise}\f]
2883
- **THRESH_BINARY_INV**
2884
\f[dst(x,y) = \fork{0}{if \(src(x,y) > T(x,y)\)}{\texttt{maxValue}}{otherwise}\f]
2885
where \f$T(x,y)\f$ is a threshold calculated individually for each pixel (see adaptiveMethod parameter).
2886
2887
The function can process the image in-place.
2888
2889
@param src Source 8-bit single-channel image.
2890
@param dst Destination image of the same size and the same type as src.
2891
@param maxValue Non-zero value assigned to the pixels for which the condition is satisfied
2892
@param adaptiveMethod Adaptive thresholding algorithm to use, see #AdaptiveThresholdTypes.
2893
The #BORDER_REPLICATE | #BORDER_ISOLATED is used to process boundaries.
2894
@param thresholdType Thresholding type that must be either #THRESH_BINARY or #THRESH_BINARY_INV,
2895
see #ThresholdTypes.
2896
@param blockSize Size of a pixel neighborhood that is used to calculate a threshold value for the
2897
pixel: 3, 5, 7, and so on.
2898
@param C Constant subtracted from the mean or weighted mean (see the details below). Normally, it
2899
is positive but may be zero or negative as well.
2900
2901
@sa threshold, blur, GaussianBlur
2902
*/
2903
CV_EXPORTS_W void adaptiveThreshold( InputArray src, OutputArray dst,
2904
double maxValue, int adaptiveMethod,
2905
int thresholdType, int blockSize, double C );
2906
2907
//! @} imgproc_misc
2908
2909
//! @addtogroup imgproc_filter
2910
//! @{
2911
2912
/** @example samples/cpp/tutorial_code/ImgProc/Pyramids/Pyramids.cpp
2913
An example using pyrDown and pyrUp functions
2914
*/
2915
2916
/** @brief Blurs an image and downsamples it.
2917
2918
By default, size of the output image is computed as `Size((src.cols+1)/2, (src.rows+1)/2)`, but in
2919
any case, the following conditions should be satisfied:
2920
2921
\f[\begin{array}{l} | \texttt{dstsize.width} *2-src.cols| \leq 2 \\ | \texttt{dstsize.height} *2-src.rows| \leq 2 \end{array}\f]
2922
2923
The function performs the downsampling step of the Gaussian pyramid construction. First, it
2924
convolves the source image with the kernel:
2925
2926
\f[\frac{1}{256} \begin{bmatrix} 1 & 4 & 6 & 4 & 1 \\ 4 & 16 & 24 & 16 & 4 \\ 6 & 24 & 36 & 24 & 6 \\ 4 & 16 & 24 & 16 & 4 \\ 1 & 4 & 6 & 4 & 1 \end{bmatrix}\f]
2927
2928
Then, it downsamples the image by rejecting even rows and columns.
2929
2930
@param src input image.
2931
@param dst output image; it has the specified size and the same type as src.
2932
@param dstsize size of the output image.
2933
@param borderType Pixel extrapolation method, see #BorderTypes (#BORDER_CONSTANT isn't supported)
2934
*/
2935
CV_EXPORTS_W void pyrDown( InputArray src, OutputArray dst,
2936
const Size& dstsize = Size(), int borderType = BORDER_DEFAULT );
2937
2938
/** @brief Upsamples an image and then blurs it.
2939
2940
By default, size of the output image is computed as `Size(src.cols\*2, (src.rows\*2)`, but in any
2941
case, the following conditions should be satisfied:
2942
2943
\f[\begin{array}{l} | \texttt{dstsize.width} -src.cols*2| \leq ( \texttt{dstsize.width} \mod 2) \\ | \texttt{dstsize.height} -src.rows*2| \leq ( \texttt{dstsize.height} \mod 2) \end{array}\f]
2944
2945
The function performs the upsampling step of the Gaussian pyramid construction, though it can
2946
actually be used to construct the Laplacian pyramid. First, it upsamples the source image by
2947
injecting even zero rows and columns and then convolves the result with the same kernel as in
2948
pyrDown multiplied by 4.
2949
2950
@param src input image.
2951
@param dst output image. It has the specified size and the same type as src .
2952
@param dstsize size of the output image.
2953
@param borderType Pixel extrapolation method, see #BorderTypes (only #BORDER_DEFAULT is supported)
2954
*/
2955
CV_EXPORTS_W void pyrUp( InputArray src, OutputArray dst,
2956
const Size& dstsize = Size(), int borderType = BORDER_DEFAULT );
2957
2958
/** @brief Constructs the Gaussian pyramid for an image.
2959
2960
The function constructs a vector of images and builds the Gaussian pyramid by recursively applying
2961
pyrDown to the previously built pyramid layers, starting from `dst[0]==src`.
2962
2963
@param src Source image. Check pyrDown for the list of supported types.
2964
@param dst Destination vector of maxlevel+1 images of the same type as src. dst[0] will be the
2965
same as src. dst[1] is the next pyramid layer, a smoothed and down-sized src, and so on.
2966
@param maxlevel 0-based index of the last (the smallest) pyramid layer. It must be non-negative.
2967
@param borderType Pixel extrapolation method, see #BorderTypes (#BORDER_CONSTANT isn't supported)
2968
*/
2969
CV_EXPORTS void buildPyramid( InputArray src, OutputArrayOfArrays dst,
2970
int maxlevel, int borderType = BORDER_DEFAULT );
2971
2972
//! @} imgproc_filter
2973
2974
//! @addtogroup imgproc_hist
2975
//! @{
2976
2977
/** @example samples/cpp/demhist.cpp
2978
An example for creating histograms of an image
2979
*/
2980
2981
/** @brief Calculates a histogram of a set of arrays.
2982
2983
The function cv::calcHist calculates the histogram of one or more arrays. The elements of a tuple used
2984
to increment a histogram bin are taken from the corresponding input arrays at the same location. The
2985
sample below shows how to compute a 2D Hue-Saturation histogram for a color image. :
2986
@include snippets/imgproc_calcHist.cpp
2987
2988
@param images Source arrays. They all should have the same depth, CV_8U, CV_16U or CV_32F , and the same
2989
size. Each of them can have an arbitrary number of channels.
2990
@param nimages Number of source images.
2991
@param channels List of the dims channels used to compute the histogram. The first array channels
2992
are numerated from 0 to images[0].channels()-1 , the second array channels are counted from
2993
images[0].channels() to images[0].channels() + images[1].channels()-1, and so on.
2994
@param mask Optional mask. If the matrix is not empty, it must be an 8-bit array of the same size
2995
as images[i] . The non-zero mask elements mark the array elements counted in the histogram.
2996
@param hist Output histogram, which is a dense or sparse dims -dimensional array.
2997
@param dims Histogram dimensionality that must be positive and not greater than CV_MAX_DIMS
2998
(equal to 32 in the current OpenCV version).
2999
@param histSize Array of histogram sizes in each dimension.
3000
@param ranges Array of the dims arrays of the histogram bin boundaries in each dimension. When the
3001
histogram is uniform ( uniform =true), then for each dimension i it is enough to specify the lower
3002
(inclusive) boundary \f$L_0\f$ of the 0-th histogram bin and the upper (exclusive) boundary
3003
\f$U_{\texttt{histSize}[i]-1}\f$ for the last histogram bin histSize[i]-1 . That is, in case of a
3004
uniform histogram each of ranges[i] is an array of 2 elements. When the histogram is not uniform (
3005
uniform=false ), then each of ranges[i] contains histSize[i]+1 elements:
3006
\f$L_0, U_0=L_1, U_1=L_2, ..., U_{\texttt{histSize[i]}-2}=L_{\texttt{histSize[i]}-1}, U_{\texttt{histSize[i]}-1}\f$
3007
. The array elements, that are not between \f$L_0\f$ and \f$U_{\texttt{histSize[i]}-1}\f$ , are not
3008
counted in the histogram.
3009
@param uniform Flag indicating whether the histogram is uniform or not (see above).
3010
@param accumulate Accumulation flag. If it is set, the histogram is not cleared in the beginning
3011
when it is allocated. This feature enables you to compute a single histogram from several sets of
3012
arrays, or to update the histogram in time.
3013
*/
3014
CV_EXPORTS void calcHist( const Mat* images, int nimages,
3015
const int* channels, InputArray mask,
3016
OutputArray hist, int dims, const int* histSize,
3017
const float** ranges, bool uniform = true, bool accumulate = false );
3018
3019
/** @overload
3020
3021
this variant uses %SparseMat for output
3022
*/
3023
CV_EXPORTS void calcHist( const Mat* images, int nimages,
3024
const int* channels, InputArray mask,
3025
SparseMat& hist, int dims,
3026
const int* histSize, const float** ranges,
3027
bool uniform = true, bool accumulate = false );
3028
3029
/** @overload */
3030
CV_EXPORTS_W void calcHist( InputArrayOfArrays images,
3031
const std::vector<int>& channels,
3032
InputArray mask, OutputArray hist,
3033
const std::vector<int>& histSize,
3034
const std::vector<float>& ranges,
3035
bool accumulate = false );
3036
3037
/** @brief Calculates the back projection of a histogram.
3038
3039
The function cv::calcBackProject calculates the back project of the histogram. That is, similarly to
3040
#calcHist , at each location (x, y) the function collects the values from the selected channels
3041
in the input images and finds the corresponding histogram bin. But instead of incrementing it, the
3042
function reads the bin value, scales it by scale , and stores in backProject(x,y) . In terms of
3043
statistics, the function computes probability of each element value in respect with the empirical
3044
probability distribution represented by the histogram. See how, for example, you can find and track
3045
a bright-colored object in a scene:
3046
3047
- Before tracking, show the object to the camera so that it covers almost the whole frame.
3048
Calculate a hue histogram. The histogram may have strong maximums, corresponding to the dominant
3049
colors in the object.
3050
3051
- When tracking, calculate a back projection of a hue plane of each input video frame using that
3052
pre-computed histogram. Threshold the back projection to suppress weak colors. It may also make
3053
sense to suppress pixels with non-sufficient color saturation and too dark or too bright pixels.
3054
3055
- Find connected components in the resulting picture and choose, for example, the largest
3056
component.
3057
3058
This is an approximate algorithm of the CamShift color object tracker.
3059
3060
@param images Source arrays. They all should have the same depth, CV_8U, CV_16U or CV_32F , and the same
3061
size. Each of them can have an arbitrary number of channels.
3062
@param nimages Number of source images.
3063
@param channels The list of channels used to compute the back projection. The number of channels
3064
must match the histogram dimensionality. The first array channels are numerated from 0 to
3065
images[0].channels()-1 , the second array channels are counted from images[0].channels() to
3066
images[0].channels() + images[1].channels()-1, and so on.
3067
@param hist Input histogram that can be dense or sparse.
3068
@param backProject Destination back projection array that is a single-channel array of the same
3069
size and depth as images[0] .
3070
@param ranges Array of arrays of the histogram bin boundaries in each dimension. See #calcHist .
3071
@param scale Optional scale factor for the output back projection.
3072
@param uniform Flag indicating whether the histogram is uniform or not (see above).
3073
3074
@sa calcHist, compareHist
3075
*/
3076
CV_EXPORTS void calcBackProject( const Mat* images, int nimages,
3077
const int* channels, InputArray hist,
3078
OutputArray backProject, const float** ranges,
3079
double scale = 1, bool uniform = true );
3080
3081
/** @overload */
3082
CV_EXPORTS void calcBackProject( const Mat* images, int nimages,
3083
const int* channels, const SparseMat& hist,
3084
OutputArray backProject, const float** ranges,
3085
double scale = 1, bool uniform = true );
3086
3087
/** @overload */
3088
CV_EXPORTS_W void calcBackProject( InputArrayOfArrays images, const std::vector<int>& channels,
3089
InputArray hist, OutputArray dst,
3090
const std::vector<float>& ranges,
3091
double scale );
3092
3093
/** @brief Compares two histograms.
3094
3095
The function cv::compareHist compares two dense or two sparse histograms using the specified method.
3096
3097
The function returns \f$d(H_1, H_2)\f$ .
3098
3099
While the function works well with 1-, 2-, 3-dimensional dense histograms, it may not be suitable
3100
for high-dimensional sparse histograms. In such histograms, because of aliasing and sampling
3101
problems, the coordinates of non-zero histogram bins can slightly shift. To compare such histograms
3102
or more general sparse configurations of weighted points, consider using the #EMD function.
3103
3104
@param H1 First compared histogram.
3105
@param H2 Second compared histogram of the same size as H1 .
3106
@param method Comparison method, see #HistCompMethods
3107
*/
3108
CV_EXPORTS_W double compareHist( InputArray H1, InputArray H2, int method );
3109
3110
/** @overload */
3111
CV_EXPORTS double compareHist( const SparseMat& H1, const SparseMat& H2, int method );
3112
3113
/** @brief Equalizes the histogram of a grayscale image.
3114
3115
The function equalizes the histogram of the input image using the following algorithm:
3116
3117
- Calculate the histogram \f$H\f$ for src .
3118
- Normalize the histogram so that the sum of histogram bins is 255.
3119
- Compute the integral of the histogram:
3120
\f[H'_i = \sum _{0 \le j < i} H(j)\f]
3121
- Transform the image using \f$H'\f$ as a look-up table: \f$\texttt{dst}(x,y) = H'(\texttt{src}(x,y))\f$
3122
3123
The algorithm normalizes the brightness and increases the contrast of the image.
3124
3125
@param src Source 8-bit single channel image.
3126
@param dst Destination image of the same size and type as src .
3127
*/
3128
CV_EXPORTS_W void equalizeHist( InputArray src, OutputArray dst );
3129
3130
/** @brief Computes the "minimal work" distance between two weighted point configurations.
3131
3132
The function computes the earth mover distance and/or a lower boundary of the distance between the
3133
two weighted point configurations. One of the applications described in @cite RubnerSept98,
3134
@cite Rubner2000 is multi-dimensional histogram comparison for image retrieval. EMD is a transportation
3135
problem that is solved using some modification of a simplex algorithm, thus the complexity is
3136
exponential in the worst case, though, on average it is much faster. In the case of a real metric
3137
the lower boundary can be calculated even faster (using linear-time algorithm) and it can be used
3138
to determine roughly whether the two signatures are far enough so that they cannot relate to the
3139
same object.
3140
3141
@param signature1 First signature, a \f$\texttt{size1}\times \texttt{dims}+1\f$ floating-point matrix.
3142
Each row stores the point weight followed by the point coordinates. The matrix is allowed to have
3143
a single column (weights only) if the user-defined cost matrix is used. The weights must be
3144
non-negative and have at least one non-zero value.
3145
@param signature2 Second signature of the same format as signature1 , though the number of rows
3146
may be different. The total weights may be different. In this case an extra "dummy" point is added
3147
to either signature1 or signature2. The weights must be non-negative and have at least one non-zero
3148
value.
3149
@param distType Used metric. See #DistanceTypes.
3150
@param cost User-defined \f$\texttt{size1}\times \texttt{size2}\f$ cost matrix. Also, if a cost matrix
3151
is used, lower boundary lowerBound cannot be calculated because it needs a metric function.
3152
@param lowerBound Optional input/output parameter: lower boundary of a distance between the two
3153
signatures that is a distance between mass centers. The lower boundary may not be calculated if
3154
the user-defined cost matrix is used, the total weights of point configurations are not equal, or
3155
if the signatures consist of weights only (the signature matrices have a single column). You
3156
**must** initialize \*lowerBound . If the calculated distance between mass centers is greater or
3157
equal to \*lowerBound (it means that the signatures are far enough), the function does not
3158
calculate EMD. In any case \*lowerBound is set to the calculated distance between mass centers on
3159
return. Thus, if you want to calculate both distance between mass centers and EMD, \*lowerBound
3160
should be set to 0.
3161
@param flow Resultant \f$\texttt{size1} \times \texttt{size2}\f$ flow matrix: \f$\texttt{flow}_{i,j}\f$ is
3162
a flow from \f$i\f$ -th point of signature1 to \f$j\f$ -th point of signature2 .
3163
*/
3164
CV_EXPORTS float EMD( InputArray signature1, InputArray signature2,
3165
int distType, InputArray cost=noArray(),
3166
float* lowerBound = 0, OutputArray flow = noArray() );
3167
3168
CV_EXPORTS_AS(EMD) float wrapperEMD( InputArray signature1, InputArray signature2,
3169
int distType, InputArray cost=noArray(),
3170
CV_IN_OUT Ptr<float> lowerBound = Ptr<float>(), OutputArray flow = noArray() );
3171
3172
//! @} imgproc_hist
3173
3174
/** @example samples/cpp/watershed.cpp
3175
An example using the watershed algorithm
3176
*/
3177
3178
/** @brief Performs a marker-based image segmentation using the watershed algorithm.
3179
3180
The function implements one of the variants of watershed, non-parametric marker-based segmentation
3181
algorithm, described in @cite Meyer92 .
3182
3183
Before passing the image to the function, you have to roughly outline the desired regions in the
3184
image markers with positive (\>0) indices. So, every region is represented as one or more connected
3185
components with the pixel values 1, 2, 3, and so on. Such markers can be retrieved from a binary
3186
mask using #findContours and #drawContours (see the watershed.cpp demo). The markers are "seeds" of
3187
the future image regions. All the other pixels in markers , whose relation to the outlined regions
3188
is not known and should be defined by the algorithm, should be set to 0's. In the function output,
3189
each pixel in markers is set to a value of the "seed" components or to -1 at boundaries between the
3190
regions.
3191
3192
@note Any two neighbor connected components are not necessarily separated by a watershed boundary
3193
(-1's pixels); for example, they can touch each other in the initial marker image passed to the
3194
function.
3195
3196
@param image Input 8-bit 3-channel image.
3197
@param markers Input/output 32-bit single-channel image (map) of markers. It should have the same
3198
size as image .
3199
3200
@sa findContours
3201
3202
@ingroup imgproc_misc
3203
*/
3204
CV_EXPORTS_W void watershed( InputArray image, InputOutputArray markers );
3205
3206
//! @addtogroup imgproc_filter
3207
//! @{
3208
3209
/** @brief Performs initial step of meanshift segmentation of an image.
3210
3211
The function implements the filtering stage of meanshift segmentation, that is, the output of the
3212
function is the filtered "posterized" image with color gradients and fine-grain texture flattened.
3213
At every pixel (X,Y) of the input image (or down-sized input image, see below) the function executes
3214
meanshift iterations, that is, the pixel (X,Y) neighborhood in the joint space-color hyperspace is
3215
considered:
3216
3217
\f[(x,y): X- \texttt{sp} \le x \le X+ \texttt{sp} , Y- \texttt{sp} \le y \le Y+ \texttt{sp} , ||(R,G,B)-(r,g,b)|| \le \texttt{sr}\f]
3218
3219
where (R,G,B) and (r,g,b) are the vectors of color components at (X,Y) and (x,y), respectively
3220
(though, the algorithm does not depend on the color space used, so any 3-component color space can
3221
be used instead). Over the neighborhood the average spatial value (X',Y') and average color vector
3222
(R',G',B') are found and they act as the neighborhood center on the next iteration:
3223
3224
\f[(X,Y)~(X',Y'), (R,G,B)~(R',G',B').\f]
3225
3226
After the iterations over, the color components of the initial pixel (that is, the pixel from where
3227
the iterations started) are set to the final value (average color at the last iteration):
3228
3229
\f[I(X,Y) <- (R*,G*,B*)\f]
3230
3231
When maxLevel \> 0, the gaussian pyramid of maxLevel+1 levels is built, and the above procedure is
3232
run on the smallest layer first. After that, the results are propagated to the larger layer and the
3233
iterations are run again only on those pixels where the layer colors differ by more than sr from the
3234
lower-resolution layer of the pyramid. That makes boundaries of color regions sharper. Note that the
3235
results will be actually different from the ones obtained by running the meanshift procedure on the
3236
whole original image (i.e. when maxLevel==0).
3237
3238
@param src The source 8-bit, 3-channel image.
3239
@param dst The destination image of the same format and the same size as the source.
3240
@param sp The spatial window radius.
3241
@param sr The color window radius.
3242
@param maxLevel Maximum level of the pyramid for the segmentation.
3243
@param termcrit Termination criteria: when to stop meanshift iterations.
3244
*/
3245
CV_EXPORTS_W void pyrMeanShiftFiltering( InputArray src, OutputArray dst,
3246
double sp, double sr, int maxLevel = 1,
3247
TermCriteria termcrit=TermCriteria(TermCriteria::MAX_ITER+TermCriteria::EPS,5,1) );
3248
3249
//! @}
3250
3251
//! @addtogroup imgproc_misc
3252
//! @{
3253
3254
/** @example samples/cpp/grabcut.cpp
3255
An example using the GrabCut algorithm
3256
![Sample Screenshot](grabcut_output1.jpg)
3257
*/
3258
3259
/** @brief Runs the GrabCut algorithm.
3260
3261
The function implements the [GrabCut image segmentation algorithm](http://en.wikipedia.org/wiki/GrabCut).
3262
3263
@param img Input 8-bit 3-channel image.
3264
@param mask Input/output 8-bit single-channel mask. The mask is initialized by the function when
3265
mode is set to #GC_INIT_WITH_RECT. Its elements may have one of the #GrabCutClasses.
3266
@param rect ROI containing a segmented object. The pixels outside of the ROI are marked as
3267
"obvious background". The parameter is only used when mode==#GC_INIT_WITH_RECT .
3268
@param bgdModel Temporary array for the background model. Do not modify it while you are
3269
processing the same image.
3270
@param fgdModel Temporary arrays for the foreground model. Do not modify it while you are
3271
processing the same image.
3272
@param iterCount Number of iterations the algorithm should make before returning the result. Note
3273
that the result can be refined with further calls with mode==#GC_INIT_WITH_MASK or
3274
mode==GC_EVAL .
3275
@param mode Operation mode that could be one of the #GrabCutModes
3276
*/
3277
CV_EXPORTS_W void grabCut( InputArray img, InputOutputArray mask, Rect rect,
3278
InputOutputArray bgdModel, InputOutputArray fgdModel,
3279
int iterCount, int mode = GC_EVAL );
3280
3281
/** @example samples/cpp/distrans.cpp
3282
An example on using the distance transform
3283
*/
3284
3285
/** @brief Calculates the distance to the closest zero pixel for each pixel of the source image.
3286
3287
The function cv::distanceTransform calculates the approximate or precise distance from every binary
3288
image pixel to the nearest zero pixel. For zero image pixels, the distance will obviously be zero.
3289
3290
When maskSize == #DIST_MASK_PRECISE and distanceType == #DIST_L2 , the function runs the
3291
algorithm described in @cite Felzenszwalb04 . This algorithm is parallelized with the TBB library.
3292
3293
In other cases, the algorithm @cite Borgefors86 is used. This means that for a pixel the function
3294
finds the shortest path to the nearest zero pixel consisting of basic shifts: horizontal, vertical,
3295
diagonal, or knight's move (the latest is available for a \f$5\times 5\f$ mask). The overall
3296
distance is calculated as a sum of these basic distances. Since the distance function should be
3297
symmetric, all of the horizontal and vertical shifts must have the same cost (denoted as a ), all
3298
the diagonal shifts must have the same cost (denoted as `b`), and all knight's moves must have the
3299
same cost (denoted as `c`). For the #DIST_C and #DIST_L1 types, the distance is calculated
3300
precisely, whereas for #DIST_L2 (Euclidean distance) the distance can be calculated only with a
3301
relative error (a \f$5\times 5\f$ mask gives more accurate results). For `a`,`b`, and `c`, OpenCV
3302
uses the values suggested in the original paper:
3303
- DIST_L1: `a = 1, b = 2`
3304
- DIST_L2:
3305
- `3 x 3`: `a=0.955, b=1.3693`
3306
- `5 x 5`: `a=1, b=1.4, c=2.1969`
3307
- DIST_C: `a = 1, b = 1`
3308
3309
Typically, for a fast, coarse distance estimation #DIST_L2, a \f$3\times 3\f$ mask is used. For a
3310
more accurate distance estimation #DIST_L2, a \f$5\times 5\f$ mask or the precise algorithm is used.
3311
Note that both the precise and the approximate algorithms are linear on the number of pixels.
3312
3313
This variant of the function does not only compute the minimum distance for each pixel \f$(x, y)\f$
3314
but also identifies the nearest connected component consisting of zero pixels
3315
(labelType==#DIST_LABEL_CCOMP) or the nearest zero pixel (labelType==#DIST_LABEL_PIXEL). Index of the
3316
component/pixel is stored in `labels(x, y)`. When labelType==#DIST_LABEL_CCOMP, the function
3317
automatically finds connected components of zero pixels in the input image and marks them with
3318
distinct labels. When labelType==#DIST_LABEL_CCOMP, the function scans through the input image and
3319
marks all the zero pixels with distinct labels.
3320
3321
In this mode, the complexity is still linear. That is, the function provides a very fast way to
3322
compute the Voronoi diagram for a binary image. Currently, the second variant can use only the
3323
approximate distance transform algorithm, i.e. maskSize=#DIST_MASK_PRECISE is not supported
3324
yet.
3325
3326
@param src 8-bit, single-channel (binary) source image.
3327
@param dst Output image with calculated distances. It is a 8-bit or 32-bit floating-point,
3328
single-channel image of the same size as src.
3329
@param labels Output 2D array of labels (the discrete Voronoi diagram). It has the type
3330
CV_32SC1 and the same size as src.
3331
@param distanceType Type of distance, see #DistanceTypes
3332
@param maskSize Size of the distance transform mask, see #DistanceTransformMasks.
3333
#DIST_MASK_PRECISE is not supported by this variant. In case of the #DIST_L1 or #DIST_C distance type,
3334
the parameter is forced to 3 because a \f$3\times 3\f$ mask gives the same result as \f$5\times
3335
5\f$ or any larger aperture.
3336
@param labelType Type of the label array to build, see #DistanceTransformLabelTypes.
3337
*/
3338
CV_EXPORTS_AS(distanceTransformWithLabels) void distanceTransform( InputArray src, OutputArray dst,
3339
OutputArray labels, int distanceType, int maskSize,
3340
int labelType = DIST_LABEL_CCOMP );
3341
3342
/** @overload
3343
@param src 8-bit, single-channel (binary) source image.
3344
@param dst Output image with calculated distances. It is a 8-bit or 32-bit floating-point,
3345
single-channel image of the same size as src .
3346
@param distanceType Type of distance, see #DistanceTypes
3347
@param maskSize Size of the distance transform mask, see #DistanceTransformMasks. In case of the
3348
#DIST_L1 or #DIST_C distance type, the parameter is forced to 3 because a \f$3\times 3\f$ mask gives
3349
the same result as \f$5\times 5\f$ or any larger aperture.
3350
@param dstType Type of output image. It can be CV_8U or CV_32F. Type CV_8U can be used only for
3351
the first variant of the function and distanceType == #DIST_L1.
3352
*/
3353
CV_EXPORTS_W void distanceTransform( InputArray src, OutputArray dst,
3354
int distanceType, int maskSize, int dstType=CV_32F);
3355
3356
/** @example samples/cpp/ffilldemo.cpp
3357
An example using the FloodFill technique
3358
*/
3359
3360
/** @overload
3361
3362
variant without `mask` parameter
3363
*/
3364
CV_EXPORTS int floodFill( InputOutputArray image,
3365
Point seedPoint, Scalar newVal, CV_OUT Rect* rect = 0,
3366
Scalar loDiff = Scalar(), Scalar upDiff = Scalar(),
3367
int flags = 4 );
3368
3369
/** @brief Fills a connected component with the given color.
3370
3371
The function cv::floodFill fills a connected component starting from the seed point with the specified
3372
color. The connectivity is determined by the color/brightness closeness of the neighbor pixels. The
3373
pixel at \f$(x,y)\f$ is considered to belong to the repainted domain if:
3374
3375
- in case of a grayscale image and floating range
3376
\f[\texttt{src} (x',y')- \texttt{loDiff} \leq \texttt{src} (x,y) \leq \texttt{src} (x',y')+ \texttt{upDiff}\f]
3377
3378
3379
- in case of a grayscale image and fixed range
3380
\f[\texttt{src} ( \texttt{seedPoint} .x, \texttt{seedPoint} .y)- \texttt{loDiff} \leq \texttt{src} (x,y) \leq \texttt{src} ( \texttt{seedPoint} .x, \texttt{seedPoint} .y)+ \texttt{upDiff}\f]
3381
3382
3383
- in case of a color image and floating range
3384
\f[\texttt{src} (x',y')_r- \texttt{loDiff} _r \leq \texttt{src} (x,y)_r \leq \texttt{src} (x',y')_r+ \texttt{upDiff} _r,\f]
3385
\f[\texttt{src} (x',y')_g- \texttt{loDiff} _g \leq \texttt{src} (x,y)_g \leq \texttt{src} (x',y')_g+ \texttt{upDiff} _g\f]
3386
and
3387
\f[\texttt{src} (x',y')_b- \texttt{loDiff} _b \leq \texttt{src} (x,y)_b \leq \texttt{src} (x',y')_b+ \texttt{upDiff} _b\f]
3388
3389
3390
- in case of a color image and fixed range
3391
\f[\texttt{src} ( \texttt{seedPoint} .x, \texttt{seedPoint} .y)_r- \texttt{loDiff} _r \leq \texttt{src} (x,y)_r \leq \texttt{src} ( \texttt{seedPoint} .x, \texttt{seedPoint} .y)_r+ \texttt{upDiff} _r,\f]
3392
\f[\texttt{src} ( \texttt{seedPoint} .x, \texttt{seedPoint} .y)_g- \texttt{loDiff} _g \leq \texttt{src} (x,y)_g \leq \texttt{src} ( \texttt{seedPoint} .x, \texttt{seedPoint} .y)_g+ \texttt{upDiff} _g\f]
3393
and
3394
\f[\texttt{src} ( \texttt{seedPoint} .x, \texttt{seedPoint} .y)_b- \texttt{loDiff} _b \leq \texttt{src} (x,y)_b \leq \texttt{src} ( \texttt{seedPoint} .x, \texttt{seedPoint} .y)_b+ \texttt{upDiff} _b\f]
3395
3396
3397
where \f$src(x',y')\f$ is the value of one of pixel neighbors that is already known to belong to the
3398
component. That is, to be added to the connected component, a color/brightness of the pixel should
3399
be close enough to:
3400
- Color/brightness of one of its neighbors that already belong to the connected component in case
3401
of a floating range.
3402
- Color/brightness of the seed point in case of a fixed range.
3403
3404
Use these functions to either mark a connected component with the specified color in-place, or build
3405
a mask and then extract the contour, or copy the region to another image, and so on.
3406
3407
@param image Input/output 1- or 3-channel, 8-bit, or floating-point image. It is modified by the
3408
function unless the #FLOODFILL_MASK_ONLY flag is set in the second variant of the function. See
3409
the details below.
3410
@param mask Operation mask that should be a single-channel 8-bit image, 2 pixels wider and 2 pixels
3411
taller than image. Since this is both an input and output parameter, you must take responsibility
3412
of initializing it. Flood-filling cannot go across non-zero pixels in the input mask. For example,
3413
an edge detector output can be used as a mask to stop filling at edges. On output, pixels in the
3414
mask corresponding to filled pixels in the image are set to 1 or to the a value specified in flags
3415
as described below. Additionally, the function fills the border of the mask with ones to simplify
3416
internal processing. It is therefore possible to use the same mask in multiple calls to the function
3417
to make sure the filled areas do not overlap.
3418
@param seedPoint Starting point.
3419
@param newVal New value of the repainted domain pixels.
3420
@param loDiff Maximal lower brightness/color difference between the currently observed pixel and
3421
one of its neighbors belonging to the component, or a seed pixel being added to the component.
3422
@param upDiff Maximal upper brightness/color difference between the currently observed pixel and
3423
one of its neighbors belonging to the component, or a seed pixel being added to the component.
3424
@param rect Optional output parameter set by the function to the minimum bounding rectangle of the
3425
repainted domain.
3426
@param flags Operation flags. The first 8 bits contain a connectivity value. The default value of
3427
4 means that only the four nearest neighbor pixels (those that share an edge) are considered. A
3428
connectivity value of 8 means that the eight nearest neighbor pixels (those that share a corner)
3429
will be considered. The next 8 bits (8-16) contain a value between 1 and 255 with which to fill
3430
the mask (the default value is 1). For example, 4 | ( 255 \<\< 8 ) will consider 4 nearest
3431
neighbours and fill the mask with a value of 255. The following additional options occupy higher
3432
bits and therefore may be further combined with the connectivity and mask fill values using
3433
bit-wise or (|), see #FloodFillFlags.
3434
3435
@note Since the mask is larger than the filled image, a pixel \f$(x, y)\f$ in image corresponds to the
3436
pixel \f$(x+1, y+1)\f$ in the mask .
3437
3438
@sa findContours
3439
*/
3440
CV_EXPORTS_W int floodFill( InputOutputArray image, InputOutputArray mask,
3441
Point seedPoint, Scalar newVal, CV_OUT Rect* rect=0,
3442
Scalar loDiff = Scalar(), Scalar upDiff = Scalar(),
3443
int flags = 4 );
3444
3445
/** @brief Converts an image from one color space to another.
3446
3447
The function converts an input image from one color space to another. In case of a transformation
3448
to-from RGB color space, the order of the channels should be specified explicitly (RGB or BGR). Note
3449
that the default color format in OpenCV is often referred to as RGB but it is actually BGR (the
3450
bytes are reversed). So the first byte in a standard (24-bit) color image will be an 8-bit Blue
3451
component, the second byte will be Green, and the third byte will be Red. The fourth, fifth, and
3452
sixth bytes would then be the second pixel (Blue, then Green, then Red), and so on.
3453
3454
The conventional ranges for R, G, and B channel values are:
3455
- 0 to 255 for CV_8U images
3456
- 0 to 65535 for CV_16U images
3457
- 0 to 1 for CV_32F images
3458
3459
In case of linear transformations, the range does not matter. But in case of a non-linear
3460
transformation, an input RGB image should be normalized to the proper value range to get the correct
3461
results, for example, for RGB \f$\rightarrow\f$ L\*u\*v\* transformation. For example, if you have a
3462
32-bit floating-point image directly converted from an 8-bit image without any scaling, then it will
3463
have the 0..255 value range instead of 0..1 assumed by the function. So, before calling #cvtColor ,
3464
you need first to scale the image down:
3465
@code
3466
img *= 1./255;
3467
cvtColor(img, img, COLOR_BGR2Luv);
3468
@endcode
3469
If you use #cvtColor with 8-bit images, the conversion will have some information lost. For many
3470
applications, this will not be noticeable but it is recommended to use 32-bit images in applications
3471
that need the full range of colors or that convert an image before an operation and then convert
3472
back.
3473
3474
If conversion adds the alpha channel, its value will set to the maximum of corresponding channel
3475
range: 255 for CV_8U, 65535 for CV_16U, 1 for CV_32F.
3476
3477
@param src input image: 8-bit unsigned, 16-bit unsigned ( CV_16UC... ), or single-precision
3478
floating-point.
3479
@param dst output image of the same size and depth as src.
3480
@param code color space conversion code (see #ColorConversionCodes).
3481
@param dstCn number of channels in the destination image; if the parameter is 0, the number of the
3482
channels is derived automatically from src and code.
3483
3484
@see @ref imgproc_color_conversions
3485
*/
3486
CV_EXPORTS_W void cvtColor( InputArray src, OutputArray dst, int code, int dstCn = 0 );
3487
3488
/** @brief Converts an image from one color space to another where the source image is
3489
stored in two planes.
3490
3491
This function only supports YUV420 to RGB conversion as of now.
3492
3493
@param src1: 8-bit image (#CV_8U) of the Y plane.
3494
@param src2: image containing interleaved U/V plane.
3495
@param dst: output image.
3496
@param code: Specifies the type of conversion. It can take any of the following values:
3497
- #COLOR_YUV2BGR_NV12
3498
- #COLOR_YUV2RGB_NV12
3499
- #COLOR_YUV2BGRA_NV12
3500
- #COLOR_YUV2RGBA_NV12
3501
- #COLOR_YUV2BGR_NV21
3502
- #COLOR_YUV2RGB_NV21
3503
- #COLOR_YUV2BGRA_NV21
3504
- #COLOR_YUV2RGBA_NV21
3505
*/
3506
CV_EXPORTS_W void cvtColorTwoPlane( InputArray src1, InputArray src2, OutputArray dst, int code );
3507
3508
//! @} imgproc_misc
3509
3510
// main function for all demosaicing processes
3511
CV_EXPORTS_W void demosaicing(InputArray _src, OutputArray _dst, int code, int dcn = 0);
3512
3513
//! @addtogroup imgproc_shape
3514
//! @{
3515
3516
/** @brief Calculates all of the moments up to the third order of a polygon or rasterized shape.
3517
3518
The function computes moments, up to the 3rd order, of a vector shape or a rasterized shape. The
3519
results are returned in the structure cv::Moments.
3520
3521
@param array Raster image (single-channel, 8-bit or floating-point 2D array) or an array (
3522
\f$1 \times N\f$ or \f$N \times 1\f$ ) of 2D points (Point or Point2f ).
3523
@param binaryImage If it is true, all non-zero image pixels are treated as 1's. The parameter is
3524
used for images only.
3525
@returns moments.
3526
3527
@note Only applicable to contour moments calculations from Python bindings: Note that the numpy
3528
type for the input array should be either np.int32 or np.float32.
3529
3530
@sa contourArea, arcLength
3531
*/
3532
CV_EXPORTS_W Moments moments( InputArray array, bool binaryImage = false );
3533
3534
/** @brief Calculates seven Hu invariants.
3535
3536
The function calculates seven Hu invariants (introduced in @cite Hu62; see also
3537
<http://en.wikipedia.org/wiki/Image_moment>) defined as:
3538
3539
\f[\begin{array}{l} hu[0]= \eta _{20}+ \eta _{02} \\ hu[1]=( \eta _{20}- \eta _{02})^{2}+4 \eta _{11}^{2} \\ hu[2]=( \eta _{30}-3 \eta _{12})^{2}+ (3 \eta _{21}- \eta _{03})^{2} \\ hu[3]=( \eta _{30}+ \eta _{12})^{2}+ ( \eta _{21}+ \eta _{03})^{2} \\ hu[4]=( \eta _{30}-3 \eta _{12})( \eta _{30}+ \eta _{12})[( \eta _{30}+ \eta _{12})^{2}-3( \eta _{21}+ \eta _{03})^{2}]+(3 \eta _{21}- \eta _{03})( \eta _{21}+ \eta _{03})[3( \eta _{30}+ \eta _{12})^{2}-( \eta _{21}+ \eta _{03})^{2}] \\ hu[5]=( \eta _{20}- \eta _{02})[( \eta _{30}+ \eta _{12})^{2}- ( \eta _{21}+ \eta _{03})^{2}]+4 \eta _{11}( \eta _{30}+ \eta _{12})( \eta _{21}+ \eta _{03}) \\ hu[6]=(3 \eta _{21}- \eta _{03})( \eta _{21}+ \eta _{03})[3( \eta _{30}+ \eta _{12})^{2}-( \eta _{21}+ \eta _{03})^{2}]-( \eta _{30}-3 \eta _{12})( \eta _{21}+ \eta _{03})[3( \eta _{30}+ \eta _{12})^{2}-( \eta _{21}+ \eta _{03})^{2}] \\ \end{array}\f]
3540
3541
where \f$\eta_{ji}\f$ stands for \f$\texttt{Moments::nu}_{ji}\f$ .
3542
3543
These values are proved to be invariants to the image scale, rotation, and reflection except the
3544
seventh one, whose sign is changed by reflection. This invariance is proved with the assumption of
3545
infinite image resolution. In case of raster images, the computed Hu invariants for the original and
3546
transformed images are a bit different.
3547
3548
@param moments Input moments computed with moments .
3549
@param hu Output Hu invariants.
3550
3551
@sa matchShapes
3552
*/
3553
CV_EXPORTS void HuMoments( const Moments& moments, double hu[7] );
3554
3555
/** @overload */
3556
CV_EXPORTS_W void HuMoments( const Moments& m, OutputArray hu );
3557
3558
//! @} imgproc_shape
3559
3560
//! @addtogroup imgproc_object
3561
//! @{
3562
3563
//! type of the template matching operation
3564
enum TemplateMatchModes {
3565
TM_SQDIFF = 0, //!< \f[R(x,y)= \sum _{x',y'} (T(x',y')-I(x+x',y+y'))^2\f]
3566
TM_SQDIFF_NORMED = 1, //!< \f[R(x,y)= \frac{\sum_{x',y'} (T(x',y')-I(x+x',y+y'))^2}{\sqrt{\sum_{x',y'}T(x',y')^2 \cdot \sum_{x',y'} I(x+x',y+y')^2}}\f]
3567
TM_CCORR = 2, //!< \f[R(x,y)= \sum _{x',y'} (T(x',y') \cdot I(x+x',y+y'))\f]
3568
TM_CCORR_NORMED = 3, //!< \f[R(x,y)= \frac{\sum_{x',y'} (T(x',y') \cdot I(x+x',y+y'))}{\sqrt{\sum_{x',y'}T(x',y')^2 \cdot \sum_{x',y'} I(x+x',y+y')^2}}\f]
3569
TM_CCOEFF = 4, //!< \f[R(x,y)= \sum _{x',y'} (T'(x',y') \cdot I'(x+x',y+y'))\f]
3570
//!< where
3571
//!< \f[\begin{array}{l} T'(x',y')=T(x',y') - 1/(w \cdot h) \cdot \sum _{x'',y''} T(x'',y'') \\ I'(x+x',y+y')=I(x+x',y+y') - 1/(w \cdot h) \cdot \sum _{x'',y''} I(x+x'',y+y'') \end{array}\f]
3572
TM_CCOEFF_NORMED = 5 //!< \f[R(x,y)= \frac{ \sum_{x',y'} (T'(x',y') \cdot I'(x+x',y+y')) }{ \sqrt{\sum_{x',y'}T'(x',y')^2 \cdot \sum_{x',y'} I'(x+x',y+y')^2} }\f]
3573
};
3574
3575
/** @example samples/cpp/tutorial_code/Histograms_Matching/MatchTemplate_Demo.cpp
3576
An example using Template Matching algorithm
3577
*/
3578
3579
/** @brief Compares a template against overlapped image regions.
3580
3581
The function slides through image , compares the overlapped patches of size \f$w \times h\f$ against
3582
templ using the specified method and stores the comparison results in result . Here are the formulae
3583
for the available comparison methods ( \f$I\f$ denotes image, \f$T\f$ template, \f$R\f$ result ). The summation
3584
is done over template and/or the image patch: \f$x' = 0...w-1, y' = 0...h-1\f$
3585
3586
After the function finishes the comparison, the best matches can be found as global minimums (when
3587
#TM_SQDIFF was used) or maximums (when #TM_CCORR or #TM_CCOEFF was used) using the
3588
#minMaxLoc function. In case of a color image, template summation in the numerator and each sum in
3589
the denominator is done over all of the channels and separate mean values are used for each channel.
3590
That is, the function can take a color template and a color image. The result will still be a
3591
single-channel image, which is easier to analyze.
3592
3593
@param image Image where the search is running. It must be 8-bit or 32-bit floating-point.
3594
@param templ Searched template. It must be not greater than the source image and have the same
3595
data type.
3596
@param result Map of comparison results. It must be single-channel 32-bit floating-point. If image
3597
is \f$W \times H\f$ and templ is \f$w \times h\f$ , then result is \f$(W-w+1) \times (H-h+1)\f$ .
3598
@param method Parameter specifying the comparison method, see #TemplateMatchModes
3599
@param mask Mask of searched template. It must have the same datatype and size with templ. It is
3600
not set by default. Currently, only the #TM_SQDIFF and #TM_CCORR_NORMED methods are supported.
3601
*/
3602
CV_EXPORTS_W void matchTemplate( InputArray image, InputArray templ,
3603
OutputArray result, int method, InputArray mask = noArray() );
3604
3605
//! @}
3606
3607
//! @addtogroup imgproc_shape
3608
//! @{
3609
3610
/** @example samples/cpp/connected_components.cpp
3611
This program demonstrates connected components and use of the trackbar
3612
*/
3613
3614
/** @brief computes the connected components labeled image of boolean image
3615
3616
image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0
3617
represents the background label. ltype specifies the output label image type, an important
3618
consideration based on the total number of labels or alternatively the total number of pixels in
3619
the source image. ccltype specifies the connected components labeling algorithm to use, currently
3620
Grana (BBDT) and Wu's (SAUF) algorithms are supported, see the #ConnectedComponentsAlgorithmsTypes
3621
for details. Note that SAUF algorithm forces a row major ordering of labels while BBDT does not.
3622
This function uses parallel version of both Grana and Wu's algorithms if at least one allowed
3623
parallel framework is enabled and if the rows of the image are at least twice the number returned by #getNumberOfCPUs.
3624
3625
@param image the 8-bit single-channel image to be labeled
3626
@param labels destination labeled image
3627
@param connectivity 8 or 4 for 8-way or 4-way connectivity respectively
3628
@param ltype output image label type. Currently CV_32S and CV_16U are supported.
3629
@param ccltype connected components algorithm type (see the #ConnectedComponentsAlgorithmsTypes).
3630
*/
3631
CV_EXPORTS_AS(connectedComponentsWithAlgorithm) int connectedComponents(InputArray image, OutputArray labels,
3632
int connectivity, int ltype, int ccltype);
3633
3634
3635
/** @overload
3636
3637
@param image the 8-bit single-channel image to be labeled
3638
@param labels destination labeled image
3639
@param connectivity 8 or 4 for 8-way or 4-way connectivity respectively
3640
@param ltype output image label type. Currently CV_32S and CV_16U are supported.
3641
*/
3642
CV_EXPORTS_W int connectedComponents(InputArray image, OutputArray labels,
3643
int connectivity = 8, int ltype = CV_32S);
3644
3645
3646
/** @brief computes the connected components labeled image of boolean image and also produces a statistics output for each label
3647
3648
image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0
3649
represents the background label. ltype specifies the output label image type, an important
3650
consideration based on the total number of labels or alternatively the total number of pixels in
3651
the source image. ccltype specifies the connected components labeling algorithm to use, currently
3652
Grana's (BBDT) and Wu's (SAUF) algorithms are supported, see the #ConnectedComponentsAlgorithmsTypes
3653
for details. Note that SAUF algorithm forces a row major ordering of labels while BBDT does not.
3654
This function uses parallel version of both Grana and Wu's algorithms (statistics included) if at least one allowed
3655
parallel framework is enabled and if the rows of the image are at least twice the number returned by #getNumberOfCPUs.
3656
3657
@param image the 8-bit single-channel image to be labeled
3658
@param labels destination labeled image
3659
@param stats statistics output for each label, including the background label, see below for
3660
available statistics. Statistics are accessed via stats(label, COLUMN) where COLUMN is one of
3661
#ConnectedComponentsTypes. The data type is CV_32S.
3662
@param centroids centroid output for each label, including the background label. Centroids are
3663
accessed via centroids(label, 0) for x and centroids(label, 1) for y. The data type CV_64F.
3664
@param connectivity 8 or 4 for 8-way or 4-way connectivity respectively
3665
@param ltype output image label type. Currently CV_32S and CV_16U are supported.
3666
@param ccltype connected components algorithm type (see #ConnectedComponentsAlgorithmsTypes).
3667
*/
3668
CV_EXPORTS_AS(connectedComponentsWithStatsWithAlgorithm) int connectedComponentsWithStats(InputArray image, OutputArray labels,
3669
OutputArray stats, OutputArray centroids,
3670
int connectivity, int ltype, int ccltype);
3671
3672
/** @overload
3673
@param image the 8-bit single-channel image to be labeled
3674
@param labels destination labeled image
3675
@param stats statistics output for each label, including the background label, see below for
3676
available statistics. Statistics are accessed via stats(label, COLUMN) where COLUMN is one of
3677
#ConnectedComponentsTypes. The data type is CV_32S.
3678
@param centroids centroid output for each label, including the background label. Centroids are
3679
accessed via centroids(label, 0) for x and centroids(label, 1) for y. The data type CV_64F.
3680
@param connectivity 8 or 4 for 8-way or 4-way connectivity respectively
3681
@param ltype output image label type. Currently CV_32S and CV_16U are supported.
3682
*/
3683
CV_EXPORTS_W int connectedComponentsWithStats(InputArray image, OutputArray labels,
3684
OutputArray stats, OutputArray centroids,
3685
int connectivity = 8, int ltype = CV_32S);
3686
3687
3688
/** @brief Finds contours in a binary image.
3689
3690
The function retrieves contours from the binary image using the algorithm @cite Suzuki85 . The contours
3691
are a useful tool for shape analysis and object detection and recognition. See squares.cpp in the
3692
OpenCV sample directory.
3693
@note Since opencv 3.2 source image is not modified by this function.
3694
3695
@param image Source, an 8-bit single-channel image. Non-zero pixels are treated as 1's. Zero
3696
pixels remain 0's, so the image is treated as binary . You can use #compare, #inRange, #threshold ,
3697
#adaptiveThreshold, #Canny, and others to create a binary image out of a grayscale or color one.
3698
If mode equals to #RETR_CCOMP or #RETR_FLOODFILL, the input can also be a 32-bit integer image of labels (CV_32SC1).
3699
@param contours Detected contours. Each contour is stored as a vector of points (e.g.
3700
std::vector<std::vector<cv::Point> >).
3701
@param hierarchy Optional output vector (e.g. std::vector<cv::Vec4i>), containing information about the image topology. It has
3702
as many elements as the number of contours. For each i-th contour contours[i], the elements
3703
hierarchy[i][0] , hierarchy[i][1] , hierarchy[i][2] , and hierarchy[i][3] are set to 0-based indices
3704
in contours of the next and previous contours at the same hierarchical level, the first child
3705
contour and the parent contour, respectively. If for the contour i there are no next, previous,
3706
parent, or nested contours, the corresponding elements of hierarchy[i] will be negative.
3707
@param mode Contour retrieval mode, see #RetrievalModes
3708
@param method Contour approximation method, see #ContourApproximationModes
3709
@param offset Optional offset by which every contour point is shifted. This is useful if the
3710
contours are extracted from the image ROI and then they should be analyzed in the whole image
3711
context.
3712
*/
3713
CV_EXPORTS_W void findContours( InputArray image, OutputArrayOfArrays contours,
3714
OutputArray hierarchy, int mode,
3715
int method, Point offset = Point());
3716
3717
/** @overload */
3718
CV_EXPORTS void findContours( InputArray image, OutputArrayOfArrays contours,
3719
int mode, int method, Point offset = Point());
3720
3721
/** @example samples/cpp/squares.cpp
3722
A program using pyramid scaling, Canny, contours and contour simplification to find
3723
squares in a list of images (pic1-6.png). Returns sequence of squares detected on the image.
3724
*/
3725
3726
/** @example samples/tapi/squares.cpp
3727
A program using pyramid scaling, Canny, contours and contour simplification to find
3728
squares in the input image.
3729
*/
3730
3731
/** @brief Approximates a polygonal curve(s) with the specified precision.
3732
3733
The function cv::approxPolyDP approximates a curve or a polygon with another curve/polygon with less
3734
vertices so that the distance between them is less or equal to the specified precision. It uses the
3735
Douglas-Peucker algorithm <http://en.wikipedia.org/wiki/Ramer-Douglas-Peucker_algorithm>
3736
3737
@param curve Input vector of a 2D point stored in std::vector or Mat
3738
@param approxCurve Result of the approximation. The type should match the type of the input curve.
3739
@param epsilon Parameter specifying the approximation accuracy. This is the maximum distance
3740
between the original curve and its approximation.
3741
@param closed If true, the approximated curve is closed (its first and last vertices are
3742
connected). Otherwise, it is not closed.
3743
*/
3744
CV_EXPORTS_W void approxPolyDP( InputArray curve,
3745
OutputArray approxCurve,
3746
double epsilon, bool closed );
3747
3748
/** @brief Calculates a contour perimeter or a curve length.
3749
3750
The function computes a curve length or a closed contour perimeter.
3751
3752
@param curve Input vector of 2D points, stored in std::vector or Mat.
3753
@param closed Flag indicating whether the curve is closed or not.
3754
*/
3755
CV_EXPORTS_W double arcLength( InputArray curve, bool closed );
3756
3757
/** @brief Calculates the up-right bounding rectangle of a point set.
3758
3759
The function calculates and returns the minimal up-right bounding rectangle for the specified point set.
3760
3761
@param points Input 2D point set, stored in std::vector or Mat.
3762
*/
3763
CV_EXPORTS_W Rect boundingRect( InputArray points );
3764
3765
/** @brief Calculates a contour area.
3766
3767
The function computes a contour area. Similarly to moments , the area is computed using the Green
3768
formula. Thus, the returned area and the number of non-zero pixels, if you draw the contour using
3769
#drawContours or #fillPoly , can be different. Also, the function will most certainly give a wrong
3770
results for contours with self-intersections.
3771
3772
Example:
3773
@code
3774
vector<Point> contour;
3775
contour.push_back(Point2f(0, 0));
3776
contour.push_back(Point2f(10, 0));
3777
contour.push_back(Point2f(10, 10));
3778
contour.push_back(Point2f(5, 4));
3779
3780
double area0 = contourArea(contour);
3781
vector<Point> approx;
3782
approxPolyDP(contour, approx, 5, true);
3783
double area1 = contourArea(approx);
3784
3785
cout << "area0 =" << area0 << endl <<
3786
"area1 =" << area1 << endl <<
3787
"approx poly vertices" << approx.size() << endl;
3788
@endcode
3789
@param contour Input vector of 2D points (contour vertices), stored in std::vector or Mat.
3790
@param oriented Oriented area flag. If it is true, the function returns a signed area value,
3791
depending on the contour orientation (clockwise or counter-clockwise). Using this feature you can
3792
determine orientation of a contour by taking the sign of an area. By default, the parameter is
3793
false, which means that the absolute value is returned.
3794
*/
3795
CV_EXPORTS_W double contourArea( InputArray contour, bool oriented = false );
3796
3797
/** @brief Finds a rotated rectangle of the minimum area enclosing the input 2D point set.
3798
3799
The function calculates and returns the minimum-area bounding rectangle (possibly rotated) for a
3800
specified point set. Developer should keep in mind that the returned RotatedRect can contain negative
3801
indices when data is close to the containing Mat element boundary.
3802
3803
@param points Input vector of 2D points, stored in std::vector\<\> or Mat
3804
*/
3805
CV_EXPORTS_W RotatedRect minAreaRect( InputArray points );
3806
3807
/** @brief Finds the four vertices of a rotated rect. Useful to draw the rotated rectangle.
3808
3809
The function finds the four vertices of a rotated rectangle. This function is useful to draw the
3810
rectangle. In C++, instead of using this function, you can directly use RotatedRect::points method. Please
3811
visit the @ref tutorial_bounding_rotated_ellipses "tutorial on Creating Bounding rotated boxes and ellipses for contours" for more information.
3812
3813
@param box The input rotated rectangle. It may be the output of
3814
@param points The output array of four vertices of rectangles.
3815
*/
3816
CV_EXPORTS_W void boxPoints(RotatedRect box, OutputArray points);
3817
3818
/** @brief Finds a circle of the minimum area enclosing a 2D point set.
3819
3820
The function finds the minimal enclosing circle of a 2D point set using an iterative algorithm.
3821
3822
@param points Input vector of 2D points, stored in std::vector\<\> or Mat
3823
@param center Output center of the circle.
3824
@param radius Output radius of the circle.
3825
*/
3826
CV_EXPORTS_W void minEnclosingCircle( InputArray points,
3827
CV_OUT Point2f& center, CV_OUT float& radius );
3828
3829
/** @example samples/cpp/minarea.cpp
3830
*/
3831
3832
/** @brief Finds a triangle of minimum area enclosing a 2D point set and returns its area.
3833
3834
The function finds a triangle of minimum area enclosing the given set of 2D points and returns its
3835
area. The output for a given 2D point set is shown in the image below. 2D points are depicted in
3836
*red* and the enclosing triangle in *yellow*.
3837
3838
![Sample output of the minimum enclosing triangle function](pics/minenclosingtriangle.png)
3839
3840
The implementation of the algorithm is based on O'Rourke's @cite ORourke86 and Klee and Laskowski's
3841
@cite KleeLaskowski85 papers. O'Rourke provides a \f$\theta(n)\f$ algorithm for finding the minimal
3842
enclosing triangle of a 2D convex polygon with n vertices. Since the #minEnclosingTriangle function
3843
takes a 2D point set as input an additional preprocessing step of computing the convex hull of the
3844
2D point set is required. The complexity of the #convexHull function is \f$O(n log(n))\f$ which is higher
3845
than \f$\theta(n)\f$. Thus the overall complexity of the function is \f$O(n log(n))\f$.
3846
3847
@param points Input vector of 2D points with depth CV_32S or CV_32F, stored in std::vector\<\> or Mat
3848
@param triangle Output vector of three 2D points defining the vertices of the triangle. The depth
3849
of the OutputArray must be CV_32F.
3850
*/
3851
CV_EXPORTS_W double minEnclosingTriangle( InputArray points, CV_OUT OutputArray triangle );
3852
3853
/** @brief Compares two shapes.
3854
3855
The function compares two shapes. All three implemented methods use the Hu invariants (see #HuMoments)
3856
3857
@param contour1 First contour or grayscale image.
3858
@param contour2 Second contour or grayscale image.
3859
@param method Comparison method, see #ShapeMatchModes
3860
@param parameter Method-specific parameter (not supported now).
3861
*/
3862
CV_EXPORTS_W double matchShapes( InputArray contour1, InputArray contour2,
3863
int method, double parameter );
3864
3865
/** @example samples/cpp/convexhull.cpp
3866
An example using the convexHull functionality
3867
*/
3868
3869
/** @brief Finds the convex hull of a point set.
3870
3871
The function cv::convexHull finds the convex hull of a 2D point set using the Sklansky's algorithm @cite Sklansky82
3872
that has *O(N logN)* complexity in the current implementation.
3873
3874
@param points Input 2D point set, stored in std::vector or Mat.
3875
@param hull Output convex hull. It is either an integer vector of indices or vector of points. In
3876
the first case, the hull elements are 0-based indices of the convex hull points in the original
3877
array (since the set of convex hull points is a subset of the original point set). In the second
3878
case, hull elements are the convex hull points themselves.
3879
@param clockwise Orientation flag. If it is true, the output convex hull is oriented clockwise.
3880
Otherwise, it is oriented counter-clockwise. The assumed coordinate system has its X axis pointing
3881
to the right, and its Y axis pointing upwards.
3882
@param returnPoints Operation flag. In case of a matrix, when the flag is true, the function
3883
returns convex hull points. Otherwise, it returns indices of the convex hull points. When the
3884
output array is std::vector, the flag is ignored, and the output depends on the type of the
3885
vector: std::vector\<int\> implies returnPoints=false, std::vector\<Point\> implies
3886
returnPoints=true.
3887
3888
@note `points` and `hull` should be different arrays, inplace processing isn't supported.
3889
*/
3890
CV_EXPORTS_W void convexHull( InputArray points, OutputArray hull,
3891
bool clockwise = false, bool returnPoints = true );
3892
3893
/** @brief Finds the convexity defects of a contour.
3894
3895
The figure below displays convexity defects of a hand contour:
3896
3897
![image](pics/defects.png)
3898
3899
@param contour Input contour.
3900
@param convexhull Convex hull obtained using convexHull that should contain indices of the contour
3901
points that make the hull.
3902
@param convexityDefects The output vector of convexity defects. In C++ and the new Python/Java
3903
interface each convexity defect is represented as 4-element integer vector (a.k.a. #Vec4i):
3904
(start_index, end_index, farthest_pt_index, fixpt_depth), where indices are 0-based indices
3905
in the original contour of the convexity defect beginning, end and the farthest point, and
3906
fixpt_depth is fixed-point approximation (with 8 fractional bits) of the distance between the
3907
farthest contour point and the hull. That is, to get the floating-point value of the depth will be
3908
fixpt_depth/256.0.
3909
*/
3910
CV_EXPORTS_W void convexityDefects( InputArray contour, InputArray convexhull, OutputArray convexityDefects );
3911
3912
/** @brief Tests a contour convexity.
3913
3914
The function tests whether the input contour is convex or not. The contour must be simple, that is,
3915
without self-intersections. Otherwise, the function output is undefined.
3916
3917
@param contour Input vector of 2D points, stored in std::vector\<\> or Mat
3918
*/
3919
CV_EXPORTS_W bool isContourConvex( InputArray contour );
3920
3921
//! finds intersection of two convex polygons
3922
CV_EXPORTS_W float intersectConvexConvex( InputArray _p1, InputArray _p2,
3923
OutputArray _p12, bool handleNested = true );
3924
3925
/** @example samples/cpp/fitellipse.cpp
3926
An example using the fitEllipse technique
3927
*/
3928
3929
/** @brief Fits an ellipse around a set of 2D points.
3930
3931
The function calculates the ellipse that fits (in a least-squares sense) a set of 2D points best of
3932
all. It returns the rotated rectangle in which the ellipse is inscribed. The first algorithm described by @cite Fitzgibbon95
3933
is used. Developer should keep in mind that it is possible that the returned
3934
ellipse/rotatedRect data contains negative indices, due to the data points being close to the
3935
border of the containing Mat element.
3936
3937
@param points Input 2D point set, stored in std::vector\<\> or Mat
3938
*/
3939
CV_EXPORTS_W RotatedRect fitEllipse( InputArray points );
3940
3941
/** @brief Fits an ellipse around a set of 2D points.
3942
3943
The function calculates the ellipse that fits a set of 2D points.
3944
It returns the rotated rectangle in which the ellipse is inscribed.
3945
The Approximate Mean Square (AMS) proposed by @cite Taubin1991 is used.
3946
3947
For an ellipse, this basis set is \f$ \chi= \left(x^2, x y, y^2, x, y, 1\right) \f$,
3948
which is a set of six free coefficients \f$ A^T=\left\{A_{\text{xx}},A_{\text{xy}},A_{\text{yy}},A_x,A_y,A_0\right\} \f$.
3949
However, to specify an ellipse, all that is needed is five numbers; the major and minor axes lengths \f$ (a,b) \f$,
3950
the position \f$ (x_0,y_0) \f$, and the orientation \f$ \theta \f$. This is because the basis set includes lines,
3951
quadratics, parabolic and hyperbolic functions as well as elliptical functions as possible fits.
3952
If the fit is found to be a parabolic or hyperbolic function then the standard #fitEllipse method is used.
3953
The AMS method restricts the fit to parabolic, hyperbolic and elliptical curves
3954
by imposing the condition that \f$ A^T ( D_x^T D_x + D_y^T D_y) A = 1 \f$ where
3955
the matrices \f$ Dx \f$ and \f$ Dy \f$ are the partial derivatives of the design matrix \f$ D \f$ with
3956
respect to x and y. The matrices are formed row by row applying the following to
3957
each of the points in the set:
3958
\f{align*}{
3959
D(i,:)&=\left\{x_i^2, x_i y_i, y_i^2, x_i, y_i, 1\right\} &
3960
D_x(i,:)&=\left\{2 x_i,y_i,0,1,0,0\right\} &
3961
D_y(i,:)&=\left\{0,x_i,2 y_i,0,1,0\right\}
3962
\f}
3963
The AMS method minimizes the cost function
3964
\f{equation*}{
3965
\epsilon ^2=\frac{ A^T D^T D A }{ A^T (D_x^T D_x + D_y^T D_y) A^T }
3966
\f}
3967
3968
The minimum cost is found by solving the generalized eigenvalue problem.
3969
3970
\f{equation*}{
3971
D^T D A = \lambda \left( D_x^T D_x + D_y^T D_y\right) A
3972
\f}
3973
3974
@param points Input 2D point set, stored in std::vector\<\> or Mat
3975
*/
3976
CV_EXPORTS_W RotatedRect fitEllipseAMS( InputArray points );
3977
3978
3979
/** @brief Fits an ellipse around a set of 2D points.
3980
3981
The function calculates the ellipse that fits a set of 2D points.
3982
It returns the rotated rectangle in which the ellipse is inscribed.
3983
The Direct least square (Direct) method by @cite Fitzgibbon1999 is used.
3984
3985
For an ellipse, this basis set is \f$ \chi= \left(x^2, x y, y^2, x, y, 1\right) \f$,
3986
which is a set of six free coefficients \f$ A^T=\left\{A_{\text{xx}},A_{\text{xy}},A_{\text{yy}},A_x,A_y,A_0\right\} \f$.
3987
However, to specify an ellipse, all that is needed is five numbers; the major and minor axes lengths \f$ (a,b) \f$,
3988
the position \f$ (x_0,y_0) \f$, and the orientation \f$ \theta \f$. This is because the basis set includes lines,
3989
quadratics, parabolic and hyperbolic functions as well as elliptical functions as possible fits.
3990
The Direct method confines the fit to ellipses by ensuring that \f$ 4 A_{xx} A_{yy}- A_{xy}^2 > 0 \f$.
3991
The condition imposed is that \f$ 4 A_{xx} A_{yy}- A_{xy}^2=1 \f$ which satisfies the inequality
3992
and as the coefficients can be arbitrarily scaled is not overly restrictive.
3993
3994
\f{equation*}{
3995
\epsilon ^2= A^T D^T D A \quad \text{with} \quad A^T C A =1 \quad \text{and} \quad C=\left(\begin{matrix}
3996
0 & 0 & 2 & 0 & 0 & 0 \\
3997
0 & -1 & 0 & 0 & 0 & 0 \\
3998
2 & 0 & 0 & 0 & 0 & 0 \\
3999
0 & 0 & 0 & 0 & 0 & 0 \\
4000
0 & 0 & 0 & 0 & 0 & 0 \\
4001
0 & 0 & 0 & 0 & 0 & 0
4002
\end{matrix} \right)
4003
\f}
4004
4005
The minimum cost is found by solving the generalized eigenvalue problem.
4006
4007
\f{equation*}{
4008
D^T D A = \lambda \left( C\right) A
4009
\f}
4010
4011
The system produces only one positive eigenvalue \f$ \lambda\f$ which is chosen as the solution
4012
with its eigenvector \f$\mathbf{u}\f$. These are used to find the coefficients
4013
4014
\f{equation*}{
4015
A = \sqrt{\frac{1}{\mathbf{u}^T C \mathbf{u}}} \mathbf{u}
4016
\f}
4017
The scaling factor guarantees that \f$A^T C A =1\f$.
4018
4019
@param points Input 2D point set, stored in std::vector\<\> or Mat
4020
*/
4021
CV_EXPORTS_W RotatedRect fitEllipseDirect( InputArray points );
4022
4023
/** @brief Fits a line to a 2D or 3D point set.
4024
4025
The function fitLine fits a line to a 2D or 3D point set by minimizing \f$\sum_i \rho(r_i)\f$ where
4026
\f$r_i\f$ is a distance between the \f$i^{th}\f$ point, the line and \f$\rho(r)\f$ is a distance function, one
4027
of the following:
4028
- DIST_L2
4029
\f[\rho (r) = r^2/2 \quad \text{(the simplest and the fastest least-squares method)}\f]
4030
- DIST_L1
4031
\f[\rho (r) = r\f]
4032
- DIST_L12
4033
\f[\rho (r) = 2 \cdot ( \sqrt{1 + \frac{r^2}{2}} - 1)\f]
4034
- DIST_FAIR
4035
\f[\rho \left (r \right ) = C^2 \cdot \left ( \frac{r}{C} - \log{\left(1 + \frac{r}{C}\right)} \right ) \quad \text{where} \quad C=1.3998\f]
4036
- DIST_WELSCH
4037
\f[\rho \left (r \right ) = \frac{C^2}{2} \cdot \left ( 1 - \exp{\left(-\left(\frac{r}{C}\right)^2\right)} \right ) \quad \text{where} \quad C=2.9846\f]
4038
- DIST_HUBER
4039
\f[\rho (r) = \fork{r^2/2}{if \(r < C\)}{C \cdot (r-C/2)}{otherwise} \quad \text{where} \quad C=1.345\f]
4040
4041
The algorithm is based on the M-estimator ( <http://en.wikipedia.org/wiki/M-estimator> ) technique
4042
that iteratively fits the line using the weighted least-squares algorithm. After each iteration the
4043
weights \f$w_i\f$ are adjusted to be inversely proportional to \f$\rho(r_i)\f$ .
4044
4045
@param points Input vector of 2D or 3D points, stored in std::vector\<\> or Mat.
4046
@param line Output line parameters. In case of 2D fitting, it should be a vector of 4 elements
4047
(like Vec4f) - (vx, vy, x0, y0), where (vx, vy) is a normalized vector collinear to the line and
4048
(x0, y0) is a point on the line. In case of 3D fitting, it should be a vector of 6 elements (like
4049
Vec6f) - (vx, vy, vz, x0, y0, z0), where (vx, vy, vz) is a normalized vector collinear to the line
4050
and (x0, y0, z0) is a point on the line.
4051
@param distType Distance used by the M-estimator, see #DistanceTypes
4052
@param param Numerical parameter ( C ) for some types of distances. If it is 0, an optimal value
4053
is chosen.
4054
@param reps Sufficient accuracy for the radius (distance between the coordinate origin and the line).
4055
@param aeps Sufficient accuracy for the angle. 0.01 would be a good default value for reps and aeps.
4056
*/
4057
CV_EXPORTS_W void fitLine( InputArray points, OutputArray line, int distType,
4058
double param, double reps, double aeps );
4059
4060
/** @brief Performs a point-in-contour test.
4061
4062
The function determines whether the point is inside a contour, outside, or lies on an edge (or
4063
coincides with a vertex). It returns positive (inside), negative (outside), or zero (on an edge)
4064
value, correspondingly. When measureDist=false , the return value is +1, -1, and 0, respectively.
4065
Otherwise, the return value is a signed distance between the point and the nearest contour edge.
4066
4067
See below a sample output of the function where each image pixel is tested against the contour:
4068
4069
![sample output](pics/pointpolygon.png)
4070
4071
@param contour Input contour.
4072
@param pt Point tested against the contour.
4073
@param measureDist If true, the function estimates the signed distance from the point to the
4074
nearest contour edge. Otherwise, the function only checks if the point is inside a contour or not.
4075
*/
4076
CV_EXPORTS_W double pointPolygonTest( InputArray contour, Point2f pt, bool measureDist );
4077
4078
/** @brief Finds out if there is any intersection between two rotated rectangles.
4079
4080
If there is then the vertices of the intersecting region are returned as well.
4081
4082
Below are some examples of intersection configurations. The hatched pattern indicates the
4083
intersecting region and the red vertices are returned by the function.
4084
4085
![intersection examples](pics/intersection.png)
4086
4087
@param rect1 First rectangle
4088
@param rect2 Second rectangle
4089
@param intersectingRegion The output array of the vertices of the intersecting region. It returns
4090
at most 8 vertices. Stored as std::vector\<cv::Point2f\> or cv::Mat as Mx1 of type CV_32FC2.
4091
@returns One of #RectanglesIntersectTypes
4092
*/
4093
CV_EXPORTS_W int rotatedRectangleIntersection( const RotatedRect& rect1, const RotatedRect& rect2, OutputArray intersectingRegion );
4094
4095
//! @} imgproc_shape
4096
/** @brief Creates implementation for cv::CLAHE .
4097
4098
@param clipLimit Threshold for contrast limiting.
4099
@param tileGridSize Size of grid for histogram equalization. Input image will be divided into
4100
equally sized rectangular tiles. tileGridSize defines the number of tiles in row and column.
4101
*/
4102
CV_EXPORTS_W Ptr<CLAHE> createCLAHE(double clipLimit = 40.0, Size tileGridSize = Size(8, 8));
4103
4104
//! Ballard, D.H. (1981). Generalizing the Hough transform to detect arbitrary shapes. Pattern Recognition 13 (2): 111-122.
4105
//! Detects position only without translation and rotation
4106
CV_EXPORTS Ptr<GeneralizedHoughBallard> createGeneralizedHoughBallard();
4107
4108
//! Guil, N., González-Linares, J.M. and Zapata, E.L. (1999). Bidimensional shape detection using an invariant approach. Pattern Recognition 32 (6): 1025-1038.
4109
//! Detects position, translation and rotation
4110
CV_EXPORTS Ptr<GeneralizedHoughGuil> createGeneralizedHoughGuil();
4111
4112
//! Performs linear blending of two images:
4113
//! \f[ \texttt{dst}(i,j) = \texttt{weights1}(i,j)*\texttt{src1}(i,j) + \texttt{weights2}(i,j)*\texttt{src2}(i,j) \f]
4114
//! @param src1 It has a type of CV_8UC(n) or CV_32FC(n), where n is a positive integer.
4115
//! @param src2 It has the same type and size as src1.
4116
//! @param weights1 It has a type of CV_32FC1 and the same size with src1.
4117
//! @param weights2 It has a type of CV_32FC1 and the same size with src1.
4118
//! @param dst It is created if it does not have the same size and type with src1.
4119
CV_EXPORTS void blendLinear(InputArray src1, InputArray src2, InputArray weights1, InputArray weights2, OutputArray dst);
4120
4121
//! @addtogroup imgproc_colormap
4122
//! @{
4123
4124
//! GNU Octave/MATLAB equivalent colormaps
4125
enum ColormapTypes
4126
{
4127
COLORMAP_AUTUMN = 0, //!< ![autumn](pics/colormaps/colorscale_autumn.jpg)
4128
COLORMAP_BONE = 1, //!< ![bone](pics/colormaps/colorscale_bone.jpg)
4129
COLORMAP_JET = 2, //!< ![jet](pics/colormaps/colorscale_jet.jpg)
4130
COLORMAP_WINTER = 3, //!< ![winter](pics/colormaps/colorscale_winter.jpg)
4131
COLORMAP_RAINBOW = 4, //!< ![rainbow](pics/colormaps/colorscale_rainbow.jpg)
4132
COLORMAP_OCEAN = 5, //!< ![ocean](pics/colormaps/colorscale_ocean.jpg)
4133
COLORMAP_SUMMER = 6, //!< ![summer](pics/colormaps/colorscale_summer.jpg)
4134
COLORMAP_SPRING = 7, //!< ![spring](pics/colormaps/colorscale_spring.jpg)
4135
COLORMAP_COOL = 8, //!< ![cool](pics/colormaps/colorscale_cool.jpg)
4136
COLORMAP_HSV = 9, //!< ![HSV](pics/colormaps/colorscale_hsv.jpg)
4137
COLORMAP_PINK = 10, //!< ![pink](pics/colormaps/colorscale_pink.jpg)
4138
COLORMAP_HOT = 11, //!< ![hot](pics/colormaps/colorscale_hot.jpg)
4139
COLORMAP_PARULA = 12 //!< ![parula](pics/colormaps/colorscale_parula.jpg)
4140
};
4141
4142
/** @example samples/cpp/falsecolor.cpp
4143
An example using applyColorMap function
4144
*/
4145
4146
/** @brief Applies a GNU Octave/MATLAB equivalent colormap on a given image.
4147
4148
@param src The source image, grayscale or colored of type CV_8UC1 or CV_8UC3.
4149
@param dst The result is the colormapped source image. Note: Mat::create is called on dst.
4150
@param colormap The colormap to apply, see #ColormapTypes
4151
*/
4152
CV_EXPORTS_W void applyColorMap(InputArray src, OutputArray dst, int colormap);
4153
4154
/** @brief Applies a user colormap on a given image.
4155
4156
@param src The source image, grayscale or colored of type CV_8UC1 or CV_8UC3.
4157
@param dst The result is the colormapped source image. Note: Mat::create is called on dst.
4158
@param userColor The colormap to apply of type CV_8UC1 or CV_8UC3 and size 256
4159
*/
4160
CV_EXPORTS_W void applyColorMap(InputArray src, OutputArray dst, InputArray userColor);
4161
4162
//! @} imgproc_colormap
4163
4164
//! @addtogroup imgproc_draw
4165
//! @{
4166
4167
4168
/** OpenCV color channel order is BGR[A] */
4169
#define CV_RGB(r, g, b) cv::Scalar((b), (g), (r), 0)
4170
4171
/** @brief Draws a line segment connecting two points.
4172
4173
The function line draws the line segment between pt1 and pt2 points in the image. The line is
4174
clipped by the image boundaries. For non-antialiased lines with integer coordinates, the 8-connected
4175
or 4-connected Bresenham algorithm is used. Thick lines are drawn with rounding endings. Antialiased
4176
lines are drawn using Gaussian filtering.
4177
4178
@param img Image.
4179
@param pt1 First point of the line segment.
4180
@param pt2 Second point of the line segment.
4181
@param color Line color.
4182
@param thickness Line thickness.
4183
@param lineType Type of the line. See #LineTypes.
4184
@param shift Number of fractional bits in the point coordinates.
4185
*/
4186
CV_EXPORTS_W void line(InputOutputArray img, Point pt1, Point pt2, const Scalar& color,
4187
int thickness = 1, int lineType = LINE_8, int shift = 0);
4188
4189
/** @brief Draws a arrow segment pointing from the first point to the second one.
4190
4191
The function cv::arrowedLine draws an arrow between pt1 and pt2 points in the image. See also #line.
4192
4193
@param img Image.
4194
@param pt1 The point the arrow starts from.
4195
@param pt2 The point the arrow points to.
4196
@param color Line color.
4197
@param thickness Line thickness.
4198
@param line_type Type of the line. See #LineTypes
4199
@param shift Number of fractional bits in the point coordinates.
4200
@param tipLength The length of the arrow tip in relation to the arrow length
4201
*/
4202
CV_EXPORTS_W void arrowedLine(InputOutputArray img, Point pt1, Point pt2, const Scalar& color,
4203
int thickness=1, int line_type=8, int shift=0, double tipLength=0.1);
4204
4205
/** @brief Draws a simple, thick, or filled up-right rectangle.
4206
4207
The function cv::rectangle draws a rectangle outline or a filled rectangle whose two opposite corners
4208
are pt1 and pt2.
4209
4210
@param img Image.
4211
@param pt1 Vertex of the rectangle.
4212
@param pt2 Vertex of the rectangle opposite to pt1 .
4213
@param color Rectangle color or brightness (grayscale image).
4214
@param thickness Thickness of lines that make up the rectangle. Negative values, like #FILLED,
4215
mean that the function has to draw a filled rectangle.
4216
@param lineType Type of the line. See #LineTypes
4217
@param shift Number of fractional bits in the point coordinates.
4218
*/
4219
CV_EXPORTS_W void rectangle(InputOutputArray img, Point pt1, Point pt2,
4220
const Scalar& color, int thickness = 1,
4221
int lineType = LINE_8, int shift = 0);
4222
4223
/** @overload
4224
4225
use `rec` parameter as alternative specification of the drawn rectangle: `r.tl() and
4226
r.br()-Point(1,1)` are opposite corners
4227
*/
4228
CV_EXPORTS_W void rectangle(InputOutputArray img, Rect rec,
4229
const Scalar& color, int thickness = 1,
4230
int lineType = LINE_8, int shift = 0);
4231
4232
/** @example samples/cpp/tutorial_code/ImgProc/basic_drawing/Drawing_2.cpp
4233
An example using drawing functions
4234
*/
4235
4236
/** @brief Draws a circle.
4237
4238
The function cv::circle draws a simple or filled circle with a given center and radius.
4239
@param img Image where the circle is drawn.
4240
@param center Center of the circle.
4241
@param radius Radius of the circle.
4242
@param color Circle color.
4243
@param thickness Thickness of the circle outline, if positive. Negative values, like #FILLED,
4244
mean that a filled circle is to be drawn.
4245
@param lineType Type of the circle boundary. See #LineTypes
4246
@param shift Number of fractional bits in the coordinates of the center and in the radius value.
4247
*/
4248
CV_EXPORTS_W void circle(InputOutputArray img, Point center, int radius,
4249
const Scalar& color, int thickness = 1,
4250
int lineType = LINE_8, int shift = 0);
4251
4252
/** @brief Draws a simple or thick elliptic arc or fills an ellipse sector.
4253
4254
The function cv::ellipse with more parameters draws an ellipse outline, a filled ellipse, an elliptic
4255
arc, or a filled ellipse sector. The drawing code uses general parametric form.
4256
A piecewise-linear curve is used to approximate the elliptic arc
4257
boundary. If you need more control of the ellipse rendering, you can retrieve the curve using
4258
#ellipse2Poly and then render it with #polylines or fill it with #fillPoly. If you use the first
4259
variant of the function and want to draw the whole ellipse, not an arc, pass `startAngle=0` and
4260
`endAngle=360`. If `startAngle` is greater than `endAngle`, they are swapped. The figure below explains
4261
the meaning of the parameters to draw the blue arc.
4262
4263
![Parameters of Elliptic Arc](pics/ellipse.svg)
4264
4265
@param img Image.
4266
@param center Center of the ellipse.
4267
@param axes Half of the size of the ellipse main axes.
4268
@param angle Ellipse rotation angle in degrees.
4269
@param startAngle Starting angle of the elliptic arc in degrees.
4270
@param endAngle Ending angle of the elliptic arc in degrees.
4271
@param color Ellipse color.
4272
@param thickness Thickness of the ellipse arc outline, if positive. Otherwise, this indicates that
4273
a filled ellipse sector is to be drawn.
4274
@param lineType Type of the ellipse boundary. See #LineTypes
4275
@param shift Number of fractional bits in the coordinates of the center and values of axes.
4276
*/
4277
CV_EXPORTS_W void ellipse(InputOutputArray img, Point center, Size axes,
4278
double angle, double startAngle, double endAngle,
4279
const Scalar& color, int thickness = 1,
4280
int lineType = LINE_8, int shift = 0);
4281
4282
/** @overload
4283
@param img Image.
4284
@param box Alternative ellipse representation via RotatedRect. This means that the function draws
4285
an ellipse inscribed in the rotated rectangle.
4286
@param color Ellipse color.
4287
@param thickness Thickness of the ellipse arc outline, if positive. Otherwise, this indicates that
4288
a filled ellipse sector is to be drawn.
4289
@param lineType Type of the ellipse boundary. See #LineTypes
4290
*/
4291
CV_EXPORTS_W void ellipse(InputOutputArray img, const RotatedRect& box, const Scalar& color,
4292
int thickness = 1, int lineType = LINE_8);
4293
4294
/* ----------------------------------------------------------------------------------------- */
4295
/* ADDING A SET OF PREDEFINED MARKERS WHICH COULD BE USED TO HIGHLIGHT POSITIONS IN AN IMAGE */
4296
/* ----------------------------------------------------------------------------------------- */
4297
4298
/** @brief Draws a marker on a predefined position in an image.
4299
4300
The function cv::drawMarker draws a marker on a given position in the image. For the moment several
4301
marker types are supported, see #MarkerTypes for more information.
4302
4303
@param img Image.
4304
@param position The point where the crosshair is positioned.
4305
@param color Line color.
4306
@param markerType The specific type of marker you want to use, see #MarkerTypes
4307
@param thickness Line thickness.
4308
@param line_type Type of the line, See #LineTypes
4309
@param markerSize The length of the marker axis [default = 20 pixels]
4310
*/
4311
CV_EXPORTS_W void drawMarker(InputOutputArray img, Point position, const Scalar& color,
4312
int markerType = MARKER_CROSS, int markerSize=20, int thickness=1,
4313
int line_type=8);
4314
4315
/* ----------------------------------------------------------------------------------------- */
4316
/* END OF MARKER SECTION */
4317
/* ----------------------------------------------------------------------------------------- */
4318
4319
/** @overload */
4320
CV_EXPORTS void fillConvexPoly(Mat& img, const Point* pts, int npts,
4321
const Scalar& color, int lineType = LINE_8,
4322
int shift = 0);
4323
4324
/** @brief Fills a convex polygon.
4325
4326
The function cv::fillConvexPoly draws a filled convex polygon. This function is much faster than the
4327
function #fillPoly . It can fill not only convex polygons but any monotonic polygon without
4328
self-intersections, that is, a polygon whose contour intersects every horizontal line (scan line)
4329
twice at the most (though, its top-most and/or the bottom edge could be horizontal).
4330
4331
@param img Image.
4332
@param points Polygon vertices.
4333
@param color Polygon color.
4334
@param lineType Type of the polygon boundaries. See #LineTypes
4335
@param shift Number of fractional bits in the vertex coordinates.
4336
*/
4337
CV_EXPORTS_W void fillConvexPoly(InputOutputArray img, InputArray points,
4338
const Scalar& color, int lineType = LINE_8,
4339
int shift = 0);
4340
4341
/** @overload */
4342
CV_EXPORTS void fillPoly(Mat& img, const Point** pts,
4343
const int* npts, int ncontours,
4344
const Scalar& color, int lineType = LINE_8, int shift = 0,
4345
Point offset = Point() );
4346
4347
/** @example samples/cpp/tutorial_code/ImgProc/basic_drawing/Drawing_1.cpp
4348
An example using drawing functions
4349
Check @ref tutorial_random_generator_and_text "the corresponding tutorial" for more details
4350
*/
4351
4352
/** @brief Fills the area bounded by one or more polygons.
4353
4354
The function cv::fillPoly fills an area bounded by several polygonal contours. The function can fill
4355
complex areas, for example, areas with holes, contours with self-intersections (some of their
4356
parts), and so forth.
4357
4358
@param img Image.
4359
@param pts Array of polygons where each polygon is represented as an array of points.
4360
@param color Polygon color.
4361
@param lineType Type of the polygon boundaries. See #LineTypes
4362
@param shift Number of fractional bits in the vertex coordinates.
4363
@param offset Optional offset of all points of the contours.
4364
*/
4365
CV_EXPORTS_W void fillPoly(InputOutputArray img, InputArrayOfArrays pts,
4366
const Scalar& color, int lineType = LINE_8, int shift = 0,
4367
Point offset = Point() );
4368
4369
/** @overload */
4370
CV_EXPORTS void polylines(Mat& img, const Point* const* pts, const int* npts,
4371
int ncontours, bool isClosed, const Scalar& color,
4372
int thickness = 1, int lineType = LINE_8, int shift = 0 );
4373
4374
/** @brief Draws several polygonal curves.
4375
4376
@param img Image.
4377
@param pts Array of polygonal curves.
4378
@param isClosed Flag indicating whether the drawn polylines are closed or not. If they are closed,
4379
the function draws a line from the last vertex of each curve to its first vertex.
4380
@param color Polyline color.
4381
@param thickness Thickness of the polyline edges.
4382
@param lineType Type of the line segments. See #LineTypes
4383
@param shift Number of fractional bits in the vertex coordinates.
4384
4385
The function cv::polylines draws one or more polygonal curves.
4386
*/
4387
CV_EXPORTS_W void polylines(InputOutputArray img, InputArrayOfArrays pts,
4388
bool isClosed, const Scalar& color,
4389
int thickness = 1, int lineType = LINE_8, int shift = 0 );
4390
4391
/** @example samples/cpp/contours2.cpp
4392
An example program illustrates the use of cv::findContours and cv::drawContours
4393
\image html WindowsQtContoursOutput.png "Screenshot of the program"
4394
*/
4395
4396
/** @example samples/cpp/segment_objects.cpp
4397
An example using drawContours to clean up a background segmentation result
4398
*/
4399
4400
/** @brief Draws contours outlines or filled contours.
4401
4402
The function draws contour outlines in the image if \f$\texttt{thickness} \ge 0\f$ or fills the area
4403
bounded by the contours if \f$\texttt{thickness}<0\f$ . The example below shows how to retrieve
4404
connected components from the binary image and label them: :
4405
@include snippets/imgproc_drawContours.cpp
4406
4407
@param image Destination image.
4408
@param contours All the input contours. Each contour is stored as a point vector.
4409
@param contourIdx Parameter indicating a contour to draw. If it is negative, all the contours are drawn.
4410
@param color Color of the contours.
4411
@param thickness Thickness of lines the contours are drawn with. If it is negative (for example,
4412
thickness=#FILLED ), the contour interiors are drawn.
4413
@param lineType Line connectivity. See #LineTypes
4414
@param hierarchy Optional information about hierarchy. It is only needed if you want to draw only
4415
some of the contours (see maxLevel ).
4416
@param maxLevel Maximal level for drawn contours. If it is 0, only the specified contour is drawn.
4417
If it is 1, the function draws the contour(s) and all the nested contours. If it is 2, the function
4418
draws the contours, all the nested contours, all the nested-to-nested contours, and so on. This
4419
parameter is only taken into account when there is hierarchy available.
4420
@param offset Optional contour shift parameter. Shift all the drawn contours by the specified
4421
\f$\texttt{offset}=(dx,dy)\f$ .
4422
@note When thickness=#FILLED, the function is designed to handle connected components with holes correctly
4423
even when no hierarchy date is provided. This is done by analyzing all the outlines together
4424
using even-odd rule. This may give incorrect results if you have a joint collection of separately retrieved
4425
contours. In order to solve this problem, you need to call #drawContours separately for each sub-group
4426
of contours, or iterate over the collection using contourIdx parameter.
4427
*/
4428
CV_EXPORTS_W void drawContours( InputOutputArray image, InputArrayOfArrays contours,
4429
int contourIdx, const Scalar& color,
4430
int thickness = 1, int lineType = LINE_8,
4431
InputArray hierarchy = noArray(),
4432
int maxLevel = INT_MAX, Point offset = Point() );
4433
4434
/** @brief Clips the line against the image rectangle.
4435
4436
The function cv::clipLine calculates a part of the line segment that is entirely within the specified
4437
rectangle. it returns false if the line segment is completely outside the rectangle. Otherwise,
4438
it returns true .
4439
@param imgSize Image size. The image rectangle is Rect(0, 0, imgSize.width, imgSize.height) .
4440
@param pt1 First line point.
4441
@param pt2 Second line point.
4442
*/
4443
CV_EXPORTS bool clipLine(Size imgSize, CV_IN_OUT Point& pt1, CV_IN_OUT Point& pt2);
4444
4445
/** @overload
4446
@param imgSize Image size. The image rectangle is Rect(0, 0, imgSize.width, imgSize.height) .
4447
@param pt1 First line point.
4448
@param pt2 Second line point.
4449
*/
4450
CV_EXPORTS bool clipLine(Size2l imgSize, CV_IN_OUT Point2l& pt1, CV_IN_OUT Point2l& pt2);
4451
4452
/** @overload
4453
@param imgRect Image rectangle.
4454
@param pt1 First line point.
4455
@param pt2 Second line point.
4456
*/
4457
CV_EXPORTS_W bool clipLine(Rect imgRect, CV_OUT CV_IN_OUT Point& pt1, CV_OUT CV_IN_OUT Point& pt2);
4458
4459
/** @brief Approximates an elliptic arc with a polyline.
4460
4461
The function ellipse2Poly computes the vertices of a polyline that approximates the specified
4462
elliptic arc. It is used by #ellipse. If `arcStart` is greater than `arcEnd`, they are swapped.
4463
4464
@param center Center of the arc.
4465
@param axes Half of the size of the ellipse main axes. See #ellipse for details.
4466
@param angle Rotation angle of the ellipse in degrees. See #ellipse for details.
4467
@param arcStart Starting angle of the elliptic arc in degrees.
4468
@param arcEnd Ending angle of the elliptic arc in degrees.
4469
@param delta Angle between the subsequent polyline vertices. It defines the approximation
4470
accuracy.
4471
@param pts Output vector of polyline vertices.
4472
*/
4473
CV_EXPORTS_W void ellipse2Poly( Point center, Size axes, int angle,
4474
int arcStart, int arcEnd, int delta,
4475
CV_OUT std::vector<Point>& pts );
4476
4477
/** @overload
4478
@param center Center of the arc.
4479
@param axes Half of the size of the ellipse main axes. See #ellipse for details.
4480
@param angle Rotation angle of the ellipse in degrees. See #ellipse for details.
4481
@param arcStart Starting angle of the elliptic arc in degrees.
4482
@param arcEnd Ending angle of the elliptic arc in degrees.
4483
@param delta Angle between the subsequent polyline vertices. It defines the approximation accuracy.
4484
@param pts Output vector of polyline vertices.
4485
*/
4486
CV_EXPORTS void ellipse2Poly(Point2d center, Size2d axes, int angle,
4487
int arcStart, int arcEnd, int delta,
4488
CV_OUT std::vector<Point2d>& pts);
4489
4490
/** @brief Draws a text string.
4491
4492
The function cv::putText renders the specified text string in the image. Symbols that cannot be rendered
4493
using the specified font are replaced by question marks. See #getTextSize for a text rendering code
4494
example.
4495
4496
@param img Image.
4497
@param text Text string to be drawn.
4498
@param org Bottom-left corner of the text string in the image.
4499
@param fontFace Font type, see #HersheyFonts.
4500
@param fontScale Font scale factor that is multiplied by the font-specific base size.
4501
@param color Text color.
4502
@param thickness Thickness of the lines used to draw a text.
4503
@param lineType Line type. See #LineTypes
4504
@param bottomLeftOrigin When true, the image data origin is at the bottom-left corner. Otherwise,
4505
it is at the top-left corner.
4506
*/
4507
CV_EXPORTS_W void putText( InputOutputArray img, const String& text, Point org,
4508
int fontFace, double fontScale, Scalar color,
4509
int thickness = 1, int lineType = LINE_8,
4510
bool bottomLeftOrigin = false );
4511
4512
/** @brief Calculates the width and height of a text string.
4513
4514
The function cv::getTextSize calculates and returns the size of a box that contains the specified text.
4515
That is, the following code renders some text, the tight box surrounding it, and the baseline: :
4516
@code
4517
String text = "Funny text inside the box";
4518
int fontFace = FONT_HERSHEY_SCRIPT_SIMPLEX;
4519
double fontScale = 2;
4520
int thickness = 3;
4521
4522
Mat img(600, 800, CV_8UC3, Scalar::all(0));
4523
4524
int baseline=0;
4525
Size textSize = getTextSize(text, fontFace,
4526
fontScale, thickness, &baseline);
4527
baseline += thickness;
4528
4529
// center the text
4530
Point textOrg((img.cols - textSize.width)/2,
4531
(img.rows + textSize.height)/2);
4532
4533
// draw the box
4534
rectangle(img, textOrg + Point(0, baseline),
4535
textOrg + Point(textSize.width, -textSize.height),
4536
Scalar(0,0,255));
4537
// ... and the baseline first
4538
line(img, textOrg + Point(0, thickness),
4539
textOrg + Point(textSize.width, thickness),
4540
Scalar(0, 0, 255));
4541
4542
// then put the text itself
4543
putText(img, text, textOrg, fontFace, fontScale,
4544
Scalar::all(255), thickness, 8);
4545
@endcode
4546
4547
@param text Input text string.
4548
@param fontFace Font to use, see #HersheyFonts.
4549
@param fontScale Font scale factor that is multiplied by the font-specific base size.
4550
@param thickness Thickness of lines used to render the text. See #putText for details.
4551
@param[out] baseLine y-coordinate of the baseline relative to the bottom-most text
4552
point.
4553
@return The size of a box that contains the specified text.
4554
4555
@see putText
4556
*/
4557
CV_EXPORTS_W Size getTextSize(const String& text, int fontFace,
4558
double fontScale, int thickness,
4559
CV_OUT int* baseLine);
4560
4561
4562
/** @brief Calculates the font-specific size to use to achieve a given height in pixels.
4563
4564
@param fontFace Font to use, see cv::HersheyFonts.
4565
@param pixelHeight Pixel height to compute the fontScale for
4566
@param thickness Thickness of lines used to render the text.See putText for details.
4567
@return The fontSize to use for cv::putText
4568
4569
@see cv::putText
4570
*/
4571
CV_EXPORTS_W double getFontScaleFromHeight(const int fontFace,
4572
const int pixelHeight,
4573
const int thickness = 1);
4574
4575
/** @brief Line iterator
4576
4577
The class is used to iterate over all the pixels on the raster line
4578
segment connecting two specified points.
4579
4580
The class LineIterator is used to get each pixel of a raster line. It
4581
can be treated as versatile implementation of the Bresenham algorithm
4582
where you can stop at each pixel and do some extra processing, for
4583
example, grab pixel values along the line or draw a line with an effect
4584
(for example, with XOR operation).
4585
4586
The number of pixels along the line is stored in LineIterator::count.
4587
The method LineIterator::pos returns the current position in the image:
4588
4589
@code{.cpp}
4590
// grabs pixels along the line (pt1, pt2)
4591
// from 8-bit 3-channel image to the buffer
4592
LineIterator it(img, pt1, pt2, 8);
4593
LineIterator it2 = it;
4594
vector<Vec3b> buf(it.count);
4595
4596
for(int i = 0; i < it.count; i++, ++it)
4597
buf[i] = *(const Vec3b)*it;
4598
4599
// alternative way of iterating through the line
4600
for(int i = 0; i < it2.count; i++, ++it2)
4601
{
4602
Vec3b val = img.at<Vec3b>(it2.pos());
4603
CV_Assert(buf[i] == val);
4604
}
4605
@endcode
4606
*/
4607
class CV_EXPORTS LineIterator
4608
{
4609
public:
4610
/** @brief initializes the iterator
4611
4612
creates iterators for the line connecting pt1 and pt2
4613
the line will be clipped on the image boundaries
4614
the line is 8-connected or 4-connected
4615
If leftToRight=true, then the iteration is always done
4616
from the left-most point to the right most,
4617
not to depend on the ordering of pt1 and pt2 parameters
4618
*/
4619
LineIterator( const Mat& img, Point pt1, Point pt2,
4620
int connectivity = 8, bool leftToRight = false );
4621
/** @brief returns pointer to the current pixel
4622
*/
4623
uchar* operator *();
4624
/** @brief prefix increment operator (++it). shifts iterator to the next pixel
4625
*/
4626
LineIterator& operator ++();
4627
/** @brief postfix increment operator (it++). shifts iterator to the next pixel
4628
*/
4629
LineIterator operator ++(int);
4630
/** @brief returns coordinates of the current pixel
4631
*/
4632
Point pos() const;
4633
4634
uchar* ptr;
4635
const uchar* ptr0;
4636
int step, elemSize;
4637
int err, count;
4638
int minusDelta, plusDelta;
4639
int minusStep, plusStep;
4640
};
4641
4642
//! @cond IGNORED
4643
4644
// === LineIterator implementation ===
4645
4646
inline
4647
uchar* LineIterator::operator *()
4648
{
4649
return ptr;
4650
}
4651
4652
inline
4653
LineIterator& LineIterator::operator ++()
4654
{
4655
int mask = err < 0 ? -1 : 0;
4656
err += minusDelta + (plusDelta & mask);
4657
ptr += minusStep + (plusStep & mask);
4658
return *this;
4659
}
4660
4661
inline
4662
LineIterator LineIterator::operator ++(int)
4663
{
4664
LineIterator it = *this;
4665
++(*this);
4666
return it;
4667
}
4668
4669
inline
4670
Point LineIterator::pos() const
4671
{
4672
Point p;
4673
p.y = (int)((ptr - ptr0)/step);
4674
p.x = (int)(((ptr - ptr0) - p.y*step)/elemSize);
4675
return p;
4676
}
4677
4678
//! @endcond
4679
4680
//! @} imgproc_draw
4681
4682
//! @} imgproc
4683
4684
} // cv
4685
4686
#endif
4687
4688