-
Notifications
You must be signed in to change notification settings - Fork 0
/
classrr_1_1_cuda_white_balancer.html
273 lines (256 loc) · 15.9 KB
/
classrr_1_1_cuda_white_balancer.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
<!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::CudaWhiteBalancer 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_cuda_white_balancer.html">CudaWhiteBalancer</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_cuda_white_balancer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">rr::CudaWhiteBalancer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class is in charge of the White Balancer algorithm using CUDA.
<a href="classrr_1_1_cuda_white_balancer.html#details">More...</a></p>
<p><code>#include <<a class="el" href="cudawhitebalancer_8hpp_source.html">cudawhitebalancer.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:a8e4f68dca09d4c98aae9f1686f6716eb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrr_1_1_cuda_white_balancer.html#a8e4f68dca09d4c98aae9f1686f6716eb">CudaWhiteBalancer</a> (const std::shared_ptr< <a class="el" href="classrr_1_1_i_settings.html">ISettings</a> > settings)</td></tr>
<tr class="memdesc:a8e4f68dca09d4c98aae9f1686f6716eb"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new <a class="el" href="classrr_1_1_cuda_white_balancer.html" title="This class is in charge of the White Balancer algorithm using CUDA.">CudaWhiteBalancer</a> instance. <a href="classrr_1_1_cuda_white_balancer.html#a8e4f68dca09d4c98aae9f1686f6716eb">More...</a><br /></td></tr>
<tr class="separator:a8e4f68dca09d4c98aae9f1686f6716eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2fa0cee29229a6a9935488534819fa0b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classrr_1_1_runtime_error.html">rr::RuntimeError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrr_1_1_cuda_white_balancer.html#a2fa0cee29229a6a9935488534819fa0b">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 std::shared_ptr< <a class="el" href="classrr_1_1_i_params.html">IParams</a> > params, bool async=false) override</td></tr>
<tr class="memdesc:a2fa0cee29229a6a9935488534819fa0b"><td class="mdescLeft"> </td><td class="mdescRight">This method applies the automatic white balancing algorithm to the input buffer. <a href="classrr_1_1_cuda_white_balancer.html#a2fa0cee29229a6a9935488534819fa0b">More...</a><br /></td></tr>
<tr class="separator:a2fa0cee29229a6a9935488534819fa0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a24751f6093374611b04aa44efed7f6ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classrr_1_1_runtime_error.html">rr::RuntimeError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrr_1_1_cuda_white_balancer.html#a24751f6093374611b04aa44efed7f6ac">Synchronize</a> () override</td></tr>
<tr class="memdesc:a24751f6093374611b04aa44efed7f6ac"><td class="mdescLeft"> </td><td class="mdescRight">This method syncrhonizes the execution of the white balancing algorithm. <a href="classrr_1_1_cuda_white_balancer.html#a24751f6093374611b04aa44efed7f6ac">More...</a><br /></td></tr>
<tr class="separator:a24751f6093374611b04aa44efed7f6ac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a540d0a5d351a5c7cd376844f75c859bb"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classrr_1_1_cuda_white_balancer.html#a540d0a5d351a5c7cd376844f75c859bb">~CudaWhiteBalancer</a> ()</td></tr>
<tr class="separator:a540d0a5d351a5c7cd376844f75c859bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classrr_1_1_i_algorithm"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classrr_1_1_i_algorithm')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classrr_1_1_i_algorithm.html">rr::IAlgorithm</a></td></tr>
<tr class="memitem:ad15a4bc31f01d2de3de9ab60b42392d4 inherit pub_methods_classrr_1_1_i_algorithm"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrr_1_1_i_algorithm.html#ad15a4bc31f01d2de3de9ab60b42392d4">IAlgorithm</a> (std::shared_ptr< <a class="el" href="classrr_1_1_i_settings.html">ISettings</a> > settings)</td></tr>
<tr class="memdesc:ad15a4bc31f01d2de3de9ab60b42392d4 inherit pub_methods_classrr_1_1_i_algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new <a class="el" href="classrr_1_1_i_algorithm.html" title="This interface provides a way to apply algorithms to an image.">IAlgorithm</a> instance. <a href="classrr_1_1_i_algorithm.html#ad15a4bc31f01d2de3de9ab60b42392d4">More...</a><br /></td></tr>
<tr class="separator:ad15a4bc31f01d2de3de9ab60b42392d4 inherit pub_methods_classrr_1_1_i_algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b09fe844d3eb5aff637a3051f3e2a59 inherit pub_methods_classrr_1_1_i_algorithm"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classrr_1_1_i_algorithm.html#a3b09fe844d3eb5aff637a3051f3e2a59">~IAlgorithm</a> ()=default</td></tr>
<tr class="memdesc:a3b09fe844d3eb5aff637a3051f3e2a59 inherit pub_methods_classrr_1_1_i_algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Destroy the <a class="el" href="classrr_1_1_i_algorithm.html" title="This interface provides a way to apply algorithms to an image.">IAlgorithm</a> object. <a href="classrr_1_1_i_algorithm.html#a3b09fe844d3eb5aff637a3051f3e2a59">More...</a><br /></td></tr>
<tr class="separator:a3b09fe844d3eb5aff637a3051f3e2a59 inherit pub_methods_classrr_1_1_i_algorithm"><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 is in charge of the White Balancer algorithm using CUDA. </p>
<p>It performs White Balancing and it is constructed when passing kWhiteBalancer to the <a class="el" href="classrr_1_1_cuda_backend.html" title="This interface class manages the creation of CUDA Algorithms and CUDA Buffers.">CudaBackend</a></p>
<p>Inherits from <a class="el" href="classrr_1_1_i_algorithm.html" title="This interface provides a way to apply algorithms to an image.">IAlgorithm</a>. This class can recieve an input RGB image, it then applies automatic white balancing to the image, and then produces an RGB output. It uses the NPP library from NVIDIA to provide CUDA acceleration to the algorithm. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a8e4f68dca09d4c98aae9f1686f6716eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e4f68dca09d4c98aae9f1686f6716eb">◆ </a></span>CudaWhiteBalancer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">rr::CudaWhiteBalancer::CudaWhiteBalancer </td>
<td>(</td>
<td class="paramtype">const 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>Construct a new <a class="el" href="classrr_1_1_cuda_white_balancer.html" title="This class is in charge of the White Balancer algorithm using CUDA.">CudaWhiteBalancer</a> instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settings</td><td>: Settings required for the algorithm. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a540d0a5d351a5c7cd376844f75c859bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a540d0a5d351a5c7cd376844f75c859bb">◆ </a></span>~CudaWhiteBalancer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">rr::CudaWhiteBalancer::~CudaWhiteBalancer </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">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2fa0cee29229a6a9935488534819fa0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2fa0cee29229a6a9935488534819fa0b">◆ </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"><a class="el" href="classrr_1_1_runtime_error.html">rr::RuntimeError</a> rr::CudaWhiteBalancer::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 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 class="paramkey"></td>
<td></td>
<td class="paramtype">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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method applies the automatic white balancing algorithm to the input buffer. </p>
<p>The result is stored in the output buffer.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">input_buffer</td><td>: Input buffer on which to apply white balancing </td></tr>
<tr><td class="paramname">output_buffer</td><td>: Output buffer where white balancing result is stored </td></tr>
<tr><td class="paramname">params</td><td>: Parameters necessary for applying the algorithm. </td></tr>
<tr><td class="paramname">async</td><td>: Indicates if the execution of the algorithm will be asynchronus o synchronus. If false, blocks the execution until 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>
<p>Implements <a class="el" href="classrr_1_1_i_algorithm.html#a7804fc713f4b8d93040fa7628c79d6c3">rr::IAlgorithm</a>.</p>
</div>
</div>
<a id="a24751f6093374611b04aa44efed7f6ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24751f6093374611b04aa44efed7f6ac">◆ </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"><a class="el" href="classrr_1_1_runtime_error.html">rr::RuntimeError</a> rr::CudaWhiteBalancer::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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method syncrhonizes the execution of the white balancing algorithm. </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>
<p>Implements <a class="el" href="classrr_1_1_i_algorithm.html#ad7fe9a7ab61e2cb6e40fea8497b2ed65">rr::IAlgorithm</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/builds/ridgerun/rnd/libcudaisp/rr/include/libcudaisp/<a class="el" href="cudawhitebalancer_8hpp_source.html">cudawhitebalancer.hpp</a></li>
<li>/builds/ridgerun/rnd/libcudaisp/rr/lib/<a class="el" href="cudawhitebalancer_8cpp.html">cudawhitebalancer.cpp</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>