/usr/share/doc/libjuce/apiref/classImageConvolutionKernel.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 388 389 390 391 392 393 394 395 396 397 398 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: ImageConvolutionKernel 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">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classImageConvolutionKernel-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ImageConvolutionKernel Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Represents a filter kernel to use in convoluting an image.
<a href="classImageConvolutionKernel.html#details">More...</a></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:a291ce213057a0e0cad9559b349426b44"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImageConvolutionKernel.html#a291ce213057a0e0cad9559b349426b44">ImageConvolutionKernel</a> (int size)</td></tr>
<tr class="memdesc:a291ce213057a0e0cad9559b349426b44"><td class="mdescLeft"> </td><td class="mdescRight">Creates an empty convulution kernel. <a href="#a291ce213057a0e0cad9559b349426b44">More...</a><br /></td></tr>
<tr class="separator:a291ce213057a0e0cad9559b349426b44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae80e9785cc4cfa1458d6c4da4b40af58"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImageConvolutionKernel.html#ae80e9785cc4cfa1458d6c4da4b40af58">~ImageConvolutionKernel</a> ()</td></tr>
<tr class="memdesc:ae80e9785cc4cfa1458d6c4da4b40af58"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ae80e9785cc4cfa1458d6c4da4b40af58">More...</a><br /></td></tr>
<tr class="separator:ae80e9785cc4cfa1458d6c4da4b40af58"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9a4fd22ec090082e020872213193253"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classImageConvolutionKernel.html#ad9a4fd22ec090082e020872213193253">clear</a> ()</td></tr>
<tr class="memdesc:ad9a4fd22ec090082e020872213193253"><td class="mdescLeft"> </td><td class="mdescRight">Resets all values in the kernel to zero. <a href="#ad9a4fd22ec090082e020872213193253">More...</a><br /></td></tr>
<tr class="separator:ad9a4fd22ec090082e020872213193253"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a98bbf0e40749584bc07038d17e9ee031"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classImageConvolutionKernel.html#a98bbf0e40749584bc07038d17e9ee031">getKernelValue</a> (int x, int y) const noexcept</td></tr>
<tr class="memdesc:a98bbf0e40749584bc07038d17e9ee031"><td class="mdescLeft"> </td><td class="mdescRight">Returns one of the kernel values. <a href="#a98bbf0e40749584bc07038d17e9ee031">More...</a><br /></td></tr>
<tr class="separator:a98bbf0e40749584bc07038d17e9ee031"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad615fc9a3faa8f6d0bc8f83b20288711"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classImageConvolutionKernel.html#ad615fc9a3faa8f6d0bc8f83b20288711">setKernelValue</a> (int x, int y, float value) noexcept</td></tr>
<tr class="memdesc:ad615fc9a3faa8f6d0bc8f83b20288711"><td class="mdescLeft"> </td><td class="mdescRight">Sets the value of a specific cell in the kernel. <a href="#ad615fc9a3faa8f6d0bc8f83b20288711">More...</a><br /></td></tr>
<tr class="separator:ad615fc9a3faa8f6d0bc8f83b20288711"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac71dbeddeb4565e410f5fed1a8216902"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classImageConvolutionKernel.html#ac71dbeddeb4565e410f5fed1a8216902">setOverallSum</a> (float desiredTotalSum)</td></tr>
<tr class="memdesc:ac71dbeddeb4565e410f5fed1a8216902"><td class="mdescLeft"> </td><td class="mdescRight">Rescales all values in the kernel to make the total add up to a fixed value. <a href="#ac71dbeddeb4565e410f5fed1a8216902">More...</a><br /></td></tr>
<tr class="separator:ac71dbeddeb4565e410f5fed1a8216902"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adff3c9b24817bd16ffa56df9af129641"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classImageConvolutionKernel.html#adff3c9b24817bd16ffa56df9af129641">rescaleAllValues</a> (float multiplier)</td></tr>
<tr class="memdesc:adff3c9b24817bd16ffa56df9af129641"><td class="mdescLeft"> </td><td class="mdescRight">Multiplies all values in the kernel by a value. <a href="#adff3c9b24817bd16ffa56df9af129641">More...</a><br /></td></tr>
<tr class="separator:adff3c9b24817bd16ffa56df9af129641"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a622a69a6e139de9ccc3bf8f15b841dfe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classImageConvolutionKernel.html#a622a69a6e139de9ccc3bf8f15b841dfe">createGaussianBlur</a> (float blurRadius)</td></tr>
<tr class="memdesc:a622a69a6e139de9ccc3bf8f15b841dfe"><td class="mdescLeft"> </td><td class="mdescRight">Intialises the kernel for a gaussian blur. <a href="#a622a69a6e139de9ccc3bf8f15b841dfe">More...</a><br /></td></tr>
<tr class="separator:a622a69a6e139de9ccc3bf8f15b841dfe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa5afbee67f38185d60cb45cd4446f1fd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classImageConvolutionKernel.html#aa5afbee67f38185d60cb45cd4446f1fd">getKernelSize</a> () const</td></tr>
<tr class="memdesc:aa5afbee67f38185d60cb45cd4446f1fd"><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of the kernel. <a href="#aa5afbee67f38185d60cb45cd4446f1fd">More...</a><br /></td></tr>
<tr class="separator:aa5afbee67f38185d60cb45cd4446f1fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a348777a7f6de064662e4a380c5e98236"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classImageConvolutionKernel.html#a348777a7f6de064662e4a380c5e98236">applyToImage</a> (<a class="el" href="classImage.html">Image</a> &destImage, const <a class="el" href="classImage.html">Image</a> &sourceImage, const <a class="el" href="classRectangle.html">Rectangle</a>< int > &destinationArea) const</td></tr>
<tr class="memdesc:a348777a7f6de064662e4a380c5e98236"><td class="mdescLeft"> </td><td class="mdescRight">Applies the kernel to an image. <a href="#a348777a7f6de064662e4a380c5e98236">More...</a><br /></td></tr>
<tr class="separator:a348777a7f6de064662e4a380c5e98236"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents a filter kernel to use in convoluting an image. </p>
<dl class="section see"><dt>See also</dt><dd>Image::applyConvolution </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a291ce213057a0e0cad9559b349426b44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a291ce213057a0e0cad9559b349426b44">§ </a></span>ImageConvolutionKernel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ImageConvolutionKernel::ImageConvolutionKernel </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an empty convulution kernel. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>the length of each dimension of the kernel, so e.g. if the size is 5, it will create a 5x5 kernel </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae80e9785cc4cfa1458d6c4da4b40af58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae80e9785cc4cfa1458d6c4da4b40af58">§ </a></span>~ImageConvolutionKernel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ImageConvolutionKernel::~ImageConvolutionKernel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad9a4fd22ec090082e020872213193253"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9a4fd22ec090082e020872213193253">§ </a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ImageConvolutionKernel::clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets all values in the kernel to zero. </p>
</div>
</div>
<a id="a98bbf0e40749584bc07038d17e9ee031"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98bbf0e40749584bc07038d17e9ee031">§ </a></span>getKernelValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float ImageConvolutionKernel::getKernelValue </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>y</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns one of the kernel values. </p>
</div>
</div>
<a id="ad615fc9a3faa8f6d0bc8f83b20288711"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad615fc9a3faa8f6d0bc8f83b20288711">§ </a></span>setKernelValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ImageConvolutionKernel::setKernelValue </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>value</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">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the value of a specific cell in the kernel. </p>
<p>The x and y parameters must be in the range 0 < x < <a class="el" href="classImageConvolutionKernel.html#aa5afbee67f38185d60cb45cd4446f1fd" title="Returns the size of the kernel. ">getKernelSize()</a>.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classImageConvolutionKernel.html#ac71dbeddeb4565e410f5fed1a8216902" title="Rescales all values in the kernel to make the total add up to a fixed value. ">setOverallSum</a> </dd></dl>
</div>
</div>
<a id="ac71dbeddeb4565e410f5fed1a8216902"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac71dbeddeb4565e410f5fed1a8216902">§ </a></span>setOverallSum()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ImageConvolutionKernel::setOverallSum </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>desiredTotalSum</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rescales all values in the kernel to make the total add up to a fixed value. </p>
<p>This will multiply all values in the kernel by (desiredTotalSum / currentTotalSum). </p>
</div>
</div>
<a id="adff3c9b24817bd16ffa56df9af129641"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adff3c9b24817bd16ffa56df9af129641">§ </a></span>rescaleAllValues()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ImageConvolutionKernel::rescaleAllValues </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>multiplier</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Multiplies all values in the kernel by a value. </p>
</div>
</div>
<a id="a622a69a6e139de9ccc3bf8f15b841dfe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a622a69a6e139de9ccc3bf8f15b841dfe">§ </a></span>createGaussianBlur()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ImageConvolutionKernel::createGaussianBlur </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>blurRadius</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Intialises the kernel for a gaussian blur. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">blurRadius</td><td>this may be larger or smaller than the kernel's actual size but this will obviously be wasteful or clip at the edges. Ideally the kernel should be just larger than (blurRadius * 2). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa5afbee67f38185d60cb45cd4446f1fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5afbee67f38185d60cb45cd4446f1fd">§ </a></span>getKernelSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ImageConvolutionKernel::getKernelSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the size of the kernel. </p>
<p>E.g. if it's a 3x3 kernel, this returns 3. </p>
<p>References <a class="el" href="juce__PlatformDefs_8h.html#a851b02724a8158a7f746c66b5758b3dd">JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR</a>.</p>
</div>
</div>
<a id="a348777a7f6de064662e4a380c5e98236"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a348777a7f6de064662e4a380c5e98236">§ </a></span>applyToImage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ImageConvolutionKernel::applyToImage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classImage.html">Image</a> & </td>
<td class="paramname"><em>destImage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classImage.html">Image</a> & </td>
<td class="paramname"><em>sourceImage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classRectangle.html">Rectangle</a>< int > & </td>
<td class="paramname"><em>destinationArea</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Applies the kernel to an image. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">destImage</td><td>the image that will receive the resultant convoluted pixels. </td></tr>
<tr><td class="paramname">sourceImage</td><td>the source image to read from - this can be the same image as the destination, but if different, it must be exactly the same size and format. </td></tr>
<tr><td class="paramname">destinationArea</td><td>the region of the image to apply the filter to </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__ImageConvolutionKernel_8h.html">juce_ImageConvolutionKernel.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|