Repository navigation
Expand file tree
/
Copy pathdip-Framework-ScanLineFilter.html
More file actions
197 lines (196 loc) · 14.4 KB
/
Copy pathdip-Framework-ScanLineFilter.html
File metadata and controls
197 lines (196 loc) · 14.4 KB
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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>dip::Framework::ScanLineFilter 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.6.1" class="m-thin">version 3.6.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-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><span class="m-breadcrumb"><a href="dip-Framework.html">Framework</a>::<wbr/></span>ScanLineFilter <span class="m-thin">class</span> </h1>
<p>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>.</p>
<div class="m-index m-block m-default">
<h3>Contents</h3>
<ul>
<li>
Reference
<ul>
<li><a href="#derived-classes">Derived classes</a></li>
<li><a href="#typeless-methods">Constructors, destructors, assignment and conversion operators</a></li>
<li><a href="#function-members">Functions</a></li>
</ul>
</li>
</ul>
</div>
<p>An object of a class derived from <code>ScanLineFilter</code> must be passed to the scan framework. The derived
class can be a template class, such that the line filter is overloaded for each possible pixel data type.</p>
<p>A derived class can have data members that hold parameters to the line filter, that hold output values,
or that hold intermediate buffers. The <code>SetNumberOfThreads</code> method is
called once before any processing starts. This is a good place to allocate space for output values, such
that each threads has its own output variables that the calling function can later combine (reduce). Note
that this function is called even if <a href="frameworks.html#dip-Framework-ScanOption-NoMultiThreading"><code>dip::Framework::ScanOption::NoMultiThreading</code></a> is given, or if the library
is compiled without multi-threading.</p>
<p>The <code>GetNumberOfOperations</code> method is called to determine if it is worthwhile to start worker threads and
perform the computation in parallel. This function should not perform any other tasks, as it is not
guaranteed to be called. It is not important that the function be very precise, see <a href="design.html#design_multithreading">Multithreading</a>.</p>
<section id="derived-classes">
<h2>Derived classes</h2>
<dl class="m-doc">
<dt>
<div class="m-doc-template">template<<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> N, typename TPI, typename F, bool Scalar = false></div>
class <a href="dip-Framework-VariadicScanLineFilter-T.html" class="m-doc">dip::<wbr />Framework::<wbr />VariadicScanLineFilter</a>
</dt>
<dd>An implementation of the <a href="dip-Framework-ScanLineFilter.html"><code>dip::Framework::ScanLineFilter</code></a> for N input images and 1 output image. <a href="dip-Framework-VariadicScanLineFilter-T.html#dip-Framework-VariadicScanLineFilter-T">more...</a></dd>
</dl>
</section>
<section id="typeless-methods">
<h2>Constructors, destructors, assignment and conversion operators</h2>
<dl class="m-doc">
<dt>
<span class="m-doc-wrap-bumper"><a href="#dip-Framework-ScanLineFilter-~ScanLineFilter" class="m-doc">~ScanLineFilter</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-info">defaulted</span> <span class="m-label m-flat m-warning">virtual</span></span>
</dt>
<dd>A virtual destructor guarantees that we can destroy a derived class by a pointer to base</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-Framework-ScanLineFilter-Filter-ScanLineFilterParameters-CL" class="m-doc">Filter</a>(</span><span class="m-doc-wrap"><a href="frameworks.html#dip-Framework-ScanLineFilterParameters" class="m-doc">dip::Framework::ScanLineFilterParameters</a> const& params) <span class="m-label m-flat m-warning">pure virtual</span></span>
</dt>
<dd>The derived class must must define this method, this is the actual line filter.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-Framework-ScanLineFilter-GetNumberOfOperations-dip-uint--dip-uint--dip-uint-" class="m-doc">GetNumberOfOperations</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> nInput,
<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> nOutput,
<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> nTensorElements) -> <a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> <span class="m-label m-flat m-warning">virtual</span></span>
</dt>
<dd>The derived class can define this function for helping to determine whether to compute
in parallel or not. It must return the number of clock cycles per input pixel. The default is valid for
an arithmetic-like operation.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#dip-Framework-ScanLineFilter-SetNumberOfThreads-dip-uint-" class="m-doc">SetNumberOfThreads</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> threads) <span class="m-label m-flat m-warning">virtual</span></span>
</dt>
<dd>The derived class can define this function for setting up the processing.</dd>
</dl>
</section>
<section>
<h2>Function documentation</h2>
<section class="m-doc-details" id="dip-Framework-ScanLineFilter-~ScanLineFilter"><div>
<h3>
<span class="m-doc-return"> </span>
<span class="m-doc-name"><a href="#dip-Framework-ScanLineFilter-~ScanLineFilter" class="m-doc-self">~ScanLineFilter</a></span>(
) <span class="m-label m-info">defaulted</span> <span class="m-label m-warning">virtual</span> </h3>
<p>A virtual destructor guarantees that we can destroy a derived class by a pointer to base</p>
</div></section>
<section class="m-doc-details" id="dip-Framework-ScanLineFilter-Filter-ScanLineFilterParameters-CL"><div>
<h3>
<span class="m-doc-return">void </span>
<span class="m-doc-name"><a href="#dip-Framework-ScanLineFilter-Filter-ScanLineFilterParameters-CL" class="m-doc-self">Filter</a></span>(
<span class="m-doc-arg"><a href="frameworks.html#dip-Framework-ScanLineFilterParameters" class="m-doc">dip::Framework::ScanLineFilterParameters</a> const& params</span>) <span class="m-label m-warning">pure virtual</span> </h3>
<p>The derived class must must define this method, this is the actual line filter.</p>
</div></section>
<section class="m-doc-details" id="dip-Framework-ScanLineFilter-SetNumberOfThreads-dip-uint-"><div>
<h3>
<span class="m-doc-return">void </span>
<span class="m-doc-name"><a href="#dip-Framework-ScanLineFilter-SetNumberOfThreads-dip-uint-" class="m-doc-self">SetNumberOfThreads</a></span>(
<span class="m-doc-arg"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> threads</span>) <span class="m-label m-warning">virtual</span> </h3>
<p>The derived class can define this function for setting up the processing.</p>
</div></section>
<section class="m-doc-details" id="dip-Framework-ScanLineFilter-GetNumberOfOperations-dip-uint--dip-uint--dip-uint-"><div>
<h3>
<span class="m-doc-return"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> </span>
<span class="m-doc-name"><a href="#dip-Framework-ScanLineFilter-GetNumberOfOperations-dip-uint--dip-uint--dip-uint-" class="m-doc-self">GetNumberOfOperations</a></span>(
<span class="m-doc-arg"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> nInput, </span><span class="m-doc-arg"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> nOutput, </span><span class="m-doc-arg"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> nTensorElements</span>) <span class="m-label m-warning">virtual</span> </h3>
<p>The derived class can define this function for helping to determine whether to compute
in parallel or not. It must return the number of clock cycles per input pixel. The default is valid for
an arithmetic-like operation.</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>