-
Notifications
You must be signed in to change notification settings - Fork 1
/
dip-Image-View.html
367 lines (365 loc) · 30.7 KB
/
dip-Image-View.html
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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>dip::Image::View class | DIPlib | a library for quantitative image analysis</title>
<link rel="stylesheet" href="m-dip+documentation.compiled.css" />
<link rel="icon" href="DIPlib_logo_32.png" type="image/png" />
<link rel="search" type="application/opensearchdescription+xml" href="opensearch.xml" title="Search DIPlib documentation" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="theme-color" content="#ffffff" />
</head>
<body>
<header><nav id="navigation">
<div class="m-container">
<div class="m-row">
<span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
<a href="https://diplib.org"><img src="DIPlib_logo.svg" alt="" />DIPlib</a><span class="m-breadcrumb">┃</span><a href="index.html" class="m-thin">a library for quantitative image analysis</a><span class="m-breadcrumb">┃</span><a href="https://github.com/DIPlib/diplib/releases/tag/3.5.1" class="m-thin">version 3.5.1</a> </span>
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
</svg></a>
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
</div>
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
<div class="m-row">
<ol class="m-col-t-6 m-col-m-none">
<li><a href="pages.html">Pages</a></li>
<li><a href="modules.html">Modules</a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="3">
<li><a href="classes.html">Classes</a></li>
<li><a href="files.html">Files</a></li>
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
</ol>
</div>
</div>
</div>
</div>
</nav></header>
<main><article>
<div class="m-container m-container-inflatable">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<h1>
<div class="m-doc-include m-right-m m-text-right">
<span class="m-code m-inverted"><span class="cp">#include</span> <a class="cpf" href="file--diplib-h.html">"diplib.h"</a></span> </div>
<span class="m-breadcrumb"><a href="dip.html">dip</a>::<wbr/></span><span class="m-breadcrumb"><a href="dip-Image.html">Image</a>::<wbr/></span>View <span class="m-thin">class</span> </h1>
<p>A view represents a subset of samples in an image. It can be assigned to to change those samples.</p>
<div class="m-block m-default">
<h3>Contents</h3>
<ul>
<li>
Reference
<ul>
<li><a href="#typeless-methods">Constructors, destructors, assignment and conversion operators</a></li>
<li><a href="#nested-classes">Classes</a></li>
<li><a href="#function-members">Functions</a></li>
<li><a href="#operator-members">Operators</a></li>
</ul>
</li>
</ul>
</div>
<p>Objects of this class are meant as an interface for indexing into images. These objects reference a subset
of pixels or samples within the image, and when assigned to, change those values. All indexing operators,
by returning a view rather than a new image, thus allow also <em>subscripted assignment</em>, assignment of new
values to a subset of pixels. For example:</p>
<div class="m-code"><pre><span></span><span class="n">dip</span><span class="o">::</span><span class="n">Image</span><span class="w"> </span><span class="n">img</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">...;</span>
<span class="n">dip</span><span class="o">::</span><span class="n">Image</span><span class="w"> </span><span class="n">mask</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">img</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span>
<span class="n">img</span><span class="p">.</span><span class="n">At</span><span class="p">(</span><span class="w"> </span><span class="n">mask</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">-</span><span class="n">img</span><span class="p">.</span><span class="n">At</span><span class="p">(</span><span class="w"> </span><span class="n">mask</span><span class="w"> </span><span class="p">);</span>
</pre></div>
<p>In the code above, <code>img.At( mask )</code> returns a <code>View</code> object. Manipulating this object yields a new image
with modified values. This image is then assigned into another <code>View</code> object, changing the values of the
image <code>img</code>.</p>
<p>A <code>dip::Image::View</code> behaves just like a <a href="dip-Image.html"><code>dip::Image</code></a>, except for the assignment operator. It can be indexed
using the <code>At</code> method in most of the same ways as a <code>dip::Image</code>, yielding a new <code>View</code> or a <a href="dip-Image-Pixel.html"><code>dip::Image::Pixel</code></a>.
It implicitly casts to a <code>dip::Image</code>, so it can be used as an input image to all functions. However, it cannot
be used as an output image in function calls. Also, methods to <code>dip::Image</code> cannot be called on a <code>View</code>, cast
the object to <code>dip::Image</code> first!</p>
<p>Note that when an irregular view (i.e. generated by a coordinate array or a mask image) is cast to a <a href="dip-Image.html"><code>dip::Image</code></a>,
a 1D image is generated which does not share data with the original image. That is, the sample values are copied
to the new image. When the view is regular (i.e. generated by a range per dimension), then the view is cast to
an image that shares the data with the original image, and no data is copied.</p>
<p>See <a href="dip-Image.html#indexing">Indexing</a> for more information.</p>
<p>Compound assignment operators are defined, but they currently do not do the computation in-place.</p>
<aside class="m-note m-default">
<h4>See also</h4>
<p><a href="dip-Image-Pixel.html"><code>dip::Image::Pixel</code></a>, <a href="dip-Image-Sample.html"><code>dip::Image::Sample</code></a></p>
</aside>
<section id="typeless-methods">
<h2>Constructors, destructors, assignment and conversion operators</h2>
<dl class="m-doc">
<dt id="dip-Image-View-operator%3D-View-R">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-operator%3D-View-R" class="m-doc-self">operator=</a>(</span><span class="m-doc-wrap"><a href="dip-Image-View.html" class="m-doc">dip::Image::View</a>&& source) -> <a href="dip-Image-View.html" class="m-doc">dip::Image::View</a>&</span>
</dt>
<dd>Move assignment doesn’t move, this behaves in the same way as the copy assignment.</dd>
<dt id="dip-Image-View-operator%3D-View-CL">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-operator%3D-View-CL" class="m-doc-self">operator=</a>(</span><span class="m-doc-wrap"><a href="dip-Image-View.html" class="m-doc">dip::Image::View</a> const& source) -> <a href="dip-Image-View.html" class="m-doc">dip::Image::View</a>&</span>
</dt>
<dd>Assigning an image <code>source</code> to a view causes the pixels from <code>source</code> to be copied to the view. See <a href="dip-Image-View.html#dip-Image-View-Copy-View-CL"><code>dip::Image::View::Copy</code></a>.</dd>
<dt id="dip-Image-View-operator%3D-Image-CL">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-operator%3D-Image-CL" class="m-doc-self">operator=</a>(</span><span class="m-doc-wrap"><a href="dip-Image.html" class="m-doc">dip::Image</a> const& source) -> <a href="dip-Image-View.html" class="m-doc">dip::Image::View</a>&</span>
</dt>
<dd>Assigning an image <code>source</code> to a view causes the pixels from <code>source</code> to be copied to the view. See <a href="dip-Image-View.html#dip-Image-View-Copy-Image-CL"><code>dip::Image::View::Copy</code></a>.</dd>
<dt id="dip-Image-View-operator%3D-Pixel-CL">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-operator%3D-Pixel-CL" class="m-doc-self">operator=</a>(</span><span class="m-doc-wrap"><a href="dip-Image-Pixel.html" class="m-doc">dip::Image::Pixel</a> const& pixel) -> <a href="dip-Image-View.html" class="m-doc">dip::Image::View</a>&</span>
</dt>
<dd>Assigning a pixel to a view causes all pixels in the view to be set to the same value. See <a href="dip-Image-View.html#dip-Image-View-Fill-Pixel-CL"><code>dip::Image::View::Fill</code></a>.</dd>
<dt id="dip-Image-View-operator%3D-Sample-CL">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-operator%3D-Sample-CL" class="m-doc-self">operator=</a>(</span><span class="m-doc-wrap"><a href="dip-Image-Sample.html" class="m-doc">dip::Image::Sample</a> const& sample) -> <a href="dip-Image-View.html" class="m-doc">dip::Image::View</a>&</span>
</dt>
<dd>Assigning a sample to a view causes all samples in the view to be set to the same value. See <a href="dip-Image-View.html#dip-Image-View-Fill-Sample-CL"><code>dip::Image::View::Fill</code></a>.</dd>
</dl>
</section>
<section id="nested-classes">
<h2>Classes</h2>
<dl class="m-doc">
<dt>
class <a href="dip-Image-View-Iterator.html" class="m-doc">Iterator</a>
</dt>
<dd>View iterator, similar in functionality to <a href="dip-GenericImageIterator-T.html"><code>dip::GenericImageIterator</code></a>.</dd>
</dl>
</section>
<section id="function-members">
<h2>Functions</h2>
<dl class="m-doc">
<dt>
<span class="m-doc-wrap-bumper">void <a href="#dip-Image-View-Copy-View-CL" class="m-doc">Copy</a>(</span><span class="m-doc-wrap"><a href="dip-Image-View.html" class="m-doc">dip::Image::View</a> const& source)</span>
</dt>
<dd>Copy the pixels from <code>source</code> to the view.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#dip-Image-View-Copy-Image-CL" class="m-doc">Copy</a>(</span><span class="m-doc-wrap"><a href="dip-Image.html" class="m-doc">dip::Image</a> const& source)</span>
</dt>
<dd>Copy the pixels from <code>source</code> to the view.</dd>
<dt id="dip-Image-View-Copy-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-Copy-C" class="m-doc-self">Copy</a>(</span><span class="m-doc-wrap">) const -> <a href="dip-Image.html" class="m-doc">dip::Image</a></span>
</dt>
<dd>Creates a copy of the view as a new image. The output will not share data with the view.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#dip-Image-View-Fill-Pixel-CL" class="m-doc">Fill</a>(</span><span class="m-doc-wrap"><a href="dip-Image-Pixel.html" class="m-doc">dip::Image::Pixel</a> const& pixel)</span>
</dt>
<dd>Sets all pixels in the view to the value <code>pixel</code>.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#dip-Image-View-Fill-Sample-CL" class="m-doc">Fill</a>(</span><span class="m-doc-wrap"><a href="dip-Image-Sample.html" class="m-doc">dip::Image::Sample</a> const& sample)</span>
</dt>
<dd>Sets all samples in the view to the value <code>sample</code>.</dd>
<dt id="dip-Image-View-At-UnsignedArray-CL-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-At-UnsignedArray-CL-C" class="m-doc-self">At</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-UnsignedArray" class="m-doc">dip::UnsignedArray</a> const& coords) const -> <a href="dip-Image-Pixel.html" class="m-doc">dip::Image::Pixel</a></span>
</dt>
<dd>Extracts the pixel at the given coordinates.</dd>
<dt id="dip-Image-View-At-T-UnsignedArray-CL-C">
<div class="m-doc-template">template<typename T></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-At-T-UnsignedArray-CL-C" class="m-doc-self">At</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-UnsignedArray" class="m-doc">dip::UnsignedArray</a> const& coords) const -> <a href="dip-Image-CastPixel-T.html" class="m-doc">dip::Image::CastPixel</a></span>
</dt>
<dd>Same as above, but returns a type that implicitly casts to <code>T</code>.</dd>
<dt id="dip-Image-View-At-dip-uint--C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-At-dip-uint--C" class="m-doc-self">At</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> index) const -> <a href="dip-Image-Pixel.html" class="m-doc">dip::Image::Pixel</a></span>
</dt>
<dd>Extracts the pixel at the given linear index (inefficient if view is not 1D!).</dd>
<dt id="dip-Image-View-At-T-dip-uint--C">
<div class="m-doc-template">template<typename T></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-At-T-dip-uint--C" class="m-doc-self">At</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> index) const -> <a href="dip-Image-CastPixel-T.html" class="m-doc">dip::Image::CastPixel</a></span>
</dt>
<dd>Same as above, but returns a type that implicitly casts to <code>T</code>.</dd>
<dt id="dip-Image-View-At-dip-uint--dip-uint--C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-At-dip-uint--dip-uint--C" class="m-doc-self">At</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> x_index,
<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> y_index) const -> <a href="dip-Image-Pixel.html" class="m-doc">dip::Image::Pixel</a></span>
</dt>
<dd>Extracts the pixel at the given coordinates from a 2D view.</dd>
<dt id="dip-Image-View-At-T-dip-uint--dip-uint--C">
<div class="m-doc-template">template<typename T></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-At-T-dip-uint--dip-uint--C" class="m-doc-self">At</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> x_index,
<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> y_index) const -> <a href="dip-Image-CastPixel-T.html" class="m-doc">dip::Image::CastPixel</a></span>
</dt>
<dd>Same as above, but returns a type that implicitly casts to <code>T</code>.</dd>
<dt id="dip-Image-View-At-dip-uint--dip-uint--dip-uint--C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-At-dip-uint--dip-uint--dip-uint--C" class="m-doc-self">At</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> x_index,
<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> y_index,
<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> z_index) const -> <a href="dip-Image-Pixel.html" class="m-doc">dip::Image::Pixel</a></span>
</dt>
<dd>Extracts the pixel at the given coordinates from a 3D view.</dd>
<dt id="dip-Image-View-At-T-dip-uint--dip-uint--dip-uint--C">
<div class="m-doc-template">template<typename T></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-At-T-dip-uint--dip-uint--dip-uint--C" class="m-doc-self">At</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> x_index,
<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> y_index,
<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> z_index) const -> <a href="dip-Image-CastPixel-T.html" class="m-doc">dip::Image::CastPixel</a></span>
</dt>
<dd>Same as above, but returns a type that implicitly casts to <code>T</code>.</dd>
<dt id="dip-Image-View-At-Range--C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-At-Range--C" class="m-doc-self">At</a>(</span><span class="m-doc-wrap"><a href="dip-Range.html" class="m-doc">dip::Range</a> x_range) const -> <a href="dip-Image-View.html" class="m-doc">dip::Image::View</a></span>
</dt>
<dd>Extracts a subset of pixels from a 1D view.</dd>
<dt id="dip-Image-View-At-Range--Range--C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-At-Range--Range--C" class="m-doc-self">At</a>(</span><span class="m-doc-wrap"><a href="dip-Range.html" class="m-doc">dip::Range</a> x_range,
<a href="dip-Range.html" class="m-doc">dip::Range</a> y_range) const -> <a href="dip-Image-View.html" class="m-doc">dip::Image::View</a></span>
</dt>
<dd>Extracts a subset of pixels from a 2D view.</dd>
<dt id="dip-Image-View-At-Range--Range--Range--C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-At-Range--Range--Range--C" class="m-doc-self">At</a>(</span><span class="m-doc-wrap"><a href="dip-Range.html" class="m-doc">dip::Range</a> x_range,
<a href="dip-Range.html" class="m-doc">dip::Range</a> y_range,
<a href="dip-Range.html" class="m-doc">dip::Range</a> z_range) const -> <a href="dip-Image-View.html" class="m-doc">dip::Image::View</a></span>
</dt>
<dd>Extracts a subset of pixels from a 3D view.</dd>
<dt id="dip-Image-View-At-RangeArray--C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-At-RangeArray--C" class="m-doc-self">At</a>(</span><span class="m-doc-wrap"><a href="dip-Range.html#dip-RangeArray" class="m-doc">dip::RangeArray</a> ranges) const -> <a href="dip-Image-View.html" class="m-doc">dip::Image::View</a></span>
</dt>
<dd>Extracts a subset of pixels from a view.</dd>
<dt id="dip-Image-View-Dimensionality-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-Dimensionality-C" class="m-doc-self">Dimensionality</a>(</span><span class="m-doc-wrap">) const -> <a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a></span>
</dt>
<dd>Returns the dimensionality of the view. Non-regular views (created by indexing using a mask image
or a coordinate array) are always 1D.</dd>
<dt id="dip-Image-View-TensorElements-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-TensorElements-C" class="m-doc-self">TensorElements</a>(</span><span class="m-doc-wrap">) const -> <a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a></span>
</dt>
<dd>Returns the number of tensor elements of the view.</dd>
<dt id="dip-Image-View-begin-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-begin-C" class="m-doc-self">begin</a>(</span><span class="m-doc-wrap">) const -> <a href="dip-Image-View-Iterator.html" class="m-doc">dip::Image::View::Iterator</a></span>
</dt>
<dd>Returns an iterator to the first pixel in the view.</dd>
<dt id="dip-Image-View-end-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-end-C" class="m-doc-self">end</a>(</span><span class="m-doc-wrap">) const -> <a href="dip-Image-View-Iterator.html" class="m-doc">dip::Image::View::Iterator</a></span>
</dt>
<dd>Returns an iterator to one past the last pixel in the view.</dd>
<dt id="dip-Image-View-IsRegular-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-IsRegular-C" class="m-doc-self">IsRegular</a>(</span><span class="m-doc-wrap">) const -> bool</span>
</dt>
<dd>Returns true if the view was obtained by regular indexing. If <code>true</code>, <code>Mask</code> and <code>Offset</code> will
be empty.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-Reference-C" class="m-doc">Reference</a>(</span><span class="m-doc-wrap">) const -> <a href="dip-Image.html" class="m-doc">dip::Image</a> const&</span>
</dt>
<dd>Returns the image being referenced.</dd>
<dt id="dip-Image-View-Mask-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-Mask-C" class="m-doc-self">Mask</a>(</span><span class="m-doc-wrap">) const -> <a href="dip-Image.html" class="m-doc">dip::Image</a> const&</span>
</dt>
<dd>Returns the view’s mask image. Will only be forged if the view was created with a mask image.</dd>
<dt id="dip-Image-View-Offsets-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-Offsets-C" class="m-doc-self">Offsets</a>(</span><span class="m-doc-wrap">) const -> <a href="supporttypes.html#dip-IntegerArray" class="m-doc">dip::IntegerArray</a> const&</span>
</dt>
<dd>Returns the view’s offsets into the referenced image. Will be empty if the view was not created
using offsets.</dd>
</dl>
</section>
<section id="operator-members">
<h2>Operators</h2>
<dl class="m-doc">
<dt id="dip-Image-View-operator%5B%5D-UnsignedArray-CL-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-operator%5B%5D-UnsignedArray-CL-C" class="m-doc-self">operator[]</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-UnsignedArray" class="m-doc">dip::UnsignedArray</a> const& indices) const -> <a href="dip-Image-View.html" class="m-doc">dip::Image::View</a></span>
</dt>
<dd>Extract a tensor element, <code>indices</code> must have one or two elements.</dd>
<dt id="dip-Image-View-operator%5B%5D-dip-uint--C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-operator%5B%5D-dip-uint--C" class="m-doc-self">operator[]</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> index) const -> <a href="dip-Image-View.html" class="m-doc">dip::Image::View</a></span>
</dt>
<dd>Extract a tensor element using linear indexing.</dd>
<dt id="dip-Image-View-operator%5B%5D-Range--C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-operator%5B%5D-Range--C" class="m-doc-self">operator[]</a>(</span><span class="m-doc-wrap"><a href="dip-Range.html" class="m-doc">dip::Range</a> range) const -> <a href="dip-Image-View.html" class="m-doc">dip::Image::View</a></span>
</dt>
<dd>Extract tensor elements using linear indexing.</dd>
</dl>
</section>
<section>
<h2>Function documentation</h2>
<section class="m-doc-details" id="dip-Image-View-Copy-View-CL"><div>
<h3>
<span class="m-doc-wrap-bumper">void
</span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#dip-Image-View-Copy-View-CL" class="m-doc-self">Copy</a>(</span><span class="m-doc-wrap"><a href="dip-Image-View.html" class="m-doc">dip::Image::View</a> const& source)</span></span>
</h3>
<p>Copy the pixels from <code>source</code> to the view.</p>
<p><code>source</code> must have the same number of tensor elements as <code>this</code>.
If both <code>source</code> and <code>this</code> are a regular view, they must have identical sizes, except that
trailing singleton dimensions are ignored. If either is a non-regular view, both views must have
the same number of pixels, shapes are ignored.
<code>source</code> pixel values are cast in the usual way to the type of <code>this</code>.</p>
</div></section>
<section class="m-doc-details" id="dip-Image-View-Copy-Image-CL"><div>
<h3>
<span class="m-doc-wrap-bumper">void
</span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#dip-Image-View-Copy-Image-CL" class="m-doc-self">Copy</a>(</span><span class="m-doc-wrap"><a href="dip-Image.html" class="m-doc">dip::Image</a> const& source)</span></span>
</h3>
<p>Copy the pixels from <code>source</code> to the view.</p>
<p><code>source</code> must have the same number of tensor elements as <code>this</code>, and be forged.
For the case of a regular view, the view and <code>source</code> must have identical sizes, except that
trailing singleton dimensions are ignored. For non-regular views, <code>source</code> must have the same
number of pixels as the view, its shape is ignored.
<code>source</code> pixel values are cast in the usual way to the type of <code>this</code>.</p>
</div></section>
<section class="m-doc-details" id="dip-Image-View-Fill-Pixel-CL"><div>
<h3>
<span class="m-doc-wrap-bumper">void
</span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#dip-Image-View-Fill-Pixel-CL" class="m-doc-self">Fill</a>(</span><span class="m-doc-wrap"><a href="dip-Image-Pixel.html" class="m-doc">dip::Image::Pixel</a> const& pixel)</span></span>
</h3>
<p>Sets all pixels in the view to the value <code>pixel</code>.</p>
<p><code>pixel</code> must have the same number of tensor elements as the image, or be a scalar.
Its values will be clipped to the target range and/or truncated, as applicable.</p>
</div></section>
<section class="m-doc-details" id="dip-Image-View-Fill-Sample-CL"><div>
<h3>
<span class="m-doc-wrap-bumper">void
</span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#dip-Image-View-Fill-Sample-CL" class="m-doc-self">Fill</a>(</span><span class="m-doc-wrap"><a href="dip-Image-Sample.html" class="m-doc">dip::Image::Sample</a> const& sample)</span></span>
</h3>
<p>Sets all samples in the view to the value <code>sample</code>.</p>
<p>The value will be clipped to the target range and/or truncated, as applicable.</p>
</div></section>
<section class="m-doc-details" id="dip-Image-View-Reference-C"><div>
<h3>
<span class="m-doc-wrap-bumper"><a href="dip-Image.html" class="m-doc">dip::Image</a> const&
</span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#dip-Image-View-Reference-C" class="m-doc-self">Reference</a>(</span><span class="m-doc-wrap">) const</span></span>
</h3>
<p>Returns the image being referenced.</p>
<p>If <code>IsRegular</code> is true, the image contains only the referenced set of pixels, it is a subset of the
image referenced. In this case, the returned image will be the same as that obtained from casting the
view to an image.</p>
</div></section>
</section>
</div>
</div>
</div>
</article></main>
<div class="m-doc-search" id="search">
<a href="#!" onclick="return hideSearch()"></a>
<div class="m-container">
<div class="m-row">
<div class="m-col-m-8 m-push-m-2">
<div class="m-doc-search-header m-text m-small">
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
<div id="search-symbolcount">…</div>
</div>
<div class="m-doc-search-content">
<form action="https://diplib.org/diplib-docs/#search">
<input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
</form>
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript. Enable it or <a href="https://google.com/search?q=site:diplib.org+">use an external search engine</a>.</noscript>
<div id="search-help" class="m-text m-dim m-text-center">
<p class="m-noindent">Search for symbols, directories, files, pages or modules.
You can omit any prefix from the symbol or file path; adding a <code>:</code> or
<code>/</code> suffix lists all members of given symbol or directory.</p>
<p class="m-noindent">Use <span class="m-label m-dim">↓</span> / <span class="m-label m-dim">↑</span> to navigate through the list,
<span class="m-label m-dim">Enter</span> to go.
<span class="m-label m-dim">Tab</span> autocompletes common prefix.
You can copy a link to the result using <span class="m-label m-dim">⌘</span> <span class="m-label m-dim">L</span>,
or <span class="m-label m-dim">⌘</span> <span class="m-label m-dim">M</span> to copy a Markdown link.</p>
</div>
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.<br />Maybe try a full-text <a href="#" id="search-external" data-search-engine="https://google.com/search?q=site:diplib.org+{query}">search with external engine</a>?</div>
<ul id="search-results"></ul>
</div>
</div>
</div>
</div>
</div>
<script src="search-v1.js"></script>
<script src="searchdata-v1.js" async="async"></script>
<footer><nav>
<div class="m-container">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<p>DIPlib, a library for quantitative image analysis. Documentation compiled with <a href="https://crisluengo.github.io/doxpp/">dox++</a> and styled with <a href="https://mcss.mosra.cz/">m.css</a>.</p>
</div>
</div>
</div>
</nav></footer>
</body>
</html>