GridBoard.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391
  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>GridBoard (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="GridBoard (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><a href="../../../org/opencv/objdetect/GraphicalCodeDetector.html" title="class in org.opencv.objdetect"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  62. <li><a href="../../../org/opencv/objdetect/HOGDescriptor.html" title="class in org.opencv.objdetect"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  63. </ul>
  64. <ul class="navList">
  65. <li><a href="../../../index.html?org/opencv/objdetect/GridBoard.html" target="_top">Frames</a></li>
  66. <li><a href="GridBoard.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.objdetect</div>
  105. <h2 title="Class GridBoard" class="title">Class GridBoard</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/objdetect/Board.html" title="class in org.opencv.objdetect">org.opencv.objdetect.Board</a></li>
  113. <li>
  114. <ul class="inheritance">
  115. <li>org.opencv.objdetect.GridBoard</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">GridBoard</span>
  127. extends <a href="../../../org/opencv/objdetect/Board.html" title="class in org.opencv.objdetect">Board</a></pre>
  128. <div class="block">Planar board with grid arrangement of markers
  129. More common type of board. All markers are placed in the same plane in a grid arrangement.
  130. The board image can be drawn using generateImage() method.</div>
  131. </li>
  132. </ul>
  133. </div>
  134. <div class="summary">
  135. <ul class="blockList">
  136. <li class="blockList">
  137. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  138. <ul class="blockList">
  139. <li class="blockList"><a name="constructor.summary">
  140. <!-- -->
  141. </a>
  142. <h3>Constructor Summary</h3>
  143. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  144. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  145. <tr>
  146. <th class="colOne" scope="col">Constructor and Description</th>
  147. </tr>
  148. <tr class="altColor">
  149. <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/opencv/objdetect/GridBoard.html#GridBoard-org.opencv.core.Size-float-float-org.opencv.objdetect.Dictionary-">GridBoard</a></span>(<a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;size,
  150. float&nbsp;markerLength,
  151. float&nbsp;markerSeparation,
  152. <a href="../../../org/opencv/objdetect/Dictionary.html" title="class in org.opencv.objdetect">Dictionary</a>&nbsp;dictionary)</code>
  153. <div class="block">GridBoard constructor</div>
  154. </td>
  155. </tr>
  156. <tr class="rowColor">
  157. <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/opencv/objdetect/GridBoard.html#GridBoard-org.opencv.core.Size-float-float-org.opencv.objdetect.Dictionary-org.opencv.core.Mat-">GridBoard</a></span>(<a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;size,
  158. float&nbsp;markerLength,
  159. float&nbsp;markerSeparation,
  160. <a href="../../../org/opencv/objdetect/Dictionary.html" title="class in org.opencv.objdetect">Dictionary</a>&nbsp;dictionary,
  161. <a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;ids)</code>
  162. <div class="block">GridBoard constructor</div>
  163. </td>
  164. </tr>
  165. </table>
  166. </li>
  167. </ul>
  168. <!-- ========== METHOD SUMMARY =========== -->
  169. <ul class="blockList">
  170. <li class="blockList"><a name="method.summary">
  171. <!-- -->
  172. </a>
  173. <h3>Method Summary</h3>
  174. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  175. <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>
  176. <tr>
  177. <th class="colFirst" scope="col">Modifier and Type</th>
  178. <th class="colLast" scope="col">Method and Description</th>
  179. </tr>
  180. <tr id="i0" class="altColor">
  181. <td class="colFirst"><code>static <a href="../../../org/opencv/objdetect/GridBoard.html" title="class in org.opencv.objdetect">GridBoard</a></code></td>
  182. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/objdetect/GridBoard.html#Z:Z__fromPtr__-long-">__fromPtr__</a></span>(long&nbsp;addr)</code>&nbsp;</td>
  183. </tr>
  184. <tr id="i1" class="rowColor">
  185. <td class="colFirst"><code><a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a></code></td>
  186. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/objdetect/GridBoard.html#getGridSize--">getGridSize</a></span>()</code>&nbsp;</td>
  187. </tr>
  188. <tr id="i2" class="altColor">
  189. <td class="colFirst"><code>float</code></td>
  190. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/objdetect/GridBoard.html#getMarkerLength--">getMarkerLength</a></span>()</code>&nbsp;</td>
  191. </tr>
  192. <tr id="i3" class="rowColor">
  193. <td class="colFirst"><code>float</code></td>
  194. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/objdetect/GridBoard.html#getMarkerSeparation--">getMarkerSeparation</a></span>()</code>&nbsp;</td>
  195. </tr>
  196. </table>
  197. <ul class="blockList">
  198. <li class="blockList"><a name="methods.inherited.from.class.org.opencv.objdetect.Board">
  199. <!-- -->
  200. </a>
  201. <h3>Methods inherited from class&nbsp;org.opencv.objdetect.<a href="../../../org/opencv/objdetect/Board.html" title="class in org.opencv.objdetect">Board</a></h3>
  202. <code><a href="../../../org/opencv/objdetect/Board.html#generateImage-org.opencv.core.Size-org.opencv.core.Mat-">generateImage</a>, <a href="../../../org/opencv/objdetect/Board.html#generateImage-org.opencv.core.Size-org.opencv.core.Mat-int-">generateImage</a>, <a href="../../../org/opencv/objdetect/Board.html#generateImage-org.opencv.core.Size-org.opencv.core.Mat-int-int-">generateImage</a>, <a href="../../../org/opencv/objdetect/Board.html#getDictionary--">getDictionary</a>, <a href="../../../org/opencv/objdetect/Board.html#getIds--">getIds</a>, <a href="../../../org/opencv/objdetect/Board.html#getNativeObjAddr--">getNativeObjAddr</a>, <a href="../../../org/opencv/objdetect/Board.html#getObjPoints--">getObjPoints</a>, <a href="../../../org/opencv/objdetect/Board.html#getRightBottomCorner--">getRightBottomCorner</a>, <a href="../../../org/opencv/objdetect/Board.html#matchImagePoints-java.util.List-org.opencv.core.Mat-org.opencv.core.Mat-org.opencv.core.Mat-">matchImagePoints</a></code></li>
  203. </ul>
  204. <ul class="blockList">
  205. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  206. <!-- -->
  207. </a>
  208. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  209. <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  210. </ul>
  211. </li>
  212. </ul>
  213. </li>
  214. </ul>
  215. </div>
  216. <div class="details">
  217. <ul class="blockList">
  218. <li class="blockList">
  219. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  220. <ul class="blockList">
  221. <li class="blockList"><a name="constructor.detail">
  222. <!-- -->
  223. </a>
  224. <h3>Constructor Detail</h3>
  225. <a name="GridBoard-org.opencv.core.Size-float-float-org.opencv.objdetect.Dictionary-">
  226. <!-- -->
  227. </a>
  228. <ul class="blockList">
  229. <li class="blockList">
  230. <h4>GridBoard</h4>
  231. <pre>public&nbsp;GridBoard(<a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;size,
  232. float&nbsp;markerLength,
  233. float&nbsp;markerSeparation,
  234. <a href="../../../org/opencv/objdetect/Dictionary.html" title="class in org.opencv.objdetect">Dictionary</a>&nbsp;dictionary)</pre>
  235. <div class="block">GridBoard constructor</div>
  236. <dl>
  237. <dt><span class="paramLabel">Parameters:</span></dt>
  238. <dd><code>size</code> - number of markers in x and y directions</dd>
  239. <dd><code>markerLength</code> - marker side length (normally in meters)</dd>
  240. <dd><code>markerSeparation</code> - separation between two markers (same unit as markerLength)</dd>
  241. <dd><code>dictionary</code> - dictionary of markers indicating the type of markers</dd>
  242. </dl>
  243. </li>
  244. </ul>
  245. <a name="GridBoard-org.opencv.core.Size-float-float-org.opencv.objdetect.Dictionary-org.opencv.core.Mat-">
  246. <!-- -->
  247. </a>
  248. <ul class="blockListLast">
  249. <li class="blockList">
  250. <h4>GridBoard</h4>
  251. <pre>public&nbsp;GridBoard(<a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;size,
  252. float&nbsp;markerLength,
  253. float&nbsp;markerSeparation,
  254. <a href="../../../org/opencv/objdetect/Dictionary.html" title="class in org.opencv.objdetect">Dictionary</a>&nbsp;dictionary,
  255. <a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;ids)</pre>
  256. <div class="block">GridBoard constructor</div>
  257. <dl>
  258. <dt><span class="paramLabel">Parameters:</span></dt>
  259. <dd><code>size</code> - number of markers in x and y directions</dd>
  260. <dd><code>markerLength</code> - marker side length (normally in meters)</dd>
  261. <dd><code>markerSeparation</code> - separation between two markers (same unit as markerLength)</dd>
  262. <dd><code>dictionary</code> - dictionary of markers indicating the type of markers</dd>
  263. <dd><code>ids</code> - set of marker ids in dictionary to use on board.</dd>
  264. </dl>
  265. </li>
  266. </ul>
  267. </li>
  268. </ul>
  269. <!-- ============ METHOD DETAIL ========== -->
  270. <ul class="blockList">
  271. <li class="blockList"><a name="method.detail">
  272. <!-- -->
  273. </a>
  274. <h3>Method Detail</h3>
  275. <a name="Z:Z__fromPtr__-long-">
  276. <!-- -->
  277. </a>
  278. <ul class="blockList">
  279. <li class="blockList">
  280. <h4>__fromPtr__</h4>
  281. <pre>public static&nbsp;<a href="../../../org/opencv/objdetect/GridBoard.html" title="class in org.opencv.objdetect">GridBoard</a>&nbsp;__fromPtr__(long&nbsp;addr)</pre>
  282. </li>
  283. </ul>
  284. <a name="getGridSize--">
  285. <!-- -->
  286. </a>
  287. <ul class="blockList">
  288. <li class="blockList">
  289. <h4>getGridSize</h4>
  290. <pre>public&nbsp;<a href="../../../org/opencv/core/Size.html" title="class in org.opencv.core">Size</a>&nbsp;getGridSize()</pre>
  291. </li>
  292. </ul>
  293. <a name="getMarkerLength--">
  294. <!-- -->
  295. </a>
  296. <ul class="blockList">
  297. <li class="blockList">
  298. <h4>getMarkerLength</h4>
  299. <pre>public&nbsp;float&nbsp;getMarkerLength()</pre>
  300. </li>
  301. </ul>
  302. <a name="getMarkerSeparation--">
  303. <!-- -->
  304. </a>
  305. <ul class="blockListLast">
  306. <li class="blockList">
  307. <h4>getMarkerSeparation</h4>
  308. <pre>public&nbsp;float&nbsp;getMarkerSeparation()</pre>
  309. </li>
  310. </ul>
  311. </li>
  312. </ul>
  313. </li>
  314. </ul>
  315. </div>
  316. </div>
  317. <!-- ========= END OF CLASS DATA ========= -->
  318. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  319. <div class="bottomNav"><a name="navbar.bottom">
  320. <!-- -->
  321. </a>
  322. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  323. <a name="navbar.bottom.firstrow">
  324. <!-- -->
  325. </a>
  326. <ul class="navList" title="Navigation">
  327. <li><a href="../../../overview-summary.html">Overview</a></li>
  328. <li><a href="package-summary.html">Package</a></li>
  329. <li class="navBarCell1Rev">Class</li>
  330. <li><a href="package-tree.html">Tree</a></li>
  331. <li><a href="../../../index-all.html">Index</a></li>
  332. <li><a href="../../../help-doc.html">Help</a></li>
  333. </ul>
  334. <div class="aboutLanguage">
  335. <script>
  336. var url = window.location.href;
  337. var pos = url.lastIndexOf('/javadoc/');
  338. url = pos >= 0 ? (url.substring(0, pos) + '/javadoc/mymath.js') : (window.location.origin + '/mymath.js');
  339. var script = document.createElement('script');
  340. script.src = 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML,' + url;
  341. document.getElementsByTagName('head')[0].appendChild(script);
  342. </script>
  343. </div>
  344. </div>
  345. <div class="subNav">
  346. <ul class="navList">
  347. <li><a href="../../../org/opencv/objdetect/GraphicalCodeDetector.html" title="class in org.opencv.objdetect"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  348. <li><a href="../../../org/opencv/objdetect/HOGDescriptor.html" title="class in org.opencv.objdetect"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  349. </ul>
  350. <ul class="navList">
  351. <li><a href="../../../index.html?org/opencv/objdetect/GridBoard.html" target="_top">Frames</a></li>
  352. <li><a href="GridBoard.html" target="_top">No&nbsp;Frames</a></li>
  353. </ul>
  354. <ul class="navList" id="allclasses_navbar_bottom">
  355. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  356. </ul>
  357. <div>
  358. <script type="text/javascript"><!--
  359. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  360. if(window==top) {
  361. allClassesLink.style.display = "block";
  362. }
  363. else {
  364. allClassesLink.style.display = "none";
  365. }
  366. //-->
  367. </script>
  368. </div>
  369. <div>
  370. <ul class="subNavList">
  371. <li>Summary:&nbsp;</li>
  372. <li>Nested&nbsp;|&nbsp;</li>
  373. <li>Field&nbsp;|&nbsp;</li>
  374. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  375. <li><a href="#method.summary">Method</a></li>
  376. </ul>
  377. <ul class="subNavList">
  378. <li>Detail:&nbsp;</li>
  379. <li>Field&nbsp;|&nbsp;</li>
  380. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  381. <li><a href="#method.detail">Method</a></li>
  382. </ul>
  383. </div>
  384. <a name="skip.navbar.bottom">
  385. <!-- -->
  386. </a></div>
  387. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  388. <p class="legalCopy"><small>Generated on 2023-06-28 12:47:21 / OpenCV 4.8.0</small></p>
  389. </body>
  390. </html>