TextDetectionModel.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376
  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:22 UTC 2023 -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. <title>TextDetectionModel (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="TextDetectionModel (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};
  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/dnn/SegmentationModel.html" title="class in org.opencv.dnn"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  62. <li><a href="../../../org/opencv/dnn/TextDetectionModel_DB.html" title="class in org.opencv.dnn"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  63. </ul>
  64. <ul class="navList">
  65. <li><a href="../../../index.html?org/opencv/dnn/TextDetectionModel.html" target="_top">Frames</a></li>
  66. <li><a href="TextDetectionModel.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.dnn</div>
  105. <h2 title="Class TextDetectionModel" class="title">Class TextDetectionModel</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/dnn/Model.html" title="class in org.opencv.dnn">org.opencv.dnn.Model</a></li>
  113. <li>
  114. <ul class="inheritance">
  115. <li>org.opencv.dnn.TextDetectionModel</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/dnn/TextDetectionModel_DB.html" title="class in org.opencv.dnn">TextDetectionModel_DB</a>, <a href="../../../org/opencv/dnn/TextDetectionModel_EAST.html" title="class in org.opencv.dnn">TextDetectionModel_EAST</a></dd>
  127. </dl>
  128. <hr>
  129. <br>
  130. <pre>public class <span class="typeNameLabel">TextDetectionModel</span>
  131. extends <a href="../../../org/opencv/dnn/Model.html" title="class in org.opencv.dnn">Model</a></pre>
  132. <div class="block">Base class for text detection networks</div>
  133. </li>
  134. </ul>
  135. </div>
  136. <div class="summary">
  137. <ul class="blockList">
  138. <li class="blockList">
  139. <!-- ========== METHOD SUMMARY =========== -->
  140. <ul class="blockList">
  141. <li class="blockList"><a name="method.summary">
  142. <!-- -->
  143. </a>
  144. <h3>Method Summary</h3>
  145. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  146. <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>
  147. <tr>
  148. <th class="colFirst" scope="col">Modifier and Type</th>
  149. <th class="colLast" scope="col">Method and Description</th>
  150. </tr>
  151. <tr id="i0" class="altColor">
  152. <td class="colFirst"><code>static <a href="../../../org/opencv/dnn/TextDetectionModel.html" title="class in org.opencv.dnn">TextDetectionModel</a></code></td>
  153. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/dnn/TextDetectionModel.html#Z:Z__fromPtr__-long-">__fromPtr__</a></span>(long&nbsp;addr)</code>&nbsp;</td>
  154. </tr>
  155. <tr id="i1" class="rowColor">
  156. <td class="colFirst"><code>void</code></td>
  157. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/dnn/TextDetectionModel.html#detect-org.opencv.core.Mat-java.util.List-">detect</a></span>(<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;frame,
  158. java.util.List&lt;<a href="../../../org/opencv/core/MatOfPoint.html" title="class in org.opencv.core">MatOfPoint</a>&gt;&nbsp;detections)</code>&nbsp;</td>
  159. </tr>
  160. <tr id="i2" class="altColor">
  161. <td class="colFirst"><code>void</code></td>
  162. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/dnn/TextDetectionModel.html#detect-org.opencv.core.Mat-java.util.List-org.opencv.core.MatOfFloat-">detect</a></span>(<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;frame,
  163. java.util.List&lt;<a href="../../../org/opencv/core/MatOfPoint.html" title="class in org.opencv.core">MatOfPoint</a>&gt;&nbsp;detections,
  164. <a href="../../../org/opencv/core/MatOfFloat.html" title="class in org.opencv.core">MatOfFloat</a>&nbsp;confidences)</code>
  165. <div class="block">Performs detection
  166. Given the input <code>frame</code>, prepare network input, run network inference, post-process network output and return result detections.</div>
  167. </td>
  168. </tr>
  169. <tr id="i3" class="rowColor">
  170. <td class="colFirst"><code>void</code></td>
  171. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/dnn/TextDetectionModel.html#detectTextRectangles-org.opencv.core.Mat-org.opencv.core.MatOfRotatedRect-">detectTextRectangles</a></span>(<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;frame,
  172. <a href="../../../org/opencv/core/MatOfRotatedRect.html" title="class in org.opencv.core">MatOfRotatedRect</a>&nbsp;detections)</code>&nbsp;</td>
  173. </tr>
  174. <tr id="i4" class="altColor">
  175. <td class="colFirst"><code>void</code></td>
  176. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/opencv/dnn/TextDetectionModel.html#detectTextRectangles-org.opencv.core.Mat-org.opencv.core.MatOfRotatedRect-org.opencv.core.MatOfFloat-">detectTextRectangles</a></span>(<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;frame,
  177. <a href="../../../org/opencv/core/MatOfRotatedRect.html" title="class in org.opencv.core">MatOfRotatedRect</a>&nbsp;detections,
  178. <a href="../../../org/opencv/core/MatOfFloat.html" title="class in org.opencv.core">MatOfFloat</a>&nbsp;confidences)</code>
  179. <div class="block">Performs detection
  180. Given the input <code>frame</code>, prepare network input, run network inference, post-process network output and return result detections.</div>
  181. </td>
  182. </tr>
  183. </table>
  184. <ul class="blockList">
  185. <li class="blockList"><a name="methods.inherited.from.class.org.opencv.dnn.Model">
  186. <!-- -->
  187. </a>
  188. <h3>Methods inherited from class&nbsp;org.opencv.dnn.<a href="../../../org/opencv/dnn/Model.html" title="class in org.opencv.dnn">Model</a></h3>
  189. <code><a href="../../../org/opencv/dnn/Model.html#getNativeObjAddr--">getNativeObjAddr</a>, <a href="../../../org/opencv/dnn/Model.html#predict-org.opencv.core.Mat-java.util.List-">predict</a>, <a href="../../../org/opencv/dnn/Model.html#setInputCrop-boolean-">setInputCrop</a>, <a href="../../../org/opencv/dnn/Model.html#setInputMean-org.opencv.core.Scalar-">setInputMean</a>, <a href="../../../org/opencv/dnn/Model.html#setInputParams--">setInputParams</a>, <a href="../../../org/opencv/dnn/Model.html#setInputParams-double-">setInputParams</a>, <a href="../../../org/opencv/dnn/Model.html#setInputParams-double-org.opencv.core.Size-">setInputParams</a>, <a href="../../../org/opencv/dnn/Model.html#setInputParams-double-org.opencv.core.Size-org.opencv.core.Scalar-">setInputParams</a>, <a href="../../../org/opencv/dnn/Model.html#setInputParams-double-org.opencv.core.Size-org.opencv.core.Scalar-boolean-">setInputParams</a>, <a href="../../../org/opencv/dnn/Model.html#setInputParams-double-org.opencv.core.Size-org.opencv.core.Scalar-boolean-boolean-">setInputParams</a>, <a href="../../../org/opencv/dnn/Model.html#setInputScale-org.opencv.core.Scalar-">setInputScale</a>, <a href="../../../org/opencv/dnn/Model.html#setInputSize-int-int-">setInputSize</a>, <a href="../../../org/opencv/dnn/Model.html#setInputSize-org.opencv.core.Size-">setInputSize</a>, <a href="../../../org/opencv/dnn/Model.html#setInputSwapRB-boolean-">setInputSwapRB</a>, <a href="../../../org/opencv/dnn/Model.html#setPreferableBackend-int-">setPreferableBackend</a>, <a href="../../../org/opencv/dnn/Model.html#setPreferableTarget-int-">setPreferableTarget</a></code></li>
  190. </ul>
  191. <ul class="blockList">
  192. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  193. <!-- -->
  194. </a>
  195. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  196. <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  197. </ul>
  198. </li>
  199. </ul>
  200. </li>
  201. </ul>
  202. </div>
  203. <div class="details">
  204. <ul class="blockList">
  205. <li class="blockList">
  206. <!-- ============ METHOD DETAIL ========== -->
  207. <ul class="blockList">
  208. <li class="blockList"><a name="method.detail">
  209. <!-- -->
  210. </a>
  211. <h3>Method Detail</h3>
  212. <a name="Z:Z__fromPtr__-long-">
  213. <!-- -->
  214. </a>
  215. <ul class="blockList">
  216. <li class="blockList">
  217. <h4>__fromPtr__</h4>
  218. <pre>public static&nbsp;<a href="../../../org/opencv/dnn/TextDetectionModel.html" title="class in org.opencv.dnn">TextDetectionModel</a>&nbsp;__fromPtr__(long&nbsp;addr)</pre>
  219. </li>
  220. </ul>
  221. <a name="detect-org.opencv.core.Mat-java.util.List-">
  222. <!-- -->
  223. </a>
  224. <ul class="blockList">
  225. <li class="blockList">
  226. <h4>detect</h4>
  227. <pre>public&nbsp;void&nbsp;detect(<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;frame,
  228. java.util.List&lt;<a href="../../../org/opencv/core/MatOfPoint.html" title="class in org.opencv.core">MatOfPoint</a>&gt;&nbsp;detections)</pre>
  229. </li>
  230. </ul>
  231. <a name="detect-org.opencv.core.Mat-java.util.List-org.opencv.core.MatOfFloat-">
  232. <!-- -->
  233. </a>
  234. <ul class="blockList">
  235. <li class="blockList">
  236. <h4>detect</h4>
  237. <pre>public&nbsp;void&nbsp;detect(<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;frame,
  238. java.util.List&lt;<a href="../../../org/opencv/core/MatOfPoint.html" title="class in org.opencv.core">MatOfPoint</a>&gt;&nbsp;detections,
  239. <a href="../../../org/opencv/core/MatOfFloat.html" title="class in org.opencv.core">MatOfFloat</a>&nbsp;confidences)</pre>
  240. <div class="block">Performs detection
  241. Given the input <code>frame</code>, prepare network input, run network inference, post-process network output and return result detections.
  242. Each result is quadrangle's 4 points in this order:
  243. - bottom-left
  244. - top-left
  245. - top-right
  246. - bottom-right
  247. Use cv::getPerspectiveTransform function to retrieve image region without perspective transformations.
  248. <b>Note:</b> If DL model doesn't support that kind of output then result may be derived from detectTextRectangles() output.</div>
  249. <dl>
  250. <dt><span class="paramLabel">Parameters:</span></dt>
  251. <dd><code>frame</code> - The input image</dd>
  252. <dd><code>detections</code> - array with detections' quadrangles (4 points per result)</dd>
  253. <dd><code>confidences</code> - array with detection confidences</dd>
  254. </dl>
  255. </li>
  256. </ul>
  257. <a name="detectTextRectangles-org.opencv.core.Mat-org.opencv.core.MatOfRotatedRect-">
  258. <!-- -->
  259. </a>
  260. <ul class="blockList">
  261. <li class="blockList">
  262. <h4>detectTextRectangles</h4>
  263. <pre>public&nbsp;void&nbsp;detectTextRectangles(<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;frame,
  264. <a href="../../../org/opencv/core/MatOfRotatedRect.html" title="class in org.opencv.core">MatOfRotatedRect</a>&nbsp;detections)</pre>
  265. </li>
  266. </ul>
  267. <a name="detectTextRectangles-org.opencv.core.Mat-org.opencv.core.MatOfRotatedRect-org.opencv.core.MatOfFloat-">
  268. <!-- -->
  269. </a>
  270. <ul class="blockListLast">
  271. <li class="blockList">
  272. <h4>detectTextRectangles</h4>
  273. <pre>public&nbsp;void&nbsp;detectTextRectangles(<a href="../../../org/opencv/core/Mat.html" title="class in org.opencv.core">Mat</a>&nbsp;frame,
  274. <a href="../../../org/opencv/core/MatOfRotatedRect.html" title="class in org.opencv.core">MatOfRotatedRect</a>&nbsp;detections,
  275. <a href="../../../org/opencv/core/MatOfFloat.html" title="class in org.opencv.core">MatOfFloat</a>&nbsp;confidences)</pre>
  276. <div class="block">Performs detection
  277. Given the input <code>frame</code>, prepare network input, run network inference, post-process network output and return result detections.
  278. Each result is rotated rectangle.
  279. <b>Note:</b> Result may be inaccurate in case of strong perspective transformations.</div>
  280. <dl>
  281. <dt><span class="paramLabel">Parameters:</span></dt>
  282. <dd><code>frame</code> - the input image</dd>
  283. <dd><code>detections</code> - array with detections' RotationRect results</dd>
  284. <dd><code>confidences</code> - array with detection confidences</dd>
  285. </dl>
  286. </li>
  287. </ul>
  288. </li>
  289. </ul>
  290. </li>
  291. </ul>
  292. </div>
  293. </div>
  294. <!-- ========= END OF CLASS DATA ========= -->
  295. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  296. <div class="bottomNav"><a name="navbar.bottom">
  297. <!-- -->
  298. </a>
  299. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  300. <a name="navbar.bottom.firstrow">
  301. <!-- -->
  302. </a>
  303. <ul class="navList" title="Navigation">
  304. <li><a href="../../../overview-summary.html">Overview</a></li>
  305. <li><a href="package-summary.html">Package</a></li>
  306. <li class="navBarCell1Rev">Class</li>
  307. <li><a href="package-tree.html">Tree</a></li>
  308. <li><a href="../../../index-all.html">Index</a></li>
  309. <li><a href="../../../help-doc.html">Help</a></li>
  310. </ul>
  311. <div class="aboutLanguage">
  312. <script>
  313. var url = window.location.href;
  314. var pos = url.lastIndexOf('/javadoc/');
  315. url = pos >= 0 ? (url.substring(0, pos) + '/javadoc/mymath.js') : (window.location.origin + '/mymath.js');
  316. var script = document.createElement('script');
  317. script.src = 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML,' + url;
  318. document.getElementsByTagName('head')[0].appendChild(script);
  319. </script>
  320. </div>
  321. </div>
  322. <div class="subNav">
  323. <ul class="navList">
  324. <li><a href="../../../org/opencv/dnn/SegmentationModel.html" title="class in org.opencv.dnn"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  325. <li><a href="../../../org/opencv/dnn/TextDetectionModel_DB.html" title="class in org.opencv.dnn"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  326. </ul>
  327. <ul class="navList">
  328. <li><a href="../../../index.html?org/opencv/dnn/TextDetectionModel.html" target="_top">Frames</a></li>
  329. <li><a href="TextDetectionModel.html" target="_top">No&nbsp;Frames</a></li>
  330. </ul>
  331. <ul class="navList" id="allclasses_navbar_bottom">
  332. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  333. </ul>
  334. <div>
  335. <script type="text/javascript"><!--
  336. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  337. if(window==top) {
  338. allClassesLink.style.display = "block";
  339. }
  340. else {
  341. allClassesLink.style.display = "none";
  342. }
  343. //-->
  344. </script>
  345. </div>
  346. <div>
  347. <ul class="subNavList">
  348. <li>Summary:&nbsp;</li>
  349. <li>Nested&nbsp;|&nbsp;</li>
  350. <li>Field&nbsp;|&nbsp;</li>
  351. <li>Constr&nbsp;|&nbsp;</li>
  352. <li><a href="#method.summary">Method</a></li>
  353. </ul>
  354. <ul class="subNavList">
  355. <li>Detail:&nbsp;</li>
  356. <li>Field&nbsp;|&nbsp;</li>
  357. <li>Constr&nbsp;|&nbsp;</li>
  358. <li><a href="#method.detail">Method</a></li>
  359. </ul>
  360. </div>
  361. <a name="skip.navbar.bottom">
  362. <!-- -->
  363. </a></div>
  364. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  365. <p class="legalCopy"><small>Generated on 2023-06-28 12:47:21 / OpenCV 4.8.0</small></p>
  366. </body>
  367. </html>