Repository navigation
Expand file tree
/
Copy pathdip-Feature-LineBased.html
More file actions
172 lines (171 loc) · 12.4 KB
/
Copy pathdip-Feature-LineBased.html
File metadata and controls
172 lines (171 loc) · 12.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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>dip::Feature::LineBased 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="measurement.html" class="m-doc">Measurement</a> module<br/><span class="m-code m-thin">#include <a href="file--diplib--measurement-h.html">"diplib/measurement.h"</a></span> </div>
<span class="m-breadcrumb"><a href="dip.html">dip</a>::<wbr/></span><span class="m-breadcrumb"><a href="dip-Feature.html">Feature</a>::<wbr/></span>LineBased <span class="m-thin">class</span> </h1>
<p>The abstract base class for all line-based measurement features.</p>
<div class="m-index m-block m-default">
<h3>Contents</h3>
<ul>
<li>
Reference
<ul>
<li><a href="#base-classes">Base classes</a></li>
<li><a href="#function-members">Functions</a></li>
</ul>
</li>
</ul>
</div>
<p>To define a line-based measurement feature, derive from this class and override all the pure vitrual functions,
including the ones from <a href="dip-Feature-Base.html"><code>dip::Feature::Base</code></a>. See the existing line-based features in <code>/src/measurement/</code> for examples.</p>
<section id="base-classes">
<h2>Base classes</h2>
<dl class="m-doc">
<dt>
class <a href="dip-Feature-Base.html" class="m-doc">dip::<wbr />Feature::<wbr />Base</a> <span class="m-label m-flat m-warning">abstract</span>
</dt>
<dd>The abstract base class for all measurement features. <a href="dip-Feature-Base.html#dip-Feature-Base">more...</a></dd>
</dl>
</section>
<section id="function-members">
<h2>Functions</h2>
<dl class="m-doc">
<dt>
<span class="m-doc-wrap-bumper">void <a href="#dip-Feature-LineBased-Finish-dip-uint--Measurement-ValueIterator-" class="m-doc">Finish</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> objectIndex,
<a href="dip-Measurement.html#dip-Measurement-ValueIterator" class="m-doc">dip::Measurement::ValueIterator</a> output) <span class="m-label m-flat m-warning">pure virtual</span></span>
</dt>
<dd>Called once for each object, to finalize the measurement.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#dip-Feature-LineBased-ScanLine-LineIterator%3CLabelType%3E--LineIterator%3Cdfloat%3E--UnsignedArray--dip-uint--ObjectIdToIndexMap-CL" class="m-doc">ScanLine</a>(</span><span class="m-doc-wrap"><a href="dip-LineIterator-T.html" class="m-doc">dip::LineIterator</a> label,
<a href="dip-LineIterator-T.html" class="m-doc">dip::LineIterator</a> grey,
<a href="supporttypes.html#dip-UnsignedArray" class="m-doc">dip::UnsignedArray</a> coordinates,
<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> dimension,
<a href="measurement.html#dip-ObjectIdToIndexMap" class="m-doc">dip::ObjectIdToIndexMap</a> const& objectIndices) <span class="m-label m-flat m-warning">pure virtual</span></span>
</dt>
<dd>Called once for each image line, to accumulate information about each object.
This function is not called in parallel, and hence does not need to be thread-safe. <a href="#dip-Feature-LineBased-ScanLine-LineIterator%3CLabelType%3E--LineIterator%3Cdfloat%3E--UnsignedArray--dip-uint--ObjectIdToIndexMap-CL">more...</a></dd>
</dl>
</section>
<section>
<h2>Function documentation</h2>
<section class="m-doc-details" id="dip-Feature-LineBased-ScanLine-LineIterator%3CLabelType%3E--LineIterator%3Cdfloat%3E--UnsignedArray--dip-uint--ObjectIdToIndexMap-CL"><div>
<h3>
<span class="m-doc-return">void </span>
<span class="m-doc-name"><a href="#dip-Feature-LineBased-ScanLine-LineIterator%3CLabelType%3E--LineIterator%3Cdfloat%3E--UnsignedArray--dip-uint--ObjectIdToIndexMap-CL" class="m-doc-self">ScanLine</a></span>(
<span class="m-doc-arg"><a href="dip-LineIterator-T.html" class="m-doc">dip::LineIterator</a> label, </span><span class="m-doc-arg"><a href="dip-LineIterator-T.html" class="m-doc">dip::LineIterator</a> grey, </span><span class="m-doc-arg"><a href="supporttypes.html#dip-UnsignedArray" class="m-doc">dip::UnsignedArray</a> coordinates, </span><span class="m-doc-arg"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> dimension, </span><span class="m-doc-arg"><a href="measurement.html#dip-ObjectIdToIndexMap" class="m-doc">dip::ObjectIdToIndexMap</a> const& objectIndices</span>) <span class="m-label m-warning">pure virtual</span> </h3>
<p>Called once for each image line, to accumulate information about each object.
This function is not called in parallel, and hence does not need to be thread-safe.</p>
<p>The two line iterators can always be incremented exactly the same number of times.
<code>label</code> is non-zero where there is an object pixel.
Look up the <code>label</code> value in <code>objectIndices</code> to obtain the index for
the object. Object indices are always between 0 and number of objects - 1. The
<a href="dip-Feature-Base.html#dip-Feature-Base-Initialize-Image-CL-Image-CL-dip-uint-"><code>dip::Feature::Base::Initialize</code></a> function should allocate an array with <code>nObjects</code>
elements, where measurements are accumulated. The <a href="dip-Feature-LineBased.html#dip-Feature-LineBased-Finish-dip-uint--Measurement-ValueIterator-"><code>dip::Feature::LineBased::Finish</code></a>
function is called after the whole image has been scanned, and should provide the
final measurement result for one object given its index (not object ID).</p>
<p><code>coordinates</code> contains the coordinates of the first pixel on the line, and is passed by copy,
so it can be modified. <code>dimension</code> indicates along which dimension to run. Increment
<code>coordinates[ dimension ]</code> at the same time as the line iterators if coordinate information
is required by the algorithm.</p>
</div></section>
<section class="m-doc-details" id="dip-Feature-LineBased-Finish-dip-uint--Measurement-ValueIterator-"><div>
<h3>
<span class="m-doc-return">void </span>
<span class="m-doc-name"><a href="#dip-Feature-LineBased-Finish-dip-uint--Measurement-ValueIterator-" class="m-doc-self">Finish</a></span>(
<span class="m-doc-arg"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> objectIndex, </span><span class="m-doc-arg"><a href="dip-Measurement.html#dip-Measurement-ValueIterator" class="m-doc">dip::Measurement::ValueIterator</a> output</span>) <span class="m-label m-warning">pure virtual</span> </h3>
<p>Called once for each object, to finalize the measurement.</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>