-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathdip-Framework.html
387 lines (382 loc) · 34.9 KB
/
dip-Framework.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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>dip::Framework namespace | 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="frameworks.html" class="m-doc">Frameworks</a> module<br/><span class="m-code m-thin">#include <a href="file--diplib--framework-h.html">"diplib/framework.h"</a></span> </div>
<span class="m-breadcrumb"><a href="dip.html">dip</a>::<wbr/></span>Framework <span class="m-thin">namespace</span> </h1>
<p>Frameworks are the basis of most pixel-based processing in <em>DIPlib</em>.</p>
<div class="m-block m-default">
<h3>Contents</h3>
<ul>
<li>
Reference
<ul>
<li><a href="#nested-classes">Classes</a></li>
<li><a href="#alias-members">Aliases</a></li>
<li><a href="#enum-members">Enums</a></li>
<li><a href="#function-members">Functions</a></li>
</ul>
</li>
</ul>
</div>
<section id="nested-classes">
<h2>Classes</h2>
<dl class="m-doc">
<dt>
struct <a href="frameworks.html#dip-Framework-ScanBuffer" class="m-doc">ScanBuffer</a>
</dt>
<dd>Structure that holds information about input or output pixel buffers for the <a href="frameworks.html#dip-Framework-Scan-ImageConstRefArray-CL-ImageRefArray-L-DataTypeArray-CL-DataTypeArray-CL-DataTypeArray-CL-UnsignedArray-CL-ScanLineFilter-L-ScanOptions-"><code>dip::Framework::Scan</code></a>
callback function object.</dd>
<dt>
struct <a href="frameworks.html#dip-Framework-ScanLineFilterParameters" class="m-doc">ScanLineFilterParameters</a>
</dt>
<dd>Parameters to the line filter for <a href="frameworks.html#dip-Framework-Scan-ImageConstRefArray-CL-ImageRefArray-L-DataTypeArray-CL-DataTypeArray-CL-DataTypeArray-CL-UnsignedArray-CL-ScanLineFilter-L-ScanOptions-"><code>dip::Framework::Scan</code></a>.</dd>
<dt>
class <a href="dip-Framework-ScanLineFilter.html" class="m-doc">ScanLineFilter</a> <span class="m-label m-flat m-warning">abstract</span>
</dt>
<dd>Prototype line filter for <a href="frameworks.html#dip-Framework-Scan-ImageConstRefArray-CL-ImageRefArray-L-DataTypeArray-CL-DataTypeArray-CL-DataTypeArray-CL-UnsignedArray-CL-ScanLineFilter-L-ScanOptions-"><code>dip::Framework::Scan</code></a>.</dd>
<dt>
<div class="m-doc-template">template<<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> N, typename TPI, typename F></div>
class <a href="dip-Framework-VariadicScanLineFilter-T.html" class="m-doc">VariadicScanLineFilter</a>
</dt>
<dd>An implementation of the ScanLinefilter for N input images and 1 output image.</dd>
<dt>
struct <a href="frameworks.html#dip-Framework-SeparableBuffer" class="m-doc">SeparableBuffer</a>
</dt>
<dd>Structure that holds information about input or output pixel buffers
for the <a href="frameworks.html#dip-Framework-Separable-Image-CL-Image-L-DataType--DataType--BooleanArray--UnsignedArray--BoundaryConditionArray--SeparableLineFilter-L-SeparableOptions-"><code>dip::Framework::Separable</code></a> callback function object.</dd>
<dt>
struct <a href="frameworks.html#dip-Framework-SeparableLineFilterParameters" class="m-doc">SeparableLineFilterParameters</a>
</dt>
<dd>Parameters to the line filter for <a href="frameworks.html#dip-Framework-Separable-Image-CL-Image-L-DataType--DataType--BooleanArray--UnsignedArray--BoundaryConditionArray--SeparableLineFilter-L-SeparableOptions-"><code>dip::Framework::Separable</code></a>.</dd>
<dt>
class <a href="dip-Framework-SeparableLineFilter.html" class="m-doc">SeparableLineFilter</a> <span class="m-label m-flat m-warning">abstract</span>
</dt>
<dd>Prototype line filter for <a href="frameworks.html#dip-Framework-Separable-Image-CL-Image-L-DataType--DataType--BooleanArray--UnsignedArray--BoundaryConditionArray--SeparableLineFilter-L-SeparableOptions-"><code>dip::Framework::Separable</code></a>.</dd>
<dt>
struct <a href="frameworks.html#dip-Framework-FullBuffer" class="m-doc">FullBuffer</a>
</dt>
<dd>Structure that holds information about input or output pixel buffers
for the <a href="frameworks.html#dip-Framework-Full-Image-CL-Image-L-DataType--DataType--DataType--dip-uint--BoundaryConditionArray-CL-Kernel-CL-FullLineFilter-L-FullOptions-"><code>dip::Framework::Full</code></a> callback function object.</dd>
<dt>
struct <a href="frameworks.html#dip-Framework-FullLineFilterParameters" class="m-doc">FullLineFilterParameters</a>
</dt>
<dd>Parameters to the line filter for <a href="frameworks.html#dip-Framework-Full-Image-CL-Image-L-DataType--DataType--DataType--dip-uint--BoundaryConditionArray-CL-Kernel-CL-FullLineFilter-L-FullOptions-"><code>dip::Framework::Full</code></a>.</dd>
<dt>
class <a href="dip-Framework-FullLineFilter.html" class="m-doc">FullLineFilter</a> <span class="m-label m-flat m-warning">abstract</span>
</dt>
<dd>Prototype line filter for <a href="frameworks.html#dip-Framework-Full-Image-CL-Image-L-DataType--DataType--DataType--dip-uint--BoundaryConditionArray-CL-Kernel-CL-FullLineFilter-L-FullOptions-"><code>dip::Framework::Full</code></a>.</dd>
<dt>
class <a href="dip-Framework-ProjectionFunction.html" class="m-doc">ProjectionFunction</a> <span class="m-label m-flat m-warning">abstract</span>
</dt>
<dd>Prototype line filter for <a href="frameworks.html#dip-Framework-Projection-Image-CL-Image-CL-Image-L-DataType--BooleanArray--ProjectionFunction-L-ProjectionOptions-"><code>dip::Framework::Projection</code></a>.</dd>
</dl>
</section>
<section id="alias-members">
<h2>Aliases</h2>
<dl class="m-doc">
<dt>
using <a href="frameworks.html#dip-Framework-ScanOptions" class="m-doc">ScanOptions</a> = dip::detail::Options
</dt>
<dd>Combines any number of <a href="frameworks.html#dip-Framework-ScanOption"><code>dip::Framework::ScanOption</code></a> constants together.</dd>
<dt>
using <a href="frameworks.html#dip-Framework-SeparableOptions" class="m-doc">SeparableOptions</a> = dip::detail::Options
</dt>
<dd>Combines any number of <a href="frameworks.html#dip-Framework-SeparableOption"><code>dip::Framework::SeparableOption</code></a> constants together.</dd>
<dt>
using <a href="frameworks.html#dip-Framework-FullOptions" class="m-doc">FullOptions</a> = dip::detail::Options
</dt>
<dd>Combines any number of <a href="frameworks.html#dip-Framework-FullOption"><code>dip::Framework::FullOption</code></a> constants together.</dd>
<dt>
using <a href="frameworks.html#dip-Framework-ProjectionOptions" class="m-doc">ProjectionOptions</a> = dip::detail::Options
</dt>
<dd>Combines any number of <a href="frameworks.html#dip-Framework-ProjectionOption"><code>dip::Framework::ProjectionOption</code></a> constants together.</dd>
</dl>
</section>
<section id="enum-members">
<h2>Enums</h2>
<dl class="m-doc">
<dt>
<span class="m-doc-wrap-bumper">enum class <a href="frameworks.html#dip-Framework-ScanOption" class="m-doc">ScanOption</a>: uint8{ </span><span class="m-doc-wrap"><a href="#dip-Framework-ScanOption-NoMultiThreading" class="m-doc">NoMultiThreading</a>,
<a href="#dip-Framework-ScanOption-NeedCoordinates" class="m-doc">NeedCoordinates</a>,
<a href="#dip-Framework-ScanOption-TensorAsSpatialDim" class="m-doc">TensorAsSpatialDim</a>,
<a href="#dip-Framework-ScanOption-ExpandTensorInBuffer" class="m-doc">ExpandTensorInBuffer</a>,
<a href="#dip-Framework-ScanOption-NoSingletonExpansion" class="m-doc">NoSingletonExpansion</a>,
<a href="#dip-Framework-ScanOption-NotInPlace" class="m-doc">NotInPlace</a> }</span>
</dt>
<dd>Defines options to the <a href="frameworks.html#dip-Framework-Scan-ImageConstRefArray-CL-ImageRefArray-L-DataTypeArray-CL-DataTypeArray-CL-DataTypeArray-CL-UnsignedArray-CL-ScanLineFilter-L-ScanOptions-"><code>dip::Framework::Scan</code></a> function.</dd>
<dt>
<span class="m-doc-wrap-bumper">enum class <a href="frameworks.html#dip-Framework-SeparableOption" class="m-doc">SeparableOption</a>: uint8{ </span><span class="m-doc-wrap"><a href="#dip-Framework-SeparableOption-NoMultiThreading" class="m-doc">NoMultiThreading</a>,
<a href="#dip-Framework-SeparableOption-AsScalarImage" class="m-doc">AsScalarImage</a>,
<a href="#dip-Framework-SeparableOption-ExpandTensorInBuffer" class="m-doc">ExpandTensorInBuffer</a>,
<a href="#dip-Framework-SeparableOption-UseOutputBorder" class="m-doc">UseOutputBorder</a>,
<a href="#dip-Framework-SeparableOption-DontResizeOutput" class="m-doc">DontResizeOutput</a>,
<a href="#dip-Framework-SeparableOption-UseInputBuffer" class="m-doc">UseInputBuffer</a>,
<a href="#dip-Framework-SeparableOption-UseOutputBuffer" class="m-doc">UseOutputBuffer</a>,
<a href="#dip-Framework-SeparableOption-CanWorkInPlace" class="m-doc">CanWorkInPlace</a>,
<a href="#dip-Framework-SeparableOption-UseRealComponentOfOutput" class="m-doc">UseRealComponentOfOutput</a> }</span>
</dt>
<dd>Defines options to the <a href="frameworks.html#dip-Framework-Separable-Image-CL-Image-L-DataType--DataType--BooleanArray--UnsignedArray--BoundaryConditionArray--SeparableLineFilter-L-SeparableOptions-"><code>dip::Framework::Separable</code></a> function.</dd>
<dt>
<span class="m-doc-wrap-bumper">enum class <a href="frameworks.html#dip-Framework-FullOption" class="m-doc">FullOption</a>: uint8{ </span><span class="m-doc-wrap"><a href="#dip-Framework-FullOption-NoMultiThreading" class="m-doc">NoMultiThreading</a>,
<a href="#dip-Framework-FullOption-AsScalarImage" class="m-doc">AsScalarImage</a>,
<a href="#dip-Framework-FullOption-ExpandTensorInBuffer" class="m-doc">ExpandTensorInBuffer</a>,
<a href="#dip-Framework-FullOption-BorderAlreadyExpanded" class="m-doc">BorderAlreadyExpanded</a> }</span>
</dt>
<dd>Defines options to the <a href="frameworks.html#dip-Framework-Full-Image-CL-Image-L-DataType--DataType--DataType--dip-uint--BoundaryConditionArray-CL-Kernel-CL-FullLineFilter-L-FullOptions-"><code>dip::Framework::Full</code></a> function.</dd>
<dt>
<span class="m-doc-wrap-bumper">enum class <a href="frameworks.html#dip-Framework-ProjectionOption" class="m-doc">ProjectionOption</a>: uint8{ </span><span class="m-doc-wrap"><a href="#dip-Framework-ProjectionOption-NoMultiThreading" class="m-doc">NoMultiThreading</a> }</span>
</dt>
<dd>Defines options to the <a href="frameworks.html#dip-Framework-Projection-Image-CL-Image-CL-Image-L-DataType--BooleanArray--ProjectionFunction-L-ProjectionOptions-"><code>dip::Framework::Projection</code></a> function.</dd>
</dl>
</section>
<section id="function-members">
<h2>Functions</h2>
<dl class="m-doc">
<dt>
<span class="m-doc-wrap-bumper">void <a href="frameworks.html#dip-Framework-SingletonExpandedSize-UnsignedArray-L-UnsignedArray-CL" class="m-doc">SingletonExpandedSize</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-UnsignedArray" class="m-doc">dip::UnsignedArray</a>& size1,
<a href="supporttypes.html#dip-UnsignedArray" class="m-doc">dip::UnsignedArray</a> const& size2)</span>
</dt>
<dd>Determines the singleton-expanded size as a combination of the two sizes.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="frameworks.html#dip-Framework-SingletonExpandedSize-ImageConstRefArray-CL" class="m-doc">SingletonExpandedSize</a>(</span><span class="m-doc-wrap"><a href="dip-Image.html#dip-ImageConstRefArray" class="m-doc">dip::ImageConstRefArray</a> const& in) -> <a href="supporttypes.html#dip-UnsignedArray" class="m-doc">dip::UnsignedArray</a></span>
</dt>
<dd>Determines if images can be singleton-expanded to the same size, and what that size would be.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="frameworks.html#dip-Framework-SingletonExpandedSize-ImageArray-CL" class="m-doc">SingletonExpandedSize</a>(</span><span class="m-doc-wrap"><a href="dip-Image.html#dip-ImageArray" class="m-doc">dip::ImageArray</a> const& in) -> <a href="supporttypes.html#dip-UnsignedArray" class="m-doc">dip::UnsignedArray</a></span>
</dt>
<dd>Determines if images can be singleton-expanded to the same size, and what that size would be.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="frameworks.html#dip-Framework-SingletonExpendedTensorElements-ImageArray-CL" class="m-doc">SingletonExpendedTensorElements</a>(</span><span class="m-doc-wrap"><a href="dip-Image.html#dip-ImageArray" class="m-doc">dip::ImageArray</a> const& in) -> <a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a></span>
</dt>
<dd>Determines if tensors in images can be singleton-expanded to the same size, and what that size would be.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="frameworks.html#dip-Framework-OptimalProcessingDim-Image-CL" class="m-doc">OptimalProcessingDim</a>(</span><span class="m-doc-wrap"><a href="dip-Image.html" class="m-doc">dip::Image</a> const& in) -> <a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a></span>
</dt>
<dd>Determines the best processing dimension, which is the one with the smallest stride, except if that
dimension is very small and there’s a longer dimension.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="frameworks.html#dip-Framework-OptimalProcessingDim-Image-CL-UnsignedArray-CL" class="m-doc">OptimalProcessingDim</a>(</span><span class="m-doc-wrap"><a href="dip-Image.html" class="m-doc">dip::Image</a> const& in,
<a href="supporttypes.html#dip-UnsignedArray" class="m-doc">dip::UnsignedArray</a> const& kernelSizes) -> <a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a></span>
</dt>
<dd>Determines the best processing dimension as above, but giving preference to a dimension where
<code>kernelSizes</code> is large also.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="frameworks.html#dip-Framework-Scan-ImageConstRefArray-CL-ImageRefArray-L-DataTypeArray-CL-DataTypeArray-CL-DataTypeArray-CL-UnsignedArray-CL-ScanLineFilter-L-ScanOptions-" class="m-doc">Scan</a>(</span><span class="m-doc-wrap"><a href="dip-Image.html#dip-ImageConstRefArray" class="m-doc">dip::ImageConstRefArray</a> const& in,
<a href="dip-Image.html#dip-ImageRefArray" class="m-doc">dip::ImageRefArray</a>& out,
<a href="dip-DataType.html#dip-DataTypeArray" class="m-doc">dip::DataTypeArray</a> const& inBufferTypes,
<a href="dip-DataType.html#dip-DataTypeArray" class="m-doc">dip::DataTypeArray</a> const& outBufferTypes,
<a href="dip-DataType.html#dip-DataTypeArray" class="m-doc">dip::DataTypeArray</a> const& outImageTypes,
<a href="supporttypes.html#dip-UnsignedArray" class="m-doc">dip::UnsignedArray</a> const& nTensorElements,
<a href="dip-Framework-ScanLineFilter.html" class="m-doc">dip::Framework::ScanLineFilter</a>& lineFilter,
<a href="frameworks.html#dip-Framework-ScanOptions" class="m-doc">dip::Framework::ScanOptions</a> opts = {})</span>
</dt>
<dd>Framework for pixel-based processing of images.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="frameworks.html#dip-Framework-ScanSingleOutput-Image-L-DataType--ScanLineFilter-L-ScanOptions-" class="m-doc">ScanSingleOutput</a>(</span><span class="m-doc-wrap"><a href="dip-Image.html" class="m-doc">dip::Image</a>& out,
<a href="dip-DataType.html" class="m-doc">dip::DataType</a> bufferType,
<a href="dip-Framework-ScanLineFilter.html" class="m-doc">dip::Framework::ScanLineFilter</a>& lineFilter,
<a href="frameworks.html#dip-Framework-ScanOptions" class="m-doc">dip::Framework::ScanOptions</a> opts = {})</span>
</dt>
<dd>Calls <a href="frameworks.html#dip-Framework-Scan-ImageConstRefArray-CL-ImageRefArray-L-DataTypeArray-CL-DataTypeArray-CL-DataTypeArray-CL-UnsignedArray-CL-ScanLineFilter-L-ScanOptions-"><code>dip::Framework::Scan</code></a> with one output image, which is already forged.
The <code>lineFilter</code> will be called with an output buffer of type <code>bufferType</code>.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="frameworks.html#dip-Framework-ScanSingleInput-Image-CL-Image-CL-DataType--ScanLineFilter-L-ScanOptions-" class="m-doc">ScanSingleInput</a>(</span><span class="m-doc-wrap"><a href="dip-Image.html" class="m-doc">dip::Image</a> const& in,
<a href="dip-Image.html" class="m-doc">dip::Image</a> const& c_mask,
<a href="dip-DataType.html" class="m-doc">dip::DataType</a> bufferType,
<a href="dip-Framework-ScanLineFilter.html" class="m-doc">dip::Framework::ScanLineFilter</a>& lineFilter,
<a href="frameworks.html#dip-Framework-ScanOptions" class="m-doc">dip::Framework::ScanOptions</a> opts = {})</span>
</dt>
<dd>Calls <a href="frameworks.html#dip-Framework-Scan-ImageConstRefArray-CL-ImageRefArray-L-DataTypeArray-CL-DataTypeArray-CL-DataTypeArray-CL-UnsignedArray-CL-ScanLineFilter-L-ScanOptions-"><code>dip::Framework::Scan</code></a> with one input image and a mask image, and no output image.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="frameworks.html#dip-Framework-ScanMonadic-Image-CL-Image-L-DataType--DataType--dip-uint--ScanLineFilter-L-ScanOptions-" class="m-doc">ScanMonadic</a>(</span><span class="m-doc-wrap"><a href="dip-Image.html" class="m-doc">dip::Image</a> const& in,
<a href="dip-Image.html" class="m-doc">dip::Image</a>& out,
<a href="dip-DataType.html" class="m-doc">dip::DataType</a> bufferTypes,
<a href="dip-DataType.html" class="m-doc">dip::DataType</a> outImageType,
<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> nTensorElements,
<a href="dip-Framework-ScanLineFilter.html" class="m-doc">dip::Framework::ScanLineFilter</a>& lineFilter,
<a href="frameworks.html#dip-Framework-ScanOptions" class="m-doc">dip::Framework::ScanOptions</a> opts = {})</span>
</dt>
<dd>Calls <a href="frameworks.html#dip-Framework-Scan-ImageConstRefArray-CL-ImageRefArray-L-DataTypeArray-CL-DataTypeArray-CL-DataTypeArray-CL-UnsignedArray-CL-ScanLineFilter-L-ScanOptions-"><code>dip::Framework::Scan</code></a> with one input image and one output image.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="frameworks.html#dip-Framework-ScanDyadic-Image-CL-Image-CL-Image-L-DataType--DataType--DataType--ScanLineFilter-L-ScanOptions-" class="m-doc">ScanDyadic</a>(</span><span class="m-doc-wrap"><a href="dip-Image.html" class="m-doc">dip::Image</a> const& in1,
<a href="dip-Image.html" class="m-doc">dip::Image</a> const& in2,
<a href="dip-Image.html" class="m-doc">dip::Image</a>& out,
<a href="dip-DataType.html" class="m-doc">dip::DataType</a> inBufferType,
<a href="dip-DataType.html" class="m-doc">dip::DataType</a> outBufferType,
<a href="dip-DataType.html" class="m-doc">dip::DataType</a> outImageType,
<a href="dip-Framework-ScanLineFilter.html" class="m-doc">dip::Framework::ScanLineFilter</a>& lineFilter,
<a href="frameworks.html#dip-Framework-ScanOptions" class="m-doc">dip::Framework::ScanOptions</a> opts = {})</span>
</dt>
<dd>Calls <a href="frameworks.html#dip-Framework-Scan-ImageConstRefArray-CL-ImageRefArray-L-DataTypeArray-CL-DataTypeArray-CL-DataTypeArray-CL-UnsignedArray-CL-ScanLineFilter-L-ScanOptions-"><code>dip::Framework::Scan</code></a> with two input images and one output image.</dd>
<dt>
<div class="m-doc-template">template<typename TPI, typename F></div>
<span class="m-doc-wrap-bumper">auto <a href="frameworks.html#dip-Framework-NewMonadicScanLineFilter-T-F-CL-dip-uint-" class="m-doc">NewMonadicScanLineFilter</a>(</span><span class="m-doc-wrap">F const& func,
<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> cost = 1) -> std::unique_ptr<ScanLineFilter></span>
</dt>
<dd>Support for quickly defining monadic operators (1 input image, 1 output image).
See <a href="dip-Framework-VariadicScanLineFilter-T.html"><code>dip::Framework::VariadicScanLineFilter</code></a>.</dd>
<dt>
<div class="m-doc-template">template<typename TPI, typename F></div>
<span class="m-doc-wrap-bumper">auto <a href="frameworks.html#dip-Framework-NewDyadicScanLineFilter-T-F-CL-dip-uint-" class="m-doc">NewDyadicScanLineFilter</a>(</span><span class="m-doc-wrap">F const& func,
<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> cost = 1) -> std::unique_ptr<ScanLineFilter></span>
</dt>
<dd>Support for quickly defining dyadic operators (2 input images, 1 output image).
See <a href="dip-Framework-VariadicScanLineFilter-T.html"><code>dip::Framework::VariadicScanLineFilter</code></a>.</dd>
<dt>
<div class="m-doc-template">template<typename TPI, typename F></div>
<span class="m-doc-wrap-bumper">auto <a href="frameworks.html#dip-Framework-NewTriadicScanLineFilter-T-F-CL-dip-uint-" class="m-doc">NewTriadicScanLineFilter</a>(</span><span class="m-doc-wrap">F const& func,
<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> cost = 1) -> std::unique_ptr<ScanLineFilter></span>
</dt>
<dd>Support for quickly defining triadic operators (3 input images, 1 output image).
See <a href="dip-Framework-VariadicScanLineFilter-T.html"><code>dip::Framework::VariadicScanLineFilter</code></a>.</dd>
<dt>
<div class="m-doc-template">template<typename TPI, typename F></div>
<span class="m-doc-wrap-bumper">auto <a href="frameworks.html#dip-Framework-NewTetradicScanLineFilter-T-F-CL-dip-uint-" class="m-doc">NewTetradicScanLineFilter</a>(</span><span class="m-doc-wrap">F const& func,
<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> cost = 1) -> std::unique_ptr<ScanLineFilter></span>
</dt>
<dd>Support for quickly defining tetradic operators (4 input images, 1 output image).
See <a href="dip-Framework-VariadicScanLineFilter-T.html"><code>dip::Framework::VariadicScanLineFilter</code></a>.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="frameworks.html#dip-Framework-Separable-Image-CL-Image-L-DataType--DataType--BooleanArray--UnsignedArray--BoundaryConditionArray--SeparableLineFilter-L-SeparableOptions-" class="m-doc">Separable</a>(</span><span class="m-doc-wrap"><a href="dip-Image.html" class="m-doc">dip::Image</a> const& in,
<a href="dip-Image.html" class="m-doc">dip::Image</a>& out,
<a href="dip-DataType.html" class="m-doc">dip::DataType</a> bufferType,
<a href="dip-DataType.html" class="m-doc">dip::DataType</a> outImageType,
<a href="supporttypes.html#dip-BooleanArray" class="m-doc">dip::BooleanArray</a> process,
<a href="supporttypes.html#dip-UnsignedArray" class="m-doc">dip::UnsignedArray</a> border,
<a href="boundary.html#dip-BoundaryConditionArray" class="m-doc">dip::BoundaryConditionArray</a> boundaryCondition,
<a href="dip-Framework-SeparableLineFilter.html" class="m-doc">dip::Framework::SeparableLineFilter</a>& lineFilter,
<a href="frameworks.html#dip-Framework-SeparableOptions" class="m-doc">dip::Framework::SeparableOptions</a> opts = {})</span>
</dt>
<dd>Framework for separable filtering of images.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="frameworks.html#dip-Framework-OneDimensionalLineFilter-Image-CL-Image-L-DataType--DataType--DataType--dip-uint--dip-uint--BoundaryCondition--SeparableLineFilter-L-SeparableOptions-" class="m-doc">OneDimensionalLineFilter</a>(</span><span class="m-doc-wrap"><a href="dip-Image.html" class="m-doc">dip::Image</a> const& in,
<a href="dip-Image.html" class="m-doc">dip::Image</a>& out,
<a href="dip-DataType.html" class="m-doc">dip::DataType</a> inBufferType,
<a href="dip-DataType.html" class="m-doc">dip::DataType</a> outBufferType,
<a href="dip-DataType.html" class="m-doc">dip::DataType</a> outImageType,
<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> processingDimension,
<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> border,
<a href="boundary.html#dip-BoundaryCondition" class="m-doc">dip::BoundaryCondition</a> boundaryCondition,
<a href="dip-Framework-SeparableLineFilter.html" class="m-doc">dip::Framework::SeparableLineFilter</a>& lineFilter,
<a href="frameworks.html#dip-Framework-SeparableOptions" class="m-doc">dip::Framework::SeparableOptions</a> opts = {})</span>
</dt>
<dd>Framework for filtering of image lines. This is a version of <a href="frameworks.html#dip-Framework-Separable-Image-CL-Image-L-DataType--DataType--BooleanArray--UnsignedArray--BoundaryConditionArray--SeparableLineFilter-L-SeparableOptions-"><code>dip::Framework::Separable</code></a> that works along one
dimension only.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="frameworks.html#dip-Framework-Full-Image-CL-Image-L-DataType--DataType--DataType--dip-uint--BoundaryConditionArray-CL-Kernel-CL-FullLineFilter-L-FullOptions-" class="m-doc">Full</a>(</span><span class="m-doc-wrap"><a href="dip-Image.html" class="m-doc">dip::Image</a> const& in,
<a href="dip-Image.html" class="m-doc">dip::Image</a>& out,
<a href="dip-DataType.html" class="m-doc">dip::DataType</a> inBufferType,
<a href="dip-DataType.html" class="m-doc">dip::DataType</a> outBufferType,
<a href="dip-DataType.html" class="m-doc">dip::DataType</a> outImageType,
<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> nTensorElements,
<a href="boundary.html#dip-BoundaryConditionArray" class="m-doc">dip::BoundaryConditionArray</a> const& boundaryCondition,
<a href="dip-Kernel.html" class="m-doc">dip::Kernel</a> const& kernel,
<a href="dip-Framework-FullLineFilter.html" class="m-doc">dip::Framework::FullLineFilter</a>& lineFilter,
<a href="frameworks.html#dip-Framework-FullOptions" class="m-doc">dip::Framework::FullOptions</a> opts = {})</span>
</dt>
<dd>Framework for filtering of images with an arbitrary shape neighborhood.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="frameworks.html#dip-Framework-Projection-Image-CL-Image-CL-Image-L-DataType--BooleanArray--ProjectionFunction-L-ProjectionOptions-" class="m-doc">Projection</a>(</span><span class="m-doc-wrap"><a href="dip-Image.html" class="m-doc">dip::Image</a> const& in,
<a href="dip-Image.html" class="m-doc">dip::Image</a> const& mask,
<a href="dip-Image.html" class="m-doc">dip::Image</a>& out,
<a href="dip-DataType.html" class="m-doc">dip::DataType</a> outImageType,
<a href="supporttypes.html#dip-BooleanArray" class="m-doc">dip::BooleanArray</a> process,
<a href="dip-Framework-ProjectionFunction.html" class="m-doc">dip::Framework::ProjectionFunction</a>& projectionFunction,
<a href="frameworks.html#dip-Framework-ProjectionOptions" class="m-doc">dip::Framework::ProjectionOptions</a> opts = {})</span>
</dt>
<dd>Framework for projecting one or more dimensions of an image.</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>