blob: 6fbc56b436b42a93e4668c1b4e2fb6d953ceb46f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
|
// Copyright (C) 2009 Davis E. King (davis@dlib.net)
// License: Boost Software License See LICENSE.txt for the full license.
#undef DLIB_OPENCV_IMAGE_AbSTRACT_H_
#ifdef DLIB_OPENCV_IMAGE_AbSTRACT_H_
#include <opencv2/core/core.hpp>
#include <opencv2/core/types_c.h>
#include "../algs.h"
#include "../pixel.h"
namespace dlib
{
template <
typename pixel_type
>
class cv_image
{
/*!
REQUIREMENTS ON pixel_type
pixel_type just needs to be something that matches the pixel memory
layout of whatever OpenCV image you are going to use with this object.
For example, you might use unsigned char or bgr_pixel depending
on what you needed.
WHAT THIS OBJECT REPRESENTS
This object is meant to be used as a simple wrapper around the OpenCV
IplImage struct or Mat object. Using this class template you can turn
an OpenCV image into something that looks like a normal dlib style
image object.
So you should be able to use cv_image objects with many of the image
processing functions in dlib as well as the GUI tools for displaying
images on the screen.
Note that this object does NOT take ownership of the image data you
give to it. This means it is up to you to make sure the OpenCV image
is properly freed at some point. This also means that an instance of
this object can only be used as long as the OpenCV image it references
remains valid, since a cv_image just points to the OpenCV image's
memory directly.
!*/
public:
typedef pixel_type type;
typedef default_memory_manager mem_manager_type;
cv_image (
const IplImage* img
);
/*!
requires
- img->dataOrder == 0
(i.e. Only interleaved color channels are supported with cv_image)
- (img->depth&0xFF)/8*img->nChannels == sizeof(pixel_type)
(i.e. The size of the pixel_type needs to match the size of the pixels
inside the OpenCV image)
ensures
- #nr() == img->height
#nc() == img->width
- using the operator[] on this object you will be able to access the pixels
inside this OpenCV image.
!*/
cv_image (
const IplImage img
);
/*!
requires
- img.dataOrder == 0
(i.e. Only interleaved color channels are supported with cv_image)
- (img.depth&0xFF)/8*img.nChannels == sizeof(pixel_type)
(i.e. The size of the pixel_type needs to match the size of the pixels
inside the OpenCV image)
ensures
- #nr() == img.height
#nc() == img.width
- using the operator[] on this object you will be able to access the pixels
inside this OpenCV image.
!*/
cv_image (
const cv::Mat img
);
/*!
requires
- img.depth() == cv::DataType<pixel_traits<pixel_type>::basic_pixel_type>::depth
(i.e. The pixel_type template argument needs to match the type of pixel
used inside the OpenCV image)
- img.channels() == pixel_traits<pixel_type>::num
(i.e. the number of channels in the pixel_type needs to match the number of
channels in the OpenCV image)
ensures
- #nr() == img.rows
- #nc() == img.cols
- using the operator[] on this object you will be able to access the pixels
inside this OpenCV image.
!*/
cv_image(
);
/*!
ensures
- #nr() == 0
- #nc() == 0
!*/
~cv_image (
);
/*!
ensures
- This function does nothing. e.g. It doesn't delete the OpenCV
image used by this cv_image object
!*/
long nr(
) const;
/*!
ensures
- returns the number of rows in this image
!*/
long nc(
) const;
/*!
ensures
- returns the number of columns in this image
!*/
size_t size (
) const;
/*!
ensures
- returns nr()*nc()
(i.e. returns the number of pixels in this image)
!*/
inline pixel_type* operator[] (
const long row
);
/*!
requires
- 0 <= row < nr()
ensures
- returns a pointer to the first pixel in the given row
of this image
!*/
inline const pixel_type* operator[] (
const long row
) const;
/*!
requires
- 0 <= row < nr()
ensures
- returns a pointer to the first pixel in the given row
of this image
!*/
inline const pixel_type& operator()(
const long row, const long column
) const
/*!
requires
- 0 <= row < nr()
- 0 <= column < nc()
ensures
- returns a const reference to the pixel at coordinates (row, column)
of this image
!*/
inline pixel_type& operator()(
const long row, const long column
)
/*!
requires
- 0 <= row < nr()
- 0 <= column < nc()
ensures
- returns a reference to the pixel at coordinates (row, column)
of this image
!*/
cv_image& operator= (
const cv_image& item
);
/*!
ensures
- #*this is an identical copy of item
- returns #*this
!*/
cv_image& operator=(
const IplImage* img
);
/*!
requires
- img->dataOrder == 0
(i.e. Only interleaved color channels are supported with cv_image)
- (img->depth&0xFF)/8*img->nChannels == sizeof(pixel_type)
(i.e. The size of the pixel_type needs to match the size of the pixels
inside the OpenCV image)
ensures
- #nr() == img->height
#nc() == img->width
- using the operator[] on this object you will be able to access the pixels
inside this OpenCV image.
- returns #*this
!*/
cv_image& operator=(
const IplImage img
);
/*!
requires
- img->dataOrder == 0
(i.e. Only interleaved color channels are supported with cv_image)
- (img->depth&0xFF)/8*img->nChannels == sizeof(pixel_type)
(i.e. The size of the pixel_type needs to match the size of the pixels
inside the OpenCV image)
ensures
- #nr() == img->height
#nc() == img->width
- using the operator[] on this object you will be able to access the pixels
inside this OpenCV image.
- returns #*this
!*/
cv_image& operator=(
const cv::Mat img
);
/*!
requires
- img.depth() == cv::DataType<pixel_traits<pixel_type>::basic_pixel_type>::depth
(i.e. The pixel_type template argument needs to match the type of pixel
used inside the OpenCV image)
- img.channels() == pixel_traits<pixel_type>::num
(i.e. the number of channels in the pixel_type needs to match the number of
channels in the OpenCV image)
ensures
- #nr() == img.rows
- #nc() == img.cols
- using the operator[] on this object you will be able to access the pixels
inside this OpenCV image.
- returns #*this
!*/
long width_step (
) const;
/*!
ensures
- returns the size of one row of the image, in bytes.
More precisely, return a number N such that:
(char*)&item[0][0] + N == (char*)&item[1][0].
!*/
};
// ----------------------------------------------------------------------------------------
template <
typename T
>
const matrix_exp mat (
const cv_image<T>& img
);
/*!
ensures
- returns a matrix R such that:
- R.nr() == img.nr()
- R.nc() == img.nc()
- for all valid r and c:
R(r, c) == img[r][c]
!*/
// ----------------------------------------------------------------------------------------
}
#endif // DLIB_OPENCV_IMAGE_AbSTRACT_H_
|
