-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathdip-GenericJointImageIterator-T.html
425 lines (419 loc) · 39 KB
/
dip-GenericJointImageIterator-T.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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>dip::GenericJointImageIterator 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.2" class="m-thin">version 3.5.2</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-thin m-right-m m-text-right">
<a href="iterators.html" class="m-doc">Iterators</a> module<br/><span class="m-code m-thin">#include <a href="file--diplib--generic_iterators-h.html">"diplib/generic_iterators.h"</a></span> </div>
<div class="m-doc-template"><span class="m-doc-wrap-bumper">template<</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> N,
typename T = <a href="pixeltypes.html#dip-dfloat" class="m-doc">dip::dfloat</a>></span></div>
<span class="m-breadcrumb"><a href="dip.html">dip</a>::<wbr/></span>GenericJointImageIterator <span class="m-thin">class</span> </h1>
<p>A data-type–agnostic version of <a href="dip-JointImageIterator-T.html"><code>dip::JointImageIterator</code></a>. Use this iterator only to write code that
does not know at compile-time what the data type of the image is.</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="#alias-members">Aliases</a></li>
<li><a href="#function-members">Functions</a></li>
<li><a href="#operator-members">Operators</a></li>
</ul>
</li>
</ul>
</div>
<p>This iterator works similarly to <a href="dip-JointImageIterator-T.html"><code>dip::JointImageIterator</code></a>. The <code>Pointer<N></code> method returns a <code>void</code>
pointer to the first sample in the pixel for image <code>N</code>. This is the more efficient way of using the
iterator.</p>
<p>The <code>Sample<N></code> method returns a <a href="dip-Image-Sample.html"><code>dip::Image::Sample</code></a> object. This object references the sample, so that
assigning to it changes the samples’s value in the image. It is convenient in use, but not very efficient.
The optional template argument to <code>GenericJointImageIterator</code> sets the template argument to the
<a href="dip-Image-CastSample-T.html"><code>dip::Image::CastSample</code></a> object that is actually returned by the method. Choose a type in which you wish
to work, but know that this choice will not affect the results of reading from and assigning to the
samples. The only difference is the type to which the output can implicitly be cast to.</p>
<p>Example usage slightly modified from <a href="dip-Image.html#dip-Image-Copy-Image-CL"><code>dip::Image::Copy</code></a>:</p>
<div class="m-code"><pre><span></span><span class="n">dip</span><span class="o">::</span><span class="n">uint</span><span class="w"> </span><span class="n">processingDim</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Framework</span><span class="o">::</span><span class="n">OptimalProcessingDim</span><span class="p">(</span><span class="w"> </span><span class="n">src</span><span class="w"> </span><span class="p">);</span>
<span class="k">auto</span><span class="w"> </span><span class="n">it</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">dip</span><span class="o">::</span><span class="n">GenericJointImageIterator</span><span class="o"><</span><span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="o">></span><span class="p">(</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="n">src</span><span class="p">,</span><span class="w"> </span><span class="n">dest</span><span class="w"> </span><span class="p">},</span><span class="w"> </span><span class="n">processingDim</span><span class="w"> </span><span class="p">);</span>
<span class="k">do</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="n">detail</span><span class="o">::</span><span class="n">CopyBuffer</span><span class="p">(</span>
<span class="w"> </span><span class="n">it</span><span class="p">.</span><span class="n">InPointer</span><span class="p">(),</span>
<span class="w"> </span><span class="n">src</span><span class="p">.</span><span class="n">DataType</span><span class="p">(),</span>
<span class="w"> </span><span class="n">src</span><span class="p">.</span><span class="n">Stride</span><span class="p">(</span><span class="w"> </span><span class="n">processingDim</span><span class="w"> </span><span class="p">),</span>
<span class="w"> </span><span class="n">src</span><span class="p">.</span><span class="n">TensorStride</span><span class="p">(),</span>
<span class="w"> </span><span class="n">it</span><span class="p">.</span><span class="n">OutPointer</span><span class="p">(),</span>
<span class="w"> </span><span class="n">dest</span><span class="p">.</span><span class="n">DataType</span><span class="p">(),</span>
<span class="w"> </span><span class="n">dest</span><span class="p">.</span><span class="n">Stride</span><span class="p">(</span><span class="w"> </span><span class="n">processingDim</span><span class="w"> </span><span class="p">),</span>
<span class="w"> </span><span class="n">dest</span><span class="p">.</span><span class="n">TensorStride</span><span class="p">(),</span>
<span class="w"> </span><span class="n">dest</span><span class="p">.</span><span class="n">Size</span><span class="p">(</span><span class="w"> </span><span class="n">processingDim</span><span class="w"> </span><span class="p">),</span>
<span class="w"> </span><span class="n">dest</span><span class="p">.</span><span class="n">TensorElements</span><span class="p">()</span>
<span class="w"> </span><span class="p">);</span>
<span class="p">}</span><span class="w"> </span><span class="k">while</span><span class="p">(</span><span class="w"> </span><span class="o">++</span><span class="n">it</span><span class="w"> </span><span class="p">);</span>
</pre></div>
<p>Note that when an image is stripped or reforged, all its iterators are invalidated.</p>
<aside class="m-note m-default">
<h4>See also</h4>
<p><a href="using_iterators.html">Using iterators to implement filters</a>, <a href="dip-JointImageIterator-T.html"><code>dip::JointImageIterator</code></a>, <a href="dip-GenericImageIterator-T.html"><code>dip::GenericImageIterator</code></a></p>
</aside>
<section id="typeless-methods">
<h2>Constructors, destructors, assignment and conversion operators</h2>
<dl class="m-doc">
<dt id="dip-GenericJointImageIterator-T-GenericJointImageIterator">
<span class="m-doc-wrap-bumper"><a href="#dip-GenericJointImageIterator-T-GenericJointImageIterator" class="m-doc-self">GenericJointImageIterator</a>(</span><span class="m-doc-wrap">)</span>
</dt>
<dd>Default constructor yields an invalid iterator that cannot be dereferenced, and is equivalent to an end iterator</dd>
<dt id="dip-GenericJointImageIterator-T-GenericJointImageIterator-ImageConstRefArray-CL-dip-uint-">
<span class="m-doc-wrap-bumper"><a href="#dip-GenericJointImageIterator-T-GenericJointImageIterator-ImageConstRefArray-CL-dip-uint-" class="m-doc-self">GenericJointImageIterator</a>(</span><span class="m-doc-wrap"><a href="dip-Image.html#dip-ImageConstRefArray" class="m-doc">dip::ImageConstRefArray</a> const& images,
<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> procDim = std::numeric_limits<dip::uint>::max()) <span class="m-label m-flat m-info">explicit</span> </span>
</dt>
<dd>To construct a useful iterator, provide two images, and optionally a processing dimension</dd>
</dl>
</section>
<section id="alias-members">
<h2>Aliases</h2>
<dl class="m-doc">
<dt id="dip-GenericJointImageIterator-T-iterator_category">
using <a href="#dip-GenericJointImageIterator-T-iterator_category" class="m-doc-self">iterator_category</a> = std::forward_iterator_tag
</dt>
<dd>Iterator category</dd>
<dt id="dip-GenericJointImageIterator-T-value_type">
using <a href="#dip-GenericJointImageIterator-T-value_type" class="m-doc-self">value_type</a> = <a href="dip-Image-CastPixel-T.html" class="m-doc">dip::Image::CastPixel</a>
</dt>
<dd>The type of the pixel, obtained when dereferencing the iterator</dd>
<dt id="dip-GenericJointImageIterator-T-reference">
using <a href="#dip-GenericJointImageIterator-T-reference" class="m-doc-self">reference</a> = <a href="dip-GenericJointImageIterator-T.html#dip-GenericJointImageIterator-T-value_type" class="m-doc">dip::GenericJointImageIterator::value_type</a>
</dt>
<dd>The type of a reference to a pixel (note dip::Image::CastPixel references a value in the image)</dd>
<dt id="dip-GenericJointImageIterator-T-pointer">
using <a href="#dip-GenericJointImageIterator-T-pointer" class="m-doc-self">pointer</a> = <a href="dip-GenericJointImageIterator-T.html#dip-GenericJointImageIterator-T-value_type" class="m-doc">dip::GenericJointImageIterator::value_type</a>*
</dt>
<dd>The type of a pointer to a pixel</dd>
</dl>
</section>
<section id="function-members">
<h2>Functions</h2>
<dl class="m-doc">
<dt id="dip-GenericJointImageIterator-T-swap-T-GenericJointImageIterator<N, S>-L">
<div class="m-doc-template">template<typename S></div>
<span class="m-doc-wrap-bumper">void <a href="#dip-GenericJointImageIterator-T-swap-T-GenericJointImageIterator<N, S>-L" class="m-doc-self">swap</a>(</span><span class="m-doc-wrap"><a href="dip-GenericJointImageIterator-T.html" class="m-doc">dip::GenericJointImageIterator</a>& other)</span>
</dt>
<dd>Swap</dd>
<dt id="dip-GenericJointImageIterator-T-Sample-T-dip-uint--C">
<div class="m-doc-template">template<<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> I></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-Sample-T-dip-uint--C" class="m-doc-self">Sample</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-CastSample-T.html" class="m-doc">dip::Image::CastSample</a></span>
</dt>
<dd>Index into image tensor for image <code>I</code></dd>
<dt id="dip-GenericJointImageIterator-T-InSample-dip-uint--C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-InSample-dip-uint--C" class="m-doc-self">InSample</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-CastSample-T.html" class="m-doc">dip::Image::CastSample</a></span>
</dt>
<dd>Index into image tensor for image 0.</dd>
<dt id="dip-GenericJointImageIterator-T-OutSample-dip-uint--C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-OutSample-dip-uint--C" class="m-doc-self">OutSample</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-CastSample-T.html" class="m-doc">dip::Image::CastSample</a></span>
</dt>
<dd>Index into image tensor for image 1.</dd>
<dt id="dip-GenericJointImageIterator-T-Sample-T-C">
<div class="m-doc-template">template<<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> I></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-Sample-T-C" class="m-doc-self">Sample</a>(</span><span class="m-doc-wrap">) const -> <a href="dip-Image-CastSample-T.html" class="m-doc">dip::Image::CastSample</a></span>
</dt>
<dd>Get first tensor element for image <code>I</code>.</dd>
<dt id="dip-GenericJointImageIterator-T-In-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-In-C" class="m-doc-self">In</a>(</span><span class="m-doc-wrap">) const -> <a href="dip-GenericJointImageIterator-T.html#dip-GenericJointImageIterator-T-value_type" class="m-doc">dip::GenericJointImageIterator::value_type</a></span>
</dt>
<dd>Get pixel for image 0.</dd>
<dt id="dip-GenericJointImageIterator-T-Out-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-Out-C" class="m-doc-self">Out</a>(</span><span class="m-doc-wrap">) const -> <a href="dip-GenericJointImageIterator-T.html#dip-GenericJointImageIterator-T-value_type" class="m-doc">dip::GenericJointImageIterator::value_type</a></span>
</dt>
<dd>Get pixel for image 1.</dd>
<dt id="dip-GenericJointImageIterator-T-Pixel-T-C">
<div class="m-doc-template">template<<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> I></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-Pixel-T-C" class="m-doc-self">Pixel</a>(</span><span class="m-doc-wrap">) const -> <a href="dip-GenericJointImageIterator-T.html#dip-GenericJointImageIterator-T-value_type" class="m-doc">dip::GenericJointImageIterator::value_type</a></span>
</dt>
<dd>Get pixel for image <code>I</code>.</dd>
<dt id="dip-GenericJointImageIterator-T-begin-T-C">
<div class="m-doc-template">template<<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> I></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-begin-T-C" class="m-doc-self">begin</a>(</span><span class="m-doc-wrap">) const -> typename value_type::Iterator</span>
</dt>
<dd>Get an iterator over the tensor for the current pixel of image <code>I</code></dd>
<dt id="dip-GenericJointImageIterator-T-end-T-C">
<div class="m-doc-template">template<<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> I></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-end-T-C" class="m-doc-self">end</a>(</span><span class="m-doc-wrap">) const -> typename value_type::Iterator</span>
</dt>
<dd>Get an end iterator over the tensor for the current pixel of image <code>I</code></dd>
<dt id="dip-GenericJointImageIterator-T-GetLineIterator-T-C">
<div class="m-doc-template">template<<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> I, typename S = T></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-GetLineIterator-T-C" class="m-doc-self">GetLineIterator</a>(</span><span class="m-doc-wrap">) const -> <a href="dip-LineIterator-T.html" class="m-doc">dip::LineIterator</a></span>
</dt>
<dd>Get an iterator over the current line of image <code>I</code></dd>
<dt id="dip-GenericJointImageIterator-T-GetConstLineIterator-T-C">
<div class="m-doc-template">template<<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> I, typename S = T></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-GetConstLineIterator-T-C" class="m-doc-self">GetConstLineIterator</a>(</span><span class="m-doc-wrap">) const -> <a href="dip-LineIterator-T.html#dip-ConstLineIterator-T" class="m-doc">dip::ConstLineIterator</a></span>
</dt>
<dd>Get a const iterator over the current line of image <code>I</code></dd>
<dt id="dip-GenericJointImageIterator-T-IsAtEnd-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-IsAtEnd-C" class="m-doc-self">IsAtEnd</a>(</span><span class="m-doc-wrap">) const -> bool</span>
</dt>
<dd>Test to see if the iterator reached past the last pixel</dd>
<dt id="dip-GenericJointImageIterator-T-Coordinates-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-Coordinates-C" class="m-doc-self">Coordinates</a>(</span><span class="m-doc-wrap">) const -> <a href="supporttypes.html#dip-UnsignedArray" class="m-doc">dip::UnsignedArray</a> const&</span>
</dt>
<dd>Return the current coordinates</dd>
<dt id="dip-GenericJointImageIterator-T-SetCoordinates-UnsignedArray-">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-SetCoordinates-UnsignedArray-" class="m-doc-self">SetCoordinates</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-UnsignedArray" class="m-doc">dip::UnsignedArray</a> coords) -> <a href="dip-GenericJointImageIterator-T.html" class="m-doc">dip::GenericJointImageIterator</a>&</span>
</dt>
<dd>Set the iterator to point at a different location in the image</dd>
<dt id="dip-GenericJointImageIterator-T-Sizes-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-Sizes-C" class="m-doc-self">Sizes</a>(</span><span class="m-doc-wrap">) const -> <a href="supporttypes.html#dip-UnsignedArray" class="m-doc">dip::UnsignedArray</a> const&</span>
</dt>
<dd>Return the sizes of the images we’re iterating over.</dd>
<dt id="dip-GenericJointImageIterator-T-ProcessingDimensionSize-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-ProcessingDimensionSize-C" class="m-doc-self">ProcessingDimensionSize</a>(</span><span class="m-doc-wrap">) const -> <a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a></span>
</dt>
<dd>Return the size along the processing dimension.</dd>
<dt id="dip-GenericJointImageIterator-T-Strides-T-C">
<div class="m-doc-template">template<<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> I></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-Strides-T-C" class="m-doc-self">Strides</a>(</span><span class="m-doc-wrap">) const -> <a href="supporttypes.html#dip-IntegerArray" class="m-doc">dip::IntegerArray</a> const&</span>
</dt>
<dd>Return the strides used to iterate over the image <code>I</code>.</dd>
<dt id="dip-GenericJointImageIterator-T-ProcessingDimensionStride-T-C">
<div class="m-doc-template">template<<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> I></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-ProcessingDimensionStride-T-C" class="m-doc-self">ProcessingDimensionStride</a>(</span><span class="m-doc-wrap">) const -> <a href="supporttypes.html#dip-sint" class="m-doc">dip::sint</a></span>
</dt>
<dd>Return the stride along the processing dimension.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-IsOnEdge-C" class="m-doc">IsOnEdge</a>(</span><span class="m-doc-wrap">) const -> bool</span>
</dt>
<dd>Return true if the iterator points at a pixel on the edge of the image. <a href="#dip-GenericJointImageIterator-T-IsOnEdge-C">more...</a></dd>
<dt id="dip-GenericJointImageIterator-T-Pointer-T-dip-uint--C">
<div class="m-doc-template">template<<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> I></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-Pointer-T-dip-uint--C" class="m-doc-self">Pointer</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> index) const -> void*</span>
</dt>
<dd>Index into image tensor for image <code>I</code></dd>
<dt id="dip-GenericJointImageIterator-T-InPointer-dip-uint--C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-InPointer-dip-uint--C" class="m-doc-self">InPointer</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> index) const -> void*</span>
</dt>
<dd>Index into image tensor for image 0.</dd>
<dt id="dip-GenericJointImageIterator-T-OutPointer-dip-uint--C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-OutPointer-dip-uint--C" class="m-doc-self">OutPointer</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> index) const -> void*</span>
</dt>
<dd>Index into image tensor for image 1.</dd>
<dt id="dip-GenericJointImageIterator-T-Pointer-T-C">
<div class="m-doc-template">template<<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> I></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-Pointer-T-C" class="m-doc-self">Pointer</a>(</span><span class="m-doc-wrap">) const -> void*</span>
</dt>
<dd>Return the current pointer for image <code>I</code></dd>
<dt id="dip-GenericJointImageIterator-T-InPointer-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-InPointer-C" class="m-doc-self">InPointer</a>(</span><span class="m-doc-wrap">) const -> void*</span>
</dt>
<dd>Return the current pointer for image 0.</dd>
<dt id="dip-GenericJointImageIterator-T-OutPointer-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-OutPointer-C" class="m-doc-self">OutPointer</a>(</span><span class="m-doc-wrap">) const -> void*</span>
</dt>
<dd>Return the current pointer for image 1.</dd>
<dt id="dip-GenericJointImageIterator-T-Offset-T-C">
<div class="m-doc-template">template<<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> I></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-Offset-T-C" class="m-doc-self">Offset</a>(</span><span class="m-doc-wrap">) const -> <a href="supporttypes.html#dip-sint" class="m-doc">dip::sint</a></span>
</dt>
<dd>Return the current offset for image <code>I</code></dd>
<dt id="dip-GenericJointImageIterator-T-InOffset-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-InOffset-C" class="m-doc-self">InOffset</a>(</span><span class="m-doc-wrap">) const -> <a href="supporttypes.html#dip-sint" class="m-doc">dip::sint</a></span>
</dt>
<dd>Index into image tensor for image 0.</dd>
<dt id="dip-GenericJointImageIterator-T-OutOffset-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-OutOffset-C" class="m-doc-self">OutOffset</a>(</span><span class="m-doc-wrap">) const -> <a href="supporttypes.html#dip-sint" class="m-doc">dip::sint</a></span>
</dt>
<dd>Index into image tensor for image 1.</dd>
<dt id="dip-GenericJointImageIterator-T-Index-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-Index-C" class="m-doc-self">Index</a>(</span><span class="m-doc-wrap">) const -> <a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a></span>
</dt>
<dd>Return the current index, which is computed: this function is not trivial</dd>
<dt id="dip-GenericJointImageIterator-T-HasProcessingDimension-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-HasProcessingDimension-C" class="m-doc-self">HasProcessingDimension</a>(</span><span class="m-doc-wrap">) const -> bool</span>
</dt>
<dd>True if the processing dimension is set</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-ProcessingDimension-C" class="m-doc">ProcessingDimension</a>(</span><span class="m-doc-wrap">) const -> <a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a></span>
</dt>
<dd>Return the processing dimension, the direction of the lines over which the iterator iterates. <a href="#dip-GenericJointImageIterator-T-ProcessingDimension-C">more...</a></dd>
<dt id="dip-GenericJointImageIterator-T-Reset">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-Reset" class="m-doc-self">Reset</a>(</span><span class="m-doc-wrap">) -> <a href="dip-GenericJointImageIterator-T.html" class="m-doc">dip::GenericJointImageIterator</a>&</span>
</dt>
<dd>Reset the iterator to the first pixel in the image (as it was when first created)</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-Optimize-dip-uint-" class="m-doc">Optimize</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> n = 0) -> <a href="dip-GenericJointImageIterator-T.html" class="m-doc">dip::GenericJointImageIterator</a>&</span>
</dt>
<dd>Optimizes the order in which the iterator visits the image pixels. <a href="#dip-GenericJointImageIterator-T-Optimize-dip-uint-">more...</a></dd>
<dt id="dip-GenericJointImageIterator-T-OptimizeAndFlatten-dip-uint-">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-OptimizeAndFlatten-dip-uint-" class="m-doc-self">OptimizeAndFlatten</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> n = 0) -> <a href="dip-GenericJointImageIterator-T.html" class="m-doc">dip::GenericJointImageIterator</a>&</span>
</dt>
<dd>Like <code>Optimize</code>, but additionally folds dimensions together where possible (flattens the image,
so that the iterator has fewer dimensions to work with). The processing dimension is not affected.</dd>
</dl>
</section>
<section id="operator-members">
<h2>Operators</h2>
<dl class="m-doc">
<dt id="dip-GenericJointImageIterator-T-operator%2B%2B">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-operator%2B%2B" class="m-doc-self">operator++</a>(</span><span class="m-doc-wrap">) -> <a href="dip-GenericJointImageIterator-T.html" class="m-doc">dip::GenericJointImageIterator</a>&</span>
</dt>
<dd>Pre-increment</dd>
<dt id="dip-GenericJointImageIterator-T-operator%2B%2B-int-">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-operator%2B%2B-int-" class="m-doc-self">operator++</a>(</span><span class="m-doc-wrap">int ) -> <a href="dip-GenericJointImageIterator-T.html" class="m-doc">dip::GenericJointImageIterator</a></span>
</dt>
<dd>Post-increment</dd>
<dt id="dip-GenericJointImageIterator-T-operator%3D%3D-T-GenericJointImageIterator<N, S>-CL-C">
<div class="m-doc-template">template<typename S></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-operator%3D%3D-T-GenericJointImageIterator<N, S>-CL-C" class="m-doc-self">operator==</a>(</span><span class="m-doc-wrap"><a href="dip-GenericJointImageIterator-T.html" class="m-doc">dip::GenericJointImageIterator</a> const& other) const -> bool</span>
</dt>
<dd>Equality comparison, is equal if the two iterators have the same coordinates.</dd>
<dt id="dip-GenericJointImageIterator-T-operator%21%3D-T-GenericJointImageIterator<N, S>-CL-C">
<div class="m-doc-template">template<typename S></div>
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-operator%21%3D-T-GenericJointImageIterator<N, S>-CL-C" class="m-doc-self">operator!=</a>(</span><span class="m-doc-wrap"><a href="dip-GenericJointImageIterator-T.html" class="m-doc">dip::GenericJointImageIterator</a> const& other) const -> bool</span>
</dt>
<dd>Inequality comparison</dd>
<dt id="dip-GenericJointImageIterator-T-operator%20bool-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-GenericJointImageIterator-T-operator%20bool-C" class="m-doc-self">operator bool</a>(</span><span class="m-doc-wrap">) const -> bool <span class="m-label m-flat m-info">explicit</span> </span>
</dt>
<dd>Test to see if the iterator is still pointing at a pixel</dd>
</dl>
</section>
<section>
<h2>Function documentation</h2>
<section class="m-doc-details" id="dip-GenericJointImageIterator-T-IsOnEdge-C"><div>
<h3>
<div class="m-doc-template">
template<<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> N, typename T>
</div>
<span class="m-doc-wrap-bumper">bool
</span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#dip-GenericJointImageIterator-T-IsOnEdge-C" class="m-doc-self">IsOnEdge</a>(</span><span class="m-doc-wrap">) const</span></span>
</h3>
<p>Return true if the iterator points at a pixel on the edge of the image.</p>
<p>If there is a processing dimension, then the iterator always points at an edge pixel; in this case
only returns true if all pixels on the line are edge pixels (i.e. the first and last pixel of the
line are not counted).</p>
</div></section>
<section class="m-doc-details" id="dip-GenericJointImageIterator-T-ProcessingDimension-C"><div>
<h3>
<div class="m-doc-template">
template<<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> N, typename T>
</div>
<span class="m-doc-wrap-bumper"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a>
</span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#dip-GenericJointImageIterator-T-ProcessingDimension-C" class="m-doc-self">ProcessingDimension</a>(</span><span class="m-doc-wrap">) const</span></span>
</h3>
<p>Return the processing dimension, the direction of the lines over which the iterator iterates.</p>
<p>If the return value is larger or equal to the dimensionality (i.e. not one of the image dimensions), then
there is no processing dimension.</p>
</div></section>
<section class="m-doc-details" id="dip-GenericJointImageIterator-T-Optimize-dip-uint-"><div>
<h3>
<div class="m-doc-template">
template<<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> N, typename T>
</div>
<span class="m-doc-wrap-bumper"><a href="dip-GenericJointImageIterator-T.html" class="m-doc">dip::GenericJointImageIterator</a>&
</span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#dip-GenericJointImageIterator-T-Optimize-dip-uint-" class="m-doc-self">Optimize</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> n = 0)</span></span>
</h3>
<p>Optimizes the order in which the iterator visits the image pixels.</p>
<p>The iterator internally reorders and flips image dimensions to change the linear index to match
the storage order of the first image (see <a href="dip-Image.html#dip-Image-StandardizeStrides"><code>dip::Image::StandardizeStrides</code></a>), or image <code>n</code>
if a parameter is given.
If the image’s strides were not normal, this will significantly increase the speed of reading or
writing to the image. Expanded singleton dimensions are eliminated only if the dimension is expanded
in all images. Additionally, singleton dimensions are ignored.</p>
<p>After calling this function, <code>Coordinates</code> and <code>Index</code> no longer match the input images. Do not
use this method if the order of accessing pixels is relevant, or if <code>Coordinates</code> are needed.</p>
<p>Note that the processing dimension stride could change sign. Use <code>ProcessingDimensionStride</code>.
If the processing dimension was a singleton dimension, or singleton-expanded, the iterator will
no longer have a singleton dimension. In this case, <code>HasProcessingDimension</code> will return false.</p>
<p>The iterator is reset to the first pixel.</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>