CLAHE.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_312) on Wed Jun 28 12:47:25 UTC 2023 -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. <title>CLAHE (OpenCV 4.8.0 Java documentation)</title>
  8. <meta name="date" content="2023-06-28">
  9. <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
  10. <script type="text/javascript" src="../../../script.js"></script>
  11. </head>
  12. <body>
  13. <script type="text/javascript"><!--
  14. try {
  15. if (location.href.indexOf('is-external=true') == -1) {
  16. parent.document.title="CLAHE (OpenCV 4.8.0 Java documentation)";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
  23. var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  24. var altColor = "altColor";
  25. var rowColor = "rowColor";
  26. var tableTab = "tableTab";
  27. var activeTableTab = "activeTableTab";
  28. </script>
  29. <noscript>
  30. <div>JavaScript is disabled on your browser.</div>
  31. </noscript>
  32. <!-- ========= START OF TOP NAVBAR ======= -->
  33. <div class="topNav"><a name="navbar.top">
  34. <!-- -->
  35. </a>
  36. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  37. <a name="navbar.top.firstrow">
  38. <!-- -->
  39. </a>
  40. <ul class="navList" title="Navigation">
  41. <li><a href="../../../overview-summary.html">Overview</a></li>
  42. <li><a href="package-summary.html">Package</a></li>
  43. <li class="navBarCell1Rev">Class</li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../index-all.html">Index</a></li>
  46. <li><a href="../../../help-doc.html">Help</a></li>
  47. </ul>
  48. <div class="aboutLanguage">
  49. <script>
  50. var url = window.location.href;
  51. var pos = url.lastIndexOf('/javadoc/');
  52. url = pos >= 0 ? (url.substring(0, pos) + '/javadoc/mymath.js') : (window.location.origin + '/mymath.js');
  53. var script = document.createElement('script');
  54. script.src = 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML,' + url;
  55. document.getElementsByTagName('head')[0].appendChild(script);
  56. </script>
  57. </div>
  58. </div>
  59. <div class="subNav">
  60. <ul class="navList">
  61. <li>Prev&nbsp;Class</li>
  62. <li><a href="../../../org/opencv/imgproc/GeneralizedHough.html" title="class in org.opencv.imgproc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  63. </ul>
  64. <ul class="navList">
  65. <li><a href="../../../index.html?org/opencv/imgproc/CLAHE.html" target="_top">Frames</a></li>
  66. <li><a href="CLAHE.html" target="_top">No&nbsp;Frames</a></li>
  67. </ul>
  68. <ul class="navList" id="allclasses_navbar_top">
  69. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  70. </ul>
  71. <div>
  72. <script type="text/javascript"><!--
  73. allClassesLink = document.getElementById("allclasses_navbar_top");
  74. if(window==top) {
  75. allClassesLink.style.display = "block";
  76. }
  77. else {
  78. allClassesLink.style.display = "none";
  79. }
  80. //-->
  81. </script>
  82. </div>
  83. <div>
  84. <ul class="subNavList">
  85. <li>Summary:&nbsp;</li>
  86. <li>Nested&nbsp;|&nbsp;</li>
  87. <li>Field&nbsp;|&nbsp;</li>
  88. <li>Constr&nbsp;|&nbsp;</li>
  89. <li><a href="#method.summary">Method</a></li>
  90. </ul>
  91. <ul class="subNavList">
  92. <li>Detail:&nbsp;</li>
  93. <li>Field&nbsp;|&nbsp;</li>
  94. <li>Constr&nbsp;|&nbsp;</li>
  95. <li><a href="#method.detail">Method</a></li>
  96. </ul>
  97. </div>
  98. <a name="skip.navbar.top">
  99. <!-- -->
  100. </a></div>
  101. <!-- ========= END OF TOP NAVBAR ========= -->
  102. <!-- ======== START OF CLASS DATA ======== -->
  103. <div class="header">
  104. <div class="subTitle">org.opencv.imgproc</div>
  105. <h2 title="Class CLAHE" class="title">Class CLAHE</h2>
  106. </div>
  107. <div class="contentContainer">
  108. <ul class="inheritance">
  109. <li>java.lang.Object</li>
  110. <li>
  111. <ul class="inheritance">
  112. <li><a href="../../../org/opencv/core/Algorithm.html" title="class in org.opencv.core">org.opencv.core.Algorithm</a></li>
  113. <li>
  114. <ul class="inheritance">
  115. <li>org.opencv.imgproc.CLAHE</li>
  116. </ul>
  117. </li>
  118. </ul>
  119. </li>
  120. </ul>
  121. <div class="description">
  122. <ul class="blockList">
  123. <li class="blockList">
  124. <hr>
  125. <br>
  126. <pre>public class <span class="typeNameLabel">CLAHE</span>
  127. extends <a href="../../../org/opencv/core/Algorithm.html" title="class in org.opencv.core">Algorithm</a></pre>
  128. <div class="block">Base class for Contrast Limited Adaptive Histogram Equalization.</div>
  129. </li>
  130. </ul>
  131. </div>
  132. <div class="summary">
  133. <ul class="blockList">
  134. <li class="blockList">
  135. <!-- ========== METHOD SUMMARY =========== -->
  136. <ul class="blockList">
  137. <li class="blockList"><a name="method.summary">
  138. <!-- -->
  139. </a>
  140. <h3>Method Summary</h3>
  141. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  142. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  143. <tr>
  144. <th class="colFirst" scope="col">Modifier and Type</th>
  145. <th class="colLast" scope="col">Method and Description</th>
  146. </tr>
  147. <tr id="i0" class="altColor">
  148. <td class="colFirst"><code>static <a href="../../../org/opencv/imgproc/CLAHE.html" title="class in org.opencv.imgproc">CLAHE</a></code></td>
  149. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/imgproc/CLAHE.html#Z:Z__fromPtr__-long-">__fromPtr__</a></span>(long&nbsp;addr)</code>&nbsp;</td>
  150. </tr>
  151. <tr id="i1" class="rowColor">
  152. <td class="colFirst"><code>void</code></td>
  153. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/imgproc/CLAHE.html#apply-org.opencv.core.Mat-org.opencv.core.Mat-">apply</a></span>(<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;src,
  154. <a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;dst)</code>
  155. <div class="block">Equalizes the histogram of a grayscale image using Contrast Limited Adaptive Histogram Equalization.</div>
  156. </td>
  157. </tr>
  158. <tr id="i2" class="altColor">
  159. <td class="colFirst"><code>void</code></td>
  160. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/imgproc/CLAHE.html#collectGarbage--">collectGarbage</a></span>()</code>&nbsp;</td>
  161. </tr>
  162. <tr id="i3" class="rowColor">
  163. <td class="colFirst"><code>double</code></td>
  164. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/imgproc/CLAHE.html#getClipLimit--">getClipLimit</a></span>()</code>&nbsp;</td>
  165. </tr>
  166. <tr id="i4" class="altColor">
  167. <td class="colFirst"><code><a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a></code></td>
  168. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/imgproc/CLAHE.html#getTilesGridSize--">getTilesGridSize</a></span>()</code>&nbsp;</td>
  169. </tr>
  170. <tr id="i5" class="rowColor">
  171. <td class="colFirst"><code>void</code></td>
  172. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/imgproc/CLAHE.html#setClipLimit-double-">setClipLimit</a></span>(double&nbsp;clipLimit)</code>
  173. <div class="block">Sets threshold for contrast limiting.</div>
  174. </td>
  175. </tr>
  176. <tr id="i6" class="altColor">
  177. <td class="colFirst"><code>void</code></td>
  178. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/imgproc/CLAHE.html#setTilesGridSize-org.opencv.core.Size-">setTilesGridSize</a></span>(<a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;tileGridSize)</code>
  179. <div class="block">Sets size of grid for histogram equalization.</div>
  180. </td>
  181. </tr>
  182. </table>
  183. <ul class="blockList">
  184. <li class="blockList"><a name="methods.inherited.from.class.org.opencv.core.Algorithm">
  185. <!-- -->
  186. </a>
  187. <h3>Methods inherited from class&nbsp;org.opencv.core.<a href="../../../org/opencv/core/Algorithm.html" title="class in org.opencv.core">Algorithm</a></h3>
  188. <code><a href="../../../org/opencv/core/Algorithm.html#clear--">clear</a>, <a href="../../../org/opencv/core/Algorithm.html#empty--">empty</a>, <a href="../../../org/opencv/core/Algorithm.html#getDefaultName--">getDefaultName</a>, <a href="../../../org/opencv/core/Algorithm.html#getNativeObjAddr--">getNativeObjAddr</a>, <a href="../../../org/opencv/core/Algorithm.html#save-java.lang.String-">save</a></code></li>
  189. </ul>
  190. <ul class="blockList">
  191. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  192. <!-- -->
  193. </a>
  194. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  195. <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  196. </ul>
  197. </li>
  198. </ul>
  199. </li>
  200. </ul>
  201. </div>
  202. <div class="details">
  203. <ul class="blockList">
  204. <li class="blockList">
  205. <!-- ============ METHOD DETAIL ========== -->
  206. <ul class="blockList">
  207. <li class="blockList"><a name="method.detail">
  208. <!-- -->
  209. </a>
  210. <h3>Method Detail</h3>
  211. <a name="Z:Z__fromPtr__-long-">
  212. <!-- -->
  213. </a>
  214. <ul class="blockList">
  215. <li class="blockList">
  216. <h4>__fromPtr__</h4>
  217. <pre>public static&nbsp;<a href="../../../org/opencv/imgproc/CLAHE.html" title="class in org.opencv.imgproc">CLAHE</a>&nbsp;__fromPtr__(long&nbsp;addr)</pre>
  218. </li>
  219. </ul>
  220. <a name="apply-org.opencv.core.Mat-org.opencv.core.Mat-">
  221. <!-- -->
  222. </a>
  223. <ul class="blockList">
  224. <li class="blockList">
  225. <h4>apply</h4>
  226. <pre>public&nbsp;void&nbsp;apply(<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;src,
  227. <a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;dst)</pre>
  228. <div class="block">Equalizes the histogram of a grayscale image using Contrast Limited Adaptive Histogram Equalization.</div>
  229. <dl>
  230. <dt><span class="paramLabel">Parameters:</span></dt>
  231. <dd><code>src</code> - Source image of type CV_8UC1 or CV_16UC1.</dd>
  232. <dd><code>dst</code> - Destination image.</dd>
  233. </dl>
  234. </li>
  235. </ul>
  236. <a name="collectGarbage--">
  237. <!-- -->
  238. </a>
  239. <ul class="blockList">
  240. <li class="blockList">
  241. <h4>collectGarbage</h4>
  242. <pre>public&nbsp;void&nbsp;collectGarbage()</pre>
  243. </li>
  244. </ul>
  245. <a name="getClipLimit--">
  246. <!-- -->
  247. </a>
  248. <ul class="blockList">
  249. <li class="blockList">
  250. <h4>getClipLimit</h4>
  251. <pre>public&nbsp;double&nbsp;getClipLimit()</pre>
  252. </li>
  253. </ul>
  254. <a name="getTilesGridSize--">
  255. <!-- -->
  256. </a>
  257. <ul class="blockList">
  258. <li class="blockList">
  259. <h4>getTilesGridSize</h4>
  260. <pre>public&nbsp;<a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;getTilesGridSize()</pre>
  261. </li>
  262. </ul>
  263. <a name="setClipLimit-double-">
  264. <!-- -->
  265. </a>
  266. <ul class="blockList">
  267. <li class="blockList">
  268. <h4>setClipLimit</h4>
  269. <pre>public&nbsp;void&nbsp;setClipLimit(double&nbsp;clipLimit)</pre>
  270. <div class="block">Sets threshold for contrast limiting.</div>
  271. <dl>
  272. <dt><span class="paramLabel">Parameters:</span></dt>
  273. <dd><code>clipLimit</code> - threshold value.</dd>
  274. </dl>
  275. </li>
  276. </ul>
  277. <a name="setTilesGridSize-org.opencv.core.Size-">
  278. <!-- -->
  279. </a>
  280. <ul class="blockListLast">
  281. <li class="blockList">
  282. <h4>setTilesGridSize</h4>
  283. <pre>public&nbsp;void&nbsp;setTilesGridSize(<a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;tileGridSize)</pre>
  284. <div class="block">Sets size of grid for histogram equalization. Input image will be divided into
  285. equally sized rectangular tiles.</div>
  286. <dl>
  287. <dt><span class="paramLabel">Parameters:</span></dt>
  288. <dd><code>tileGridSize</code> - defines the number of tiles in row and column.</dd>
  289. </dl>
  290. </li>
  291. </ul>
  292. </li>
  293. </ul>
  294. </li>
  295. </ul>
  296. </div>
  297. </div>
  298. <!-- ========= END OF CLASS DATA ========= -->
  299. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  300. <div class="bottomNav"><a name="navbar.bottom">
  301. <!-- -->
  302. </a>
  303. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  304. <a name="navbar.bottom.firstrow">
  305. <!-- -->
  306. </a>
  307. <ul class="navList" title="Navigation">
  308. <li><a href="../../../overview-summary.html">Overview</a></li>
  309. <li><a href="package-summary.html">Package</a></li>
  310. <li class="navBarCell1Rev">Class</li>
  311. <li><a href="package-tree.html">Tree</a></li>
  312. <li><a href="../../../index-all.html">Index</a></li>
  313. <li><a href="../../../help-doc.html">Help</a></li>
  314. </ul>
  315. <div class="aboutLanguage">
  316. <script>
  317. var url = window.location.href;
  318. var pos = url.lastIndexOf('/javadoc/');
  319. url = pos >= 0 ? (url.substring(0, pos) + '/javadoc/mymath.js') : (window.location.origin + '/mymath.js');
  320. var script = document.createElement('script');
  321. script.src = 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML,' + url;
  322. document.getElementsByTagName('head')[0].appendChild(script);
  323. </script>
  324. </div>
  325. </div>
  326. <div class="subNav">
  327. <ul class="navList">
  328. <li>Prev&nbsp;Class</li>
  329. <li><a href="../../../org/opencv/imgproc/GeneralizedHough.html" title="class in org.opencv.imgproc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  330. </ul>
  331. <ul class="navList">
  332. <li><a href="../../../index.html?org/opencv/imgproc/CLAHE.html" target="_top">Frames</a></li>
  333. <li><a href="CLAHE.html" target="_top">No&nbsp;Frames</a></li>
  334. </ul>
  335. <ul class="navList" id="allclasses_navbar_bottom">
  336. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  337. </ul>
  338. <div>
  339. <script type="text/javascript"><!--
  340. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  341. if(window==top) {
  342. allClassesLink.style.display = "block";
  343. }
  344. else {
  345. allClassesLink.style.display = "none";
  346. }
  347. //-->
  348. </script>
  349. </div>
  350. <div>
  351. <ul class="subNavList">
  352. <li>Summary:&nbsp;</li>
  353. <li>Nested&nbsp;|&nbsp;</li>
  354. <li>Field&nbsp;|&nbsp;</li>
  355. <li>Constr&nbsp;|&nbsp;</li>
  356. <li><a href="#method.summary">Method</a></li>
  357. </ul>
  358. <ul class="subNavList">
  359. <li>Detail:&nbsp;</li>
  360. <li>Field&nbsp;|&nbsp;</li>
  361. <li>Constr&nbsp;|&nbsp;</li>
  362. <li><a href="#method.detail">Method</a></li>
  363. </ul>
  364. </div>
  365. <a name="skip.navbar.bottom">
  366. <!-- -->
  367. </a></div>
  368. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  369. <p class="legalCopy"><small>Generated on 2023-06-28 12:47:21 / OpenCV 4.8.0</small></p>
  370. </body>
  371. </html>