BackgroundSubtractor.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353
  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:23 UTC 2023 -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. <title>BackgroundSubtractor (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="BackgroundSubtractor (OpenCV 4.8.0 Java documentation)";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. var methods = {"i0":9,"i1":10,"i2":10,"i3":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/video/BackgroundSubtractorKNN.html" title="class in org.opencv.video"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  63. </ul>
  64. <ul class="navList">
  65. <li><a href="../../../index.html?org/opencv/video/BackgroundSubtractor.html" target="_top">Frames</a></li>
  66. <li><a href="BackgroundSubtractor.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.video</div>
  105. <h2 title="Class BackgroundSubtractor" class="title">Class BackgroundSubtractor</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.video.BackgroundSubtractor</li>
  116. </ul>
  117. </li>
  118. </ul>
  119. </li>
  120. </ul>
  121. <div class="description">
  122. <ul class="blockList">
  123. <li class="blockList">
  124. <dl>
  125. <dt>Direct Known Subclasses:</dt>
  126. <dd><a href="../../../org/opencv/video/BackgroundSubtractorKNN.html" title="class in org.opencv.video">BackgroundSubtractorKNN</a>, <a href="../../../org/opencv/video/BackgroundSubtractorMOG2.html" title="class in org.opencv.video">BackgroundSubtractorMOG2</a></dd>
  127. </dl>
  128. <hr>
  129. <br>
  130. <pre>public class <span class="typeNameLabel">BackgroundSubtractor</span>
  131. extends <a href="../../../org/opencv/core/Algorithm.html" title="class in org.opencv.core">Algorithm</a></pre>
  132. <div class="block">Base class for background/foreground segmentation. :
  133. The class is only used to define the common interface for the whole family of background/foreground
  134. segmentation algorithms.</div>
  135. </li>
  136. </ul>
  137. </div>
  138. <div class="summary">
  139. <ul class="blockList">
  140. <li class="blockList">
  141. <!-- ========== METHOD SUMMARY =========== -->
  142. <ul class="blockList">
  143. <li class="blockList"><a name="method.summary">
  144. <!-- -->
  145. </a>
  146. <h3>Method Summary</h3>
  147. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  148. <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>
  149. <tr>
  150. <th class="colFirst" scope="col">Modifier and Type</th>
  151. <th class="colLast" scope="col">Method and Description</th>
  152. </tr>
  153. <tr id="i0" class="altColor">
  154. <td class="colFirst"><code>static <a href="../../../org/opencv/video/BackgroundSubtractor.html" title="class in org.opencv.video">BackgroundSubtractor</a></code></td>
  155. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/video/BackgroundSubtractor.html#Z:Z__fromPtr__-long-">__fromPtr__</a></span>(long&nbsp;addr)</code>&nbsp;</td>
  156. </tr>
  157. <tr id="i1" class="rowColor">
  158. <td class="colFirst"><code>void</code></td>
  159. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/video/BackgroundSubtractor.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;image,
  160. <a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;fgmask)</code>
  161. <div class="block">Computes a foreground mask.</div>
  162. </td>
  163. </tr>
  164. <tr id="i2" class="altColor">
  165. <td class="colFirst"><code>void</code></td>
  166. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/video/BackgroundSubtractor.html#apply-org.opencv.core.Mat-org.opencv.core.Mat-double-">apply</a></span>(<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;image,
  167. <a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;fgmask,
  168. double&nbsp;learningRate)</code>
  169. <div class="block">Computes a foreground mask.</div>
  170. </td>
  171. </tr>
  172. <tr id="i3" class="rowColor">
  173. <td class="colFirst"><code>void</code></td>
  174. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/video/BackgroundSubtractor.html#getBackgroundImage-org.opencv.core.Mat-">getBackgroundImage</a></span>(<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;backgroundImage)</code>
  175. <div class="block">Computes a background image.</div>
  176. </td>
  177. </tr>
  178. </table>
  179. <ul class="blockList">
  180. <li class="blockList"><a name="methods.inherited.from.class.org.opencv.core.Algorithm">
  181. <!-- -->
  182. </a>
  183. <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>
  184. <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>
  185. </ul>
  186. <ul class="blockList">
  187. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  188. <!-- -->
  189. </a>
  190. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  191. <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  192. </ul>
  193. </li>
  194. </ul>
  195. </li>
  196. </ul>
  197. </div>
  198. <div class="details">
  199. <ul class="blockList">
  200. <li class="blockList">
  201. <!-- ============ METHOD DETAIL ========== -->
  202. <ul class="blockList">
  203. <li class="blockList"><a name="method.detail">
  204. <!-- -->
  205. </a>
  206. <h3>Method Detail</h3>
  207. <a name="Z:Z__fromPtr__-long-">
  208. <!-- -->
  209. </a>
  210. <ul class="blockList">
  211. <li class="blockList">
  212. <h4>__fromPtr__</h4>
  213. <pre>public static&nbsp;<a href="../../../org/opencv/video/BackgroundSubtractor.html" title="class in org.opencv.video">BackgroundSubtractor</a>&nbsp;__fromPtr__(long&nbsp;addr)</pre>
  214. </li>
  215. </ul>
  216. <a name="apply-org.opencv.core.Mat-org.opencv.core.Mat-">
  217. <!-- -->
  218. </a>
  219. <ul class="blockList">
  220. <li class="blockList">
  221. <h4>apply</h4>
  222. <pre>public&nbsp;void&nbsp;apply(<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;image,
  223. <a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;fgmask)</pre>
  224. <div class="block">Computes a foreground mask.</div>
  225. <dl>
  226. <dt><span class="paramLabel">Parameters:</span></dt>
  227. <dd><code>image</code> - Next video frame.</dd>
  228. <dd><code>fgmask</code> - The output foreground mask as an 8-bit binary image.
  229. learnt. Negative parameter value makes the algorithm to use some automatically chosen learning
  230. rate. 0 means that the background model is not updated at all, 1 means that the background model
  231. is completely reinitialized from the last frame.</dd>
  232. </dl>
  233. </li>
  234. </ul>
  235. <a name="apply-org.opencv.core.Mat-org.opencv.core.Mat-double-">
  236. <!-- -->
  237. </a>
  238. <ul class="blockList">
  239. <li class="blockList">
  240. <h4>apply</h4>
  241. <pre>public&nbsp;void&nbsp;apply(<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;image,
  242. <a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;fgmask,
  243. double&nbsp;learningRate)</pre>
  244. <div class="block">Computes a foreground mask.</div>
  245. <dl>
  246. <dt><span class="paramLabel">Parameters:</span></dt>
  247. <dd><code>image</code> - Next video frame.</dd>
  248. <dd><code>fgmask</code> - The output foreground mask as an 8-bit binary image.</dd>
  249. <dd><code>learningRate</code> - The value between 0 and 1 that indicates how fast the background model is
  250. learnt. Negative parameter value makes the algorithm to use some automatically chosen learning
  251. rate. 0 means that the background model is not updated at all, 1 means that the background model
  252. is completely reinitialized from the last frame.</dd>
  253. </dl>
  254. </li>
  255. </ul>
  256. <a name="getBackgroundImage-org.opencv.core.Mat-">
  257. <!-- -->
  258. </a>
  259. <ul class="blockListLast">
  260. <li class="blockList">
  261. <h4>getBackgroundImage</h4>
  262. <pre>public&nbsp;void&nbsp;getBackgroundImage(<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;backgroundImage)</pre>
  263. <div class="block">Computes a background image.</div>
  264. <dl>
  265. <dt><span class="paramLabel">Parameters:</span></dt>
  266. <dd><code>backgroundImage</code> - The output background image.
  267. <b>Note:</b> Sometimes the background image can be very blurry, as it contain the average background
  268. statistics.</dd>
  269. </dl>
  270. </li>
  271. </ul>
  272. </li>
  273. </ul>
  274. </li>
  275. </ul>
  276. </div>
  277. </div>
  278. <!-- ========= END OF CLASS DATA ========= -->
  279. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  280. <div class="bottomNav"><a name="navbar.bottom">
  281. <!-- -->
  282. </a>
  283. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  284. <a name="navbar.bottom.firstrow">
  285. <!-- -->
  286. </a>
  287. <ul class="navList" title="Navigation">
  288. <li><a href="../../../overview-summary.html">Overview</a></li>
  289. <li><a href="package-summary.html">Package</a></li>
  290. <li class="navBarCell1Rev">Class</li>
  291. <li><a href="package-tree.html">Tree</a></li>
  292. <li><a href="../../../index-all.html">Index</a></li>
  293. <li><a href="../../../help-doc.html">Help</a></li>
  294. </ul>
  295. <div class="aboutLanguage">
  296. <script>
  297. var url = window.location.href;
  298. var pos = url.lastIndexOf('/javadoc/');
  299. url = pos >= 0 ? (url.substring(0, pos) + '/javadoc/mymath.js') : (window.location.origin + '/mymath.js');
  300. var script = document.createElement('script');
  301. script.src = 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML,' + url;
  302. document.getElementsByTagName('head')[0].appendChild(script);
  303. </script>
  304. </div>
  305. </div>
  306. <div class="subNav">
  307. <ul class="navList">
  308. <li>Prev&nbsp;Class</li>
  309. <li><a href="../../../org/opencv/video/BackgroundSubtractorKNN.html" title="class in org.opencv.video"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  310. </ul>
  311. <ul class="navList">
  312. <li><a href="../../../index.html?org/opencv/video/BackgroundSubtractor.html" target="_top">Frames</a></li>
  313. <li><a href="BackgroundSubtractor.html" target="_top">No&nbsp;Frames</a></li>
  314. </ul>
  315. <ul class="navList" id="allclasses_navbar_bottom">
  316. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  317. </ul>
  318. <div>
  319. <script type="text/javascript"><!--
  320. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  321. if(window==top) {
  322. allClassesLink.style.display = "block";
  323. }
  324. else {
  325. allClassesLink.style.display = "none";
  326. }
  327. //-->
  328. </script>
  329. </div>
  330. <div>
  331. <ul class="subNavList">
  332. <li>Summary:&nbsp;</li>
  333. <li>Nested&nbsp;|&nbsp;</li>
  334. <li>Field&nbsp;|&nbsp;</li>
  335. <li>Constr&nbsp;|&nbsp;</li>
  336. <li><a href="#method.summary">Method</a></li>
  337. </ul>
  338. <ul class="subNavList">
  339. <li>Detail:&nbsp;</li>
  340. <li>Field&nbsp;|&nbsp;</li>
  341. <li>Constr&nbsp;|&nbsp;</li>
  342. <li><a href="#method.detail">Method</a></li>
  343. </ul>
  344. </div>
  345. <a name="skip.navbar.bottom">
  346. <!-- -->
  347. </a></div>
  348. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  349. <p class="legalCopy"><small>Generated on 2023-06-28 12:47:21 / OpenCV 4.8.0</small></p>
  350. </body>
  351. </html>