-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclassrr_1_1_i_s_p.html
341 lines (319 loc) · 17.9 KB
/
classrr_1_1_i_s_p.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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libcudaisp: rr::ISP Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libcudaisp
 <span id="projectnumber">0.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacerr.html">rr</a></li><li class="navelem"><a class="el" href="classrr_1_1_i_s_p.html">ISP</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classrr_1_1_i_s_p-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">rr::ISP Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class provides an engine to execute the algorithms by chaining them in a serial or pipeline execution mode.
<a href="classrr_1_1_i_s_p.html#details">More...</a></p>
<p><code>#include <<a class="el" href="isp_8hpp_source.html">isp.hpp</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a132d8342fdbd39a8dff62c8548f2ed89"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrr_1_1_i_s_p.html#a132d8342fdbd39a8dff62c8548f2ed89">ISP</a> (std::shared_ptr< <a class="el" href="classrr_1_1_i_settings.html">ISettings</a> > settings)</td></tr>
<tr class="memdesc:a132d8342fdbd39a8dff62c8548f2ed89"><td class="mdescLeft"> </td><td class="mdescRight">Constructs an <a class="el" href="classrr_1_1_i_s_p.html" title="This class provides an engine to execute the algorithms by chaining them in a serial or pipeline exec...">ISP</a> instance. <a href="classrr_1_1_i_s_p.html#a132d8342fdbd39a8dff62c8548f2ed89">More...</a><br /></td></tr>
<tr class="separator:a132d8342fdbd39a8dff62c8548f2ed89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2049993a85edb28a9f02814d906d5869"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classrr_1_1_runtime_error.html">RuntimeError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrr_1_1_i_s_p.html#a2049993a85edb28a9f02814d906d5869">AddAlgorithm</a> (std::shared_ptr< <a class="el" href="classrr_1_1_i_algorithm.html">IAlgorithm</a> > algorithm, std::shared_ptr< <a class="el" href="classrr_1_1_i_params.html">IParams</a> > params)</td></tr>
<tr class="memdesc:a2049993a85edb28a9f02814d906d5869"><td class="mdescLeft"> </td><td class="mdescRight">This method adds a new algorithm to the <a class="el" href="classrr_1_1_i_s_p.html" title="This class provides an engine to execute the algorithms by chaining them in a serial or pipeline exec...">ISP</a>. <a href="classrr_1_1_i_s_p.html#a2049993a85edb28a9f02814d906d5869">More...</a><br /></td></tr>
<tr class="separator:a2049993a85edb28a9f02814d906d5869"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3aa655ba663dbd88cbaeaaa3534c9296"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classrr_1_1_runtime_error.html">RuntimeError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrr_1_1_i_s_p.html#a3aa655ba663dbd88cbaeaaa3534c9296">SetMode</a> (const <a class="el" href="namespacerr.html#aa2019614bf55710358c6e775dc9880e8">Mode</a> mode)</td></tr>
<tr class="memdesc:a3aa655ba663dbd88cbaeaaa3534c9296"><td class="mdescLeft"> </td><td class="mdescRight">This method sets the mode in which the algorithms will be executed. <a href="classrr_1_1_i_s_p.html#a3aa655ba663dbd88cbaeaaa3534c9296">More...</a><br /></td></tr>
<tr class="separator:a3aa655ba663dbd88cbaeaaa3534c9296"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a20c8613c27cd83f26c78bc03221c00d7"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classrr_1_1_runtime_error.html">RuntimeError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrr_1_1_i_s_p.html#a20c8613c27cd83f26c78bc03221c00d7">Apply</a> (const <a class="el" href="classrr_1_1_buffer.html">Buffer</a> *input_buffer, <a class="el" href="classrr_1_1_buffer.html">Buffer</a> *output_buffer, const bool async=false)</td></tr>
<tr class="memdesc:a20c8613c27cd83f26c78bc03221c00d7"><td class="mdescLeft"> </td><td class="mdescRight">This method applies the algorithm to the input buffer and modifies the output buffer. <a href="classrr_1_1_i_s_p.html#a20c8613c27cd83f26c78bc03221c00d7">More...</a><br /></td></tr>
<tr class="separator:a20c8613c27cd83f26c78bc03221c00d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a07202020236fc9217ee1ba4d4a0ea28e"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classrr_1_1_runtime_error.html">RuntimeError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrr_1_1_i_s_p.html#a07202020236fc9217ee1ba4d4a0ea28e">Synchronize</a> ()</td></tr>
<tr class="memdesc:a07202020236fc9217ee1ba4d4a0ea28e"><td class="mdescLeft"> </td><td class="mdescRight">This method synchronizes the execution of the algorithms. <a href="classrr_1_1_i_s_p.html#a07202020236fc9217ee1ba4d4a0ea28e">More...</a><br /></td></tr>
<tr class="separator:a07202020236fc9217ee1ba4d4a0ea28e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a21e73d40ec046ccf13b97f1e5109f122"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classrr_1_1_i_s_p.html#a21e73d40ec046ccf13b97f1e5109f122">~ISP</a> ()</td></tr>
<tr class="memdesc:a21e73d40ec046ccf13b97f1e5109f122"><td class="mdescLeft"> </td><td class="mdescRight">Destroy the <a class="el" href="classrr_1_1_i_s_p.html" title="This class provides an engine to execute the algorithms by chaining them in a serial or pipeline exec...">ISP</a> object. <a href="classrr_1_1_i_s_p.html#a21e73d40ec046ccf13b97f1e5109f122">More...</a><br /></td></tr>
<tr class="separator:a21e73d40ec046ccf13b97f1e5109f122"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class provides an engine to execute the algorithms by chaining them in a serial or pipeline execution mode. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a132d8342fdbd39a8dff62c8548f2ed89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a132d8342fdbd39a8dff62c8548f2ed89">◆ </a></span>ISP()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">rr::ISP::ISP </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classrr_1_1_i_settings.html">ISettings</a> > </td>
<td class="paramname"><em>settings</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an <a class="el" href="classrr_1_1_i_s_p.html" title="This class provides an engine to execute the algorithms by chaining them in a serial or pipeline exec...">ISP</a> instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settings</td><td>: Settings for the algorithm that will be executed in the <a class="el" href="classrr_1_1_i_s_p.html" title="This class provides an engine to execute the algorithms by chaining them in a serial or pipeline exec...">ISP</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a21e73d40ec046ccf13b97f1e5109f122"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21e73d40ec046ccf13b97f1e5109f122">◆ </a></span>~ISP()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual rr::ISP::~ISP </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy the <a class="el" href="classrr_1_1_i_s_p.html" title="This class provides an engine to execute the algorithms by chaining them in a serial or pipeline exec...">ISP</a> object. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2049993a85edb28a9f02814d906d5869"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2049993a85edb28a9f02814d906d5869">◆ </a></span>AddAlgorithm()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classrr_1_1_runtime_error.html">RuntimeError</a> rr::ISP::AddAlgorithm </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classrr_1_1_i_algorithm.html">IAlgorithm</a> > </td>
<td class="paramname"><em>algorithm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classrr_1_1_i_params.html">IParams</a> > </td>
<td class="paramname"><em>params</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method adds a new algorithm to the <a class="el" href="classrr_1_1_i_s_p.html" title="This class provides an engine to execute the algorithms by chaining them in a serial or pipeline exec...">ISP</a>. </p>
<p>The algorithm would be append to the array algorithms_ and its parameters to the array params_. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">algorithm</td><td>: Algorithm to be added and appended. </td></tr>
<tr><td class="paramname">params</td><td>: Parameters to be added and appended. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classrr_1_1_runtime_error.html" title="Implements the error handling class.">RuntimeError</a> : Operation status. </dd></dl>
</div>
</div>
<a id="a20c8613c27cd83f26c78bc03221c00d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20c8613c27cd83f26c78bc03221c00d7">◆ </a></span>Apply()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classrr_1_1_runtime_error.html">RuntimeError</a> rr::ISP::Apply </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classrr_1_1_buffer.html">Buffer</a> * </td>
<td class="paramname"><em>input_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classrr_1_1_buffer.html">Buffer</a> * </td>
<td class="paramname"><em>output_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const bool </td>
<td class="paramname"><em>async</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method applies the algorithm to the input buffer and modifies the output buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">input_buffer</td><td>: Input buffer for which the algorithms will be applied. </td></tr>
<tr><td class="paramname">output_buffer</td><td>: Output buffer for which the algorithms has already been applied. </td></tr>
<tr><td class="paramname">async</td><td>: Indicates if the execution of the algorithms will be asynchronus or synchronus. If false, blocks the execution until the algorithm finishes its execution. Default value: false. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classrr_1_1_runtime_error.html" title="Implements the error handling class.">RuntimeError</a> : Operation status. </dd></dl>
</div>
</div>
<a id="a3aa655ba663dbd88cbaeaaa3534c9296"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3aa655ba663dbd88cbaeaaa3534c9296">◆ </a></span>SetMode()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classrr_1_1_runtime_error.html">RuntimeError</a> rr::ISP::SetMode </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacerr.html#aa2019614bf55710358c6e775dc9880e8">Mode</a> </td>
<td class="paramname"><em>mode</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method sets the mode in which the algorithms will be executed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mode</td><td>: Contains the mode with which the algorithm will be executed. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classrr_1_1_runtime_error.html" title="Implements the error handling class.">RuntimeError</a> : Operation status. </dd></dl>
</div>
</div>
<a id="a07202020236fc9217ee1ba4d4a0ea28e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07202020236fc9217ee1ba4d4a0ea28e">◆ </a></span>Synchronize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classrr_1_1_runtime_error.html">RuntimeError</a> rr::ISP::Synchronize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method synchronizes the execution of the algorithms. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classrr_1_1_runtime_error.html" title="Implements the error handling class.">RuntimeError</a> : Operation status. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/builds/ridgerun/rnd/libcudaisp/rr/include/libcudaisp/<a class="el" href="isp_8hpp_source.html">isp.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Mar 14 2023 20:22:00 for libcudaisp by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>