BOWImgDescriptorExtractor.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383
  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>BOWImgDescriptorExtractor (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="BOWImgDescriptorExtractor (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><a href="../../../org/opencv/features2d/BFMatcher.html" title="class in org.opencv.features2d"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  62. <li><a href="../../../org/opencv/features2d/BOWKMeansTrainer.html" title="class in org.opencv.features2d"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  63. </ul>
  64. <ul class="navList">
  65. <li><a href="../../../index.html?org/opencv/features2d/BOWImgDescriptorExtractor.html" target="_top">Frames</a></li>
  66. <li><a href="BOWImgDescriptorExtractor.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.features2d</div>
  105. <h2 title="Class BOWImgDescriptorExtractor" class="title">Class BOWImgDescriptorExtractor</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>org.opencv.features2d.BOWImgDescriptorExtractor</li>
  113. </ul>
  114. </li>
  115. </ul>
  116. <div class="description">
  117. <ul class="blockList">
  118. <li class="blockList">
  119. <hr>
  120. <br>
  121. <pre>public class <span class="typeNameLabel">BOWImgDescriptorExtractor</span>
  122. extends java.lang.Object</pre>
  123. <div class="block">Class to compute an image descriptor using the *bag of visual words*.
  124. Such a computation consists of the following steps:
  125. 1. Compute descriptors for a given image and its keypoints set.
  126. 2. Find the nearest visual words from the vocabulary for each keypoint descriptor.
  127. 3. Compute the bag-of-words image descriptor as is a normalized histogram of vocabulary words
  128. encountered in the image. The i-th bin of the histogram is a frequency of i-th word of the
  129. vocabulary in the given image.</div>
  130. </li>
  131. </ul>
  132. </div>
  133. <div class="summary">
  134. <ul class="blockList">
  135. <li class="blockList">
  136. <!-- ========== METHOD SUMMARY =========== -->
  137. <ul class="blockList">
  138. <li class="blockList"><a name="method.summary">
  139. <!-- -->
  140. </a>
  141. <h3>Method Summary</h3>
  142. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  143. <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>
  144. <tr>
  145. <th class="colFirst" scope="col">Modifier and Type</th>
  146. <th class="colLast" scope="col">Method and Description</th>
  147. </tr>
  148. <tr id="i0" class="altColor">
  149. <td class="colFirst"><code>static <a href="../../../org/opencv/features2d/BOWImgDescriptorExtractor.html" title="class in org.opencv.features2d">BOWImgDescriptorExtractor</a></code></td>
  150. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/features2d/BOWImgDescriptorExtractor.html#Z:Z__fromPtr__-long-">__fromPtr__</a></span>(long&nbsp;addr)</code>&nbsp;</td>
  151. </tr>
  152. <tr id="i1" class="rowColor">
  153. <td class="colFirst"><code>void</code></td>
  154. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/features2d/BOWImgDescriptorExtractor.html#compute-org.opencv.core.Mat-org.opencv.core.MatOfKeyPoint-org.opencv.core.Mat-">compute</a></span>(<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;image,
  155. <a href="../../../org/opencv/core/MatOfKeyPoint.html" title="class in org.opencv.core">MatOfKeyPoint</a>&nbsp;keypoints,
  156. <a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;imgDescriptor)</code>&nbsp;</td>
  157. </tr>
  158. <tr id="i2" class="altColor">
  159. <td class="colFirst"><code>int</code></td>
  160. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/features2d/BOWImgDescriptorExtractor.html#descriptorSize--">descriptorSize</a></span>()</code>
  161. <div class="block">Returns an image descriptor size if the vocabulary is set.</div>
  162. </td>
  163. </tr>
  164. <tr id="i3" class="rowColor">
  165. <td class="colFirst"><code>int</code></td>
  166. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/features2d/BOWImgDescriptorExtractor.html#descriptorType--">descriptorType</a></span>()</code>
  167. <div class="block">Returns an image descriptor type.</div>
  168. </td>
  169. </tr>
  170. <tr id="i4" class="altColor">
  171. <td class="colFirst"><code>long</code></td>
  172. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/features2d/BOWImgDescriptorExtractor.html#getNativeObjAddr--">getNativeObjAddr</a></span>()</code>&nbsp;</td>
  173. </tr>
  174. <tr id="i5" class="rowColor">
  175. <td class="colFirst"><code><a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a></code></td>
  176. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/features2d/BOWImgDescriptorExtractor.html#getVocabulary--">getVocabulary</a></span>()</code>
  177. <div class="block">Returns the set vocabulary.</div>
  178. </td>
  179. </tr>
  180. <tr id="i6" class="altColor">
  181. <td class="colFirst"><code>void</code></td>
  182. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/features2d/BOWImgDescriptorExtractor.html#setVocabulary-org.opencv.core.Mat-">setVocabulary</a></span>(<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;vocabulary)</code>
  183. <div class="block">Sets a visual vocabulary.</div>
  184. </td>
  185. </tr>
  186. </table>
  187. <ul class="blockList">
  188. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  189. <!-- -->
  190. </a>
  191. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  192. <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  193. </ul>
  194. </li>
  195. </ul>
  196. </li>
  197. </ul>
  198. </div>
  199. <div class="details">
  200. <ul class="blockList">
  201. <li class="blockList">
  202. <!-- ============ METHOD DETAIL ========== -->
  203. <ul class="blockList">
  204. <li class="blockList"><a name="method.detail">
  205. <!-- -->
  206. </a>
  207. <h3>Method Detail</h3>
  208. <a name="Z:Z__fromPtr__-long-">
  209. <!-- -->
  210. </a>
  211. <ul class="blockList">
  212. <li class="blockList">
  213. <h4>__fromPtr__</h4>
  214. <pre>public static&nbsp;<a href="../../../org/opencv/features2d/BOWImgDescriptorExtractor.html" title="class in org.opencv.features2d">BOWImgDescriptorExtractor</a>&nbsp;__fromPtr__(long&nbsp;addr)</pre>
  215. </li>
  216. </ul>
  217. <a name="compute-org.opencv.core.Mat-org.opencv.core.MatOfKeyPoint-org.opencv.core.Mat-">
  218. <!-- -->
  219. </a>
  220. <ul class="blockList">
  221. <li class="blockList">
  222. <h4>compute</h4>
  223. <pre>public&nbsp;void&nbsp;compute(<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;image,
  224. <a href="../../../org/opencv/core/MatOfKeyPoint.html" title="class in org.opencv.core">MatOfKeyPoint</a>&nbsp;keypoints,
  225. <a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;imgDescriptor)</pre>
  226. <dl>
  227. <dt><span class="paramLabel">Parameters:</span></dt>
  228. <dd><code>imgDescriptor</code> - Computed output image descriptor.
  229. pointIdxsOfClusters[i] are keypoint indices that belong to the i -th cluster (word of vocabulary)
  230. returned if it is non-zero.</dd>
  231. <dd><code>image</code> - automatically generated</dd>
  232. <dd><code>keypoints</code> - automatically generated</dd>
  233. </dl>
  234. </li>
  235. </ul>
  236. <a name="descriptorSize--">
  237. <!-- -->
  238. </a>
  239. <ul class="blockList">
  240. <li class="blockList">
  241. <h4>descriptorSize</h4>
  242. <pre>public&nbsp;int&nbsp;descriptorSize()</pre>
  243. <div class="block">Returns an image descriptor size if the vocabulary is set. Otherwise, it returns 0.</div>
  244. <dl>
  245. <dt><span class="returnLabel">Returns:</span></dt>
  246. <dd>automatically generated</dd>
  247. </dl>
  248. </li>
  249. </ul>
  250. <a name="descriptorType--">
  251. <!-- -->
  252. </a>
  253. <ul class="blockList">
  254. <li class="blockList">
  255. <h4>descriptorType</h4>
  256. <pre>public&nbsp;int&nbsp;descriptorType()</pre>
  257. <div class="block">Returns an image descriptor type.</div>
  258. <dl>
  259. <dt><span class="returnLabel">Returns:</span></dt>
  260. <dd>automatically generated</dd>
  261. </dl>
  262. </li>
  263. </ul>
  264. <a name="getNativeObjAddr--">
  265. <!-- -->
  266. </a>
  267. <ul class="blockList">
  268. <li class="blockList">
  269. <h4>getNativeObjAddr</h4>
  270. <pre>public&nbsp;long&nbsp;getNativeObjAddr()</pre>
  271. </li>
  272. </ul>
  273. <a name="getVocabulary--">
  274. <!-- -->
  275. </a>
  276. <ul class="blockList">
  277. <li class="blockList">
  278. <h4>getVocabulary</h4>
  279. <pre>public&nbsp;<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;getVocabulary()</pre>
  280. <div class="block">Returns the set vocabulary.</div>
  281. <dl>
  282. <dt><span class="returnLabel">Returns:</span></dt>
  283. <dd>automatically generated</dd>
  284. </dl>
  285. </li>
  286. </ul>
  287. <a name="setVocabulary-org.opencv.core.Mat-">
  288. <!-- -->
  289. </a>
  290. <ul class="blockListLast">
  291. <li class="blockList">
  292. <h4>setVocabulary</h4>
  293. <pre>public&nbsp;void&nbsp;setVocabulary(<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;vocabulary)</pre>
  294. <div class="block">Sets a visual vocabulary.</div>
  295. <dl>
  296. <dt><span class="paramLabel">Parameters:</span></dt>
  297. <dd><code>vocabulary</code> - Vocabulary (can be trained using the inheritor of BOWTrainer ). Each row of the
  298. vocabulary is a visual word (cluster center).</dd>
  299. </dl>
  300. </li>
  301. </ul>
  302. </li>
  303. </ul>
  304. </li>
  305. </ul>
  306. </div>
  307. </div>
  308. <!-- ========= END OF CLASS DATA ========= -->
  309. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  310. <div class="bottomNav"><a name="navbar.bottom">
  311. <!-- -->
  312. </a>
  313. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  314. <a name="navbar.bottom.firstrow">
  315. <!-- -->
  316. </a>
  317. <ul class="navList" title="Navigation">
  318. <li><a href="../../../overview-summary.html">Overview</a></li>
  319. <li><a href="package-summary.html">Package</a></li>
  320. <li class="navBarCell1Rev">Class</li>
  321. <li><a href="package-tree.html">Tree</a></li>
  322. <li><a href="../../../index-all.html">Index</a></li>
  323. <li><a href="../../../help-doc.html">Help</a></li>
  324. </ul>
  325. <div class="aboutLanguage">
  326. <script>
  327. var url = window.location.href;
  328. var pos = url.lastIndexOf('/javadoc/');
  329. url = pos >= 0 ? (url.substring(0, pos) + '/javadoc/mymath.js') : (window.location.origin + '/mymath.js');
  330. var script = document.createElement('script');
  331. script.src = 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML,' + url;
  332. document.getElementsByTagName('head')[0].appendChild(script);
  333. </script>
  334. </div>
  335. </div>
  336. <div class="subNav">
  337. <ul class="navList">
  338. <li><a href="../../../org/opencv/features2d/BFMatcher.html" title="class in org.opencv.features2d"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  339. <li><a href="../../../org/opencv/features2d/BOWKMeansTrainer.html" title="class in org.opencv.features2d"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  340. </ul>
  341. <ul class="navList">
  342. <li><a href="../../../index.html?org/opencv/features2d/BOWImgDescriptorExtractor.html" target="_top">Frames</a></li>
  343. <li><a href="BOWImgDescriptorExtractor.html" target="_top">No&nbsp;Frames</a></li>
  344. </ul>
  345. <ul class="navList" id="allclasses_navbar_bottom">
  346. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  347. </ul>
  348. <div>
  349. <script type="text/javascript"><!--
  350. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  351. if(window==top) {
  352. allClassesLink.style.display = "block";
  353. }
  354. else {
  355. allClassesLink.style.display = "none";
  356. }
  357. //-->
  358. </script>
  359. </div>
  360. <div>
  361. <ul class="subNavList">
  362. <li>Summary:&nbsp;</li>
  363. <li>Nested&nbsp;|&nbsp;</li>
  364. <li>Field&nbsp;|&nbsp;</li>
  365. <li>Constr&nbsp;|&nbsp;</li>
  366. <li><a href="#method.summary">Method</a></li>
  367. </ul>
  368. <ul class="subNavList">
  369. <li>Detail:&nbsp;</li>
  370. <li>Field&nbsp;|&nbsp;</li>
  371. <li>Constr&nbsp;|&nbsp;</li>
  372. <li><a href="#method.detail">Method</a></li>
  373. </ul>
  374. </div>
  375. <a name="skip.navbar.bottom">
  376. <!-- -->
  377. </a></div>
  378. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  379. <p class="legalCopy"><small>Generated on 2023-06-28 12:47:21 / OpenCV 4.8.0</small></p>
  380. </body>
  381. </html>