-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathdip-Image-View-Iterator.html
226 lines (221 loc) · 16 KB
/
dip-Image-View-Iterator.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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>dip::Image::View::Iterator 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">
<span class="m-code m-thin">#include <a 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><span class="m-breadcrumb"><a href="dip-Image-View.html">View</a>::<wbr/></span>Iterator <span class="m-thin">class</span> </h1>
<p>View iterator, similar in functionality to <a href="dip-GenericImageIterator-T.html"><code>dip::GenericImageIterator</code></a>.</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>
<section id="typeless-methods">
<h2>Constructors, destructors, assignment and conversion operators</h2>
<dl class="m-doc">
<dt id="dip-Image-View-Iterator-Iterator">
<span class="m-doc-wrap-bumper"><a href="#dip-Image-View-Iterator-Iterator" class="m-doc-self">Iterator</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-Image-View-Iterator-Iterator-View-CL">
<span class="m-doc-wrap-bumper"><a href="#dip-Image-View-Iterator-Iterator-View-CL" class="m-doc-self">Iterator</a>(</span><span class="m-doc-wrap"><a href="dip-Image-View.html" class="m-doc">dip::Image::View</a> const& view) <span class="m-label m-flat m-info">explicit</span> </span>
</dt>
<dd>To construct a useful iterator, provide a view</dd>
<dt id="dip-Image-View-Iterator-Iterator-View-R">
<span class="m-doc-wrap-bumper"><a href="#dip-Image-View-Iterator-Iterator-View-R" class="m-doc-self">Iterator</a>(</span><span class="m-doc-wrap"><a href="dip-Image-View.html" class="m-doc">dip::Image::View</a>&& view) <span class="m-label m-flat m-info">explicit</span> </span>
</dt>
<dd>To construct a useful iterator, provide a view</dd>
</dl>
</section>
<section id="alias-members">
<h2>Aliases</h2>
<dl class="m-doc">
<dt id="dip-Image-View-Iterator-iterator_category">
using <a href="#dip-Image-View-Iterator-iterator_category" class="m-doc-self">iterator_category</a> = std::forward_iterator_tag
</dt>
<dd>Iterator category</dd>
<dt id="dip-Image-View-Iterator-value_type">
using <a href="#dip-Image-View-Iterator-value_type" class="m-doc-self">value_type</a> = <a href="dip-Image-Pixel.html" class="m-doc">dip::Image::Pixel</a>
</dt>
<dd>The data type obtained when dereferencing the iterator</dd>
<dt id="dip-Image-View-Iterator-reference">
using <a href="#dip-Image-View-Iterator-reference" class="m-doc-self">reference</a> = <a href="dip-Image-View-Iterator.html#dip-Image-View-Iterator-value_type" class="m-doc">dip::Image::View::Iterator::value_type</a>
</dt>
<dd>The type of a reference to a pixel</dd>
<dt id="dip-Image-View-Iterator-pointer">
using <a href="#dip-Image-View-Iterator-pointer" class="m-doc-self">pointer</a> = <a href="dip-Image-View-Iterator.html#dip-Image-View-Iterator-value_type" class="m-doc">dip::Image::View::Iterator::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-Image-View-Iterator-begin-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-Iterator-begin-C" class="m-doc-self">begin</a>(</span><span class="m-doc-wrap">) const -> value_type::Iterator</span>
</dt>
<dd>Get an iterator over the tensor for the current pixel, <code>it.begin()</code> is equal to <code>(*it).begin()</code>.</dd>
<dt id="dip-Image-View-Iterator-end-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-Iterator-end-C" class="m-doc-self">end</a>(</span><span class="m-doc-wrap">) const -> value_type::Iterator</span>
</dt>
<dd>Get an end iterator over the tensor for the current pixel</dd>
<dt id="dip-Image-View-Iterator-IsAtEnd-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-Iterator-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-Image-View-Iterator-Pointer-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-Iterator-Pointer-C" class="m-doc-self">Pointer</a>(</span><span class="m-doc-wrap">) const -> void*</span>
</dt>
<dd>Return the current pointer</dd>
<dt id="dip-Image-View-Iterator-Pointer-dip-uint--C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-Iterator-Pointer-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>Return a pointer to the tensor element <code>index</code></dd>
<dt id="dip-Image-View-Iterator-Offset-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-Iterator-Offset-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</dd>
<dt id="dip-Image-View-Iterator-Position-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-Iterator-Position-C" class="m-doc-self">Position</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 position within the view (i.e. how many times we’ve advanced the iterator)</dd>
<dt id="dip-Image-View-Iterator-Reset">
<span class="m-doc-wrap-bumper">void <a href="#dip-Image-View-Iterator-Reset" class="m-doc-self">Reset</a>(</span><span class="m-doc-wrap">)</span>
</dt>
<dd>Reset the iterator to the first pixel in the image (as it was when first created)</dd>
</dl>
</section>
<section id="operator-members">
<h2>Operators</h2>
<dl class="m-doc">
<dt id="dip-Image-View-Iterator-operator%2A-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-Iterator-operator%2A-C" class="m-doc-self">operator*</a>(</span><span class="m-doc-wrap">) const -> <a href="dip-Image-View-Iterator.html#dip-Image-View-Iterator-value_type" class="m-doc">dip::Image::View::Iterator::value_type</a></span>
</dt>
<dd>Dereference</dd>
<dt id="dip-Image-View-Iterator-operator-%3E-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-Iterator-operator-%3E-C" class="m-doc-self">operator-></a>(</span><span class="m-doc-wrap">) const -> <a href="dip-Image-View-Iterator.html#dip-Image-View-Iterator-value_type" class="m-doc">dip::Image::View::Iterator::value_type</a></span>
</dt>
<dd>Dereference</dd>
<dt id="dip-Image-View-Iterator-operator%5B%5D-dip-uint--C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-Iterator-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-Sample.html" class="m-doc">dip::Image::Sample</a></span>
</dt>
<dd>Index into tensor, <code>it[index]</code> is equal to <code>(*it)[index]</code>.</dd>
<dt id="dip-Image-View-Iterator-operator%2B%2B">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-Iterator-operator%2B%2B" class="m-doc-self">operator++</a>(</span><span class="m-doc-wrap">) -> <a href="dip-Image-View-Iterator.html" class="m-doc">dip::Image::View::Iterator</a>&</span>
</dt>
<dd>Pre-increment</dd>
<dt id="dip-Image-View-Iterator-operator%3D%3D-Iterator-CL-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-Iterator-operator%3D%3D-Iterator-CL-C" class="m-doc-self">operator==</a>(</span><span class="m-doc-wrap"><a href="dip-Image-View-Iterator.html" class="m-doc">dip::Image::View::Iterator</a> const& other) const -> bool</span>
</dt>
<dd>Equality comparison, is equal if the two iterators have the same position.</dd>
<dt id="dip-Image-View-Iterator-operator%21%3D-Iterator-CL-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-Iterator-operator%21%3D-Iterator-CL-C" class="m-doc-self">operator!=</a>(</span><span class="m-doc-wrap"><a href="dip-Image-View-Iterator.html" class="m-doc">dip::Image::View::Iterator</a> const& other) const -> bool</span>
</dt>
<dd>Inequality comparison</dd>
<dt id="dip-Image-View-Iterator-operator%20bool-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Image-View-Iterator-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>
</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>