chillerlan-QRCode-Detector-FinderPattern.html 57 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/template.js"></script>
  22. <script src="js/search.js"></script>
  23. <script defer src="js/searchIndex.js"></script>
  24. </head>
  25. <body id="top">
  26. <header class="phpdocumentor-header phpdocumentor-section">
  27. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  28. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  29. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  30. <i class="fas fa-bars"></i>
  31. </label>
  32. <section data-search-form class="phpdocumentor-search">
  33. <label>
  34. <span class="visually-hidden">Search for</span>
  35. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  36. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  37. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  38. </svg>
  39. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  40. </label>
  41. </section>
  42. <nav class="phpdocumentor-topnav">
  43. <ul class="phpdocumentor-topnav__menu">
  44. <li class="phpdocumentor-topnav__menu-item -menu">
  45. <a href="https://php-qrcode.readthedocs.io">
  46. <span>
  47. User Manual
  48. </span>
  49. </a>
  50. </li>
  51. <li class="phpdocumentor-topnav__menu-item -social">
  52. <a href="https://github.com/chillerlan/php-qrcode">
  53. <span>
  54. <i class="fab fa-github"></i>
  55. </span>
  56. </a>
  57. </li>
  58. <li class="phpdocumentor-topnav__menu-item -social">
  59. <a href="https://github.com/chillerlan/php-qrcode/discussions">
  60. <span>
  61. <i class="fas fa-envelope-open-text"></i>
  62. </span>
  63. </a>
  64. </li>
  65. </ul>
  66. </nav>
  67. </header>
  68. <main class="phpdocumentor">
  69. <div class="phpdocumentor-section">
  70. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  71. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  72. Menu
  73. </label>
  74. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  75. <section class="phpdocumentor-sidebar__category -namespaces">
  76. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  77. <h4 class="phpdocumentor-sidebar__root-namespace">
  78. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  79. </h4>
  80. <ul class="phpdocumentor-list">
  81. <li>
  82. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  83. </li>
  84. <li>
  85. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  86. </li>
  87. </ul>
  88. </section>
  89. <section class="phpdocumentor-sidebar__category -packages">
  90. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  91. <h4 class="phpdocumentor-sidebar__root-namespace">
  92. <a href="packages/Application.html" class="">Application</a>
  93. </h4>
  94. </section>
  95. <section class="phpdocumentor-sidebar__category -reports">
  96. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  97. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  98. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  99. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  100. </section>
  101. <section class="phpdocumentor-sidebar__category -indices">
  102. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  103. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  104. </section>
  105. </aside>
  106. <div class="phpdocumentor-column -nine phpdocumentor-content">
  107. <section>
  108. <ul class="phpdocumentor-breadcrumbs">
  109. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  110. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  111. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-detector.html">Detector</a></li>
  112. </ul>
  113. <article class="phpdocumentor-element -class">
  114. <h2 class="phpdocumentor-content__title">
  115. FinderPattern
  116. <span class="phpdocumentor-element__extends">
  117. extends <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html"><abbr title="\chillerlan\QRCode\Detector\ResultPoint">ResultPoint</abbr></a>
  118. </span>
  119. <div class="phpdocumentor-element__package">
  120. in package
  121. <ul class="phpdocumentor-breadcrumbs">
  122. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  123. </ul>
  124. </div>
  125. </h2>
  126. <div class="phpdocumentor-label-line">
  127. <div class="phpdocumentor-label phpdocumentor-label--success"><span>Final</span><span>Yes</span></div>
  128. </div>
  129. <aside class="phpdocumentor-element-found-in">
  130. <abbr class="phpdocumentor-element-found-in__file" title="src/Detector/FinderPattern.php"><a href="files/src-detector-finderpattern.html"><abbr title="src/Detector/FinderPattern.php">FinderPattern.php</abbr></a></abbr>
  131. :
  132. <span class="phpdocumentor-element-found-in__line">24</span>
  133. </aside>
  134. <p class="phpdocumentor-summary">Encapsulates a finder pattern, which are the three square patterns found in
  135. the corners of QR Codes. It also encapsulates a count of similar finder patterns,
  136. as a convenience to the finder&#039;s bookkeeping.</p>
  137. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  138. Tags
  139. <a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
  140. </h5>
  141. <dl class="phpdocumentor-tag-list">
  142. <dt class="phpdocumentor-tag-list__entry">
  143. <span class="phpdocumentor-tag__name">author</span>
  144. </dt>
  145. <dd class="phpdocumentor-tag-list__definition">
  146. <section class="phpdocumentor-description"><p>Sean Owen</p>
  147. </section>
  148. </dd>
  149. </dl>
  150. <h3 id="toc">
  151. Table of Contents
  152. <a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  153. </h3>
  154. <h4 id="toc-properties">
  155. Properties
  156. <a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  157. </h4>
  158. <dl class="phpdocumentor-table-of-contents">
  159. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  160. <a class="" href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_estimatedModuleSize">$estimatedModuleSize</a>
  161. <span>
  162. &nbsp;: float </span>
  163. </dt>
  164. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  165. <a class="" href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_x">$x</a>
  166. <span>
  167. &nbsp;: float </span>
  168. </dt>
  169. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  170. <a class="" href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_y">$y</a>
  171. <span>
  172. &nbsp;: float </span>
  173. </dt>
  174. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  175. <a class="" href="classes/chillerlan-QRCode-Detector-FinderPattern.html#property_count">$count</a>
  176. <span>
  177. &nbsp;: int </span>
  178. </dt>
  179. </dl>
  180. <h4 id="toc-methods">
  181. Methods
  182. <a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  183. </h4>
  184. <dl class="phpdocumentor-table-of-contents">
  185. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  186. <a class="" href="classes/chillerlan-QRCode-Detector-FinderPattern.html#method___construct">__construct()</a>
  187. <span>
  188. &nbsp;: mixed </span>
  189. </dt>
  190. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  191. <a class="" href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_aboutEquals">aboutEquals()</a>
  192. <span>
  193. &nbsp;: bool </span>
  194. </dt>
  195. <dd>Determines if this finder pattern &quot;about equals&quot; a finder pattern at the stated
  196. position and size -- meaning, it is at nearly the same center with nearly the same size.</dd>
  197. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  198. <a class="" href="classes/chillerlan-QRCode-Detector-FinderPattern.html#method_combineEstimate">combineEstimate()</a>
  199. <span>
  200. &nbsp;: static </span>
  201. </dt>
  202. <dd>Combines this object&#039;s current estimate of a finder pattern position and module size
  203. with a new estimate. It returns a new FinderPattern containing a weighted average
  204. based on count.</dd>
  205. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  206. <a class="" href="classes/chillerlan-QRCode-Detector-FinderPattern.html#method_distance">distance()</a>
  207. <span>
  208. &nbsp;: float </span>
  209. </dt>
  210. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  211. <a class="" href="classes/chillerlan-QRCode-Detector-FinderPattern.html#method_getCount">getCount()</a>
  212. <span>
  213. &nbsp;: int </span>
  214. </dt>
  215. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  216. <a class="" href="classes/chillerlan-QRCode-Detector-FinderPattern.html#method_getDistance">getDistance()</a>
  217. <span>
  218. &nbsp;: float </span>
  219. </dt>
  220. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  221. <a class="" href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getEstimatedModuleSize">getEstimatedModuleSize()</a>
  222. <span>
  223. &nbsp;: float </span>
  224. </dt>
  225. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  226. <a class="" href="classes/chillerlan-QRCode-Detector-FinderPattern.html#method_getSquaredDistance">getSquaredDistance()</a>
  227. <span>
  228. &nbsp;: float </span>
  229. </dt>
  230. <dd>Get square of distance between a and b.</dd>
  231. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  232. <a class="" href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getX">getX()</a>
  233. <span>
  234. &nbsp;: float </span>
  235. </dt>
  236. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  237. <a class="" href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getY">getY()</a>
  238. <span>
  239. &nbsp;: float </span>
  240. </dt>
  241. <dt class="phpdocumentor-table-of-contents__entry -method -private">
  242. <a class="" href="classes/chillerlan-QRCode-Detector-FinderPattern.html#method_squaredDistance">squaredDistance()</a>
  243. <span>
  244. &nbsp;: float </span>
  245. </dt>
  246. </dl>
  247. <section class="phpdocumentor-properties">
  248. <h3 class="phpdocumentor-elements__header" id="properties">
  249. Properties
  250. <a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  251. </h3>
  252. <article
  253. class="
  254. phpdocumentor-element
  255. -property
  256. -protected
  257. "
  258. >
  259. <h4 class="phpdocumentor-element__name" id="property_estimatedModuleSize">
  260. $estimatedModuleSize
  261. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_estimatedModuleSize" class="headerlink"><i class="fas fa-link"></i></a>
  262. <span class="phpdocumentor-element__modifiers">
  263. </span>
  264. </h4>
  265. <aside class="phpdocumentor-element-found-in">
  266. <abbr class="phpdocumentor-element-found-in__file" title="src/Detector/ResultPoint.php"><a href="files/src-detector-resultpoint.html"><abbr title="src/Detector/ResultPoint.php">ResultPoint.php</abbr></a></abbr>
  267. :
  268. <span class="phpdocumentor-element-found-in__line">27</span>
  269. </aside>
  270. <code class="phpdocumentor-code phpdocumentor-signature ">
  271. <span class="phpdocumentor-signature__visibility">protected</span>
  272. <span class="phpdocumentor-signature__type">float</span>
  273. <span class="phpdocumentor-signature__name">$estimatedModuleSize</span>
  274. </code>
  275. </article>
  276. <article
  277. class="
  278. phpdocumentor-element
  279. -property
  280. -protected
  281. "
  282. >
  283. <h4 class="phpdocumentor-element__name" id="property_x">
  284. $x
  285. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_x" class="headerlink"><i class="fas fa-link"></i></a>
  286. <span class="phpdocumentor-element__modifiers">
  287. </span>
  288. </h4>
  289. <aside class="phpdocumentor-element-found-in">
  290. <abbr class="phpdocumentor-element-found-in__file" title="src/Detector/ResultPoint.php"><a href="files/src-detector-resultpoint.html"><abbr title="src/Detector/ResultPoint.php">ResultPoint.php</abbr></a></abbr>
  291. :
  292. <span class="phpdocumentor-element-found-in__line">25</span>
  293. </aside>
  294. <code class="phpdocumentor-code phpdocumentor-signature ">
  295. <span class="phpdocumentor-signature__visibility">protected</span>
  296. <span class="phpdocumentor-signature__type">float</span>
  297. <span class="phpdocumentor-signature__name">$x</span>
  298. </code>
  299. </article>
  300. <article
  301. class="
  302. phpdocumentor-element
  303. -property
  304. -protected
  305. "
  306. >
  307. <h4 class="phpdocumentor-element__name" id="property_y">
  308. $y
  309. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_y" class="headerlink"><i class="fas fa-link"></i></a>
  310. <span class="phpdocumentor-element__modifiers">
  311. </span>
  312. </h4>
  313. <aside class="phpdocumentor-element-found-in">
  314. <abbr class="phpdocumentor-element-found-in__file" title="src/Detector/ResultPoint.php"><a href="files/src-detector-resultpoint.html"><abbr title="src/Detector/ResultPoint.php">ResultPoint.php</abbr></a></abbr>
  315. :
  316. <span class="phpdocumentor-element-found-in__line">26</span>
  317. </aside>
  318. <code class="phpdocumentor-code phpdocumentor-signature ">
  319. <span class="phpdocumentor-signature__visibility">protected</span>
  320. <span class="phpdocumentor-signature__type">float</span>
  321. <span class="phpdocumentor-signature__name">$y</span>
  322. </code>
  323. </article>
  324. <article
  325. class="
  326. phpdocumentor-element
  327. -property
  328. -private
  329. "
  330. >
  331. <h4 class="phpdocumentor-element__name" id="property_count">
  332. $count
  333. <a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#property_count" class="headerlink"><i class="fas fa-link"></i></a>
  334. <span class="phpdocumentor-element__modifiers">
  335. </span>
  336. </h4>
  337. <aside class="phpdocumentor-element-found-in">
  338. <abbr class="phpdocumentor-element-found-in__file" title="src/Detector/FinderPattern.php"><a href="files/src-detector-finderpattern.html"><abbr title="src/Detector/FinderPattern.php">FinderPattern.php</abbr></a></abbr>
  339. :
  340. <span class="phpdocumentor-element-found-in__line">26</span>
  341. </aside>
  342. <code class="phpdocumentor-code phpdocumentor-signature ">
  343. <span class="phpdocumentor-signature__visibility">private</span>
  344. <span class="phpdocumentor-signature__type">int</span>
  345. <span class="phpdocumentor-signature__name">$count</span>
  346. </code>
  347. </article>
  348. </section>
  349. <section class="phpdocumentor-methods">
  350. <h3 class="phpdocumentor-elements__header" id="methods">
  351. Methods
  352. <a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  353. </h3>
  354. <article
  355. class="phpdocumentor-element
  356. -method
  357. -public
  358. "
  359. >
  360. <h4 class="phpdocumentor-element__name" id="method___construct">
  361. __construct()
  362. <a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  363. </h4>
  364. <aside class="phpdocumentor-element-found-in">
  365. <abbr class="phpdocumentor-element-found-in__file" title="src/Detector/FinderPattern.php"><a href="files/src-detector-finderpattern.html"><abbr title="src/Detector/FinderPattern.php">FinderPattern.php</abbr></a></abbr>
  366. :
  367. <span class="phpdocumentor-element-found-in__line">28</span>
  368. </aside>
  369. <code class="phpdocumentor-code phpdocumentor-signature ">
  370. <span class="phpdocumentor-signature__visibility">public</span>
  371. <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">float&nbsp;</span><span class="phpdocumentor-signature__argument__name">$posX</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">float&nbsp;</span><span class="phpdocumentor-signature__argument__name">$posY</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">float&nbsp;</span><span class="phpdocumentor-signature__argument__name">$estimatedModuleSize</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$count</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  372. <div class="phpdocumentor-label-line">
  373. </div>
  374. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  375. <dl class="phpdocumentor-argument-list">
  376. <dt class="phpdocumentor-argument-list__entry">
  377. <span class="phpdocumentor-signature__argument__name">$posX</span>
  378. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  379. </dt>
  380. <dd class="phpdocumentor-argument-list__definition">
  381. </dd>
  382. <dt class="phpdocumentor-argument-list__entry">
  383. <span class="phpdocumentor-signature__argument__name">$posY</span>
  384. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  385. </dt>
  386. <dd class="phpdocumentor-argument-list__definition">
  387. </dd>
  388. <dt class="phpdocumentor-argument-list__entry">
  389. <span class="phpdocumentor-signature__argument__name">$estimatedModuleSize</span>
  390. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  391. </dt>
  392. <dd class="phpdocumentor-argument-list__definition">
  393. </dd>
  394. <dt class="phpdocumentor-argument-list__entry">
  395. <span class="phpdocumentor-signature__argument__name">$count</span>
  396. : <span class="phpdocumentor-signature__argument__return-type">int|null</span>
  397. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  398. <dd class="phpdocumentor-argument-list__definition">
  399. </dd>
  400. </dl>
  401. </article>
  402. <article
  403. class="phpdocumentor-element
  404. -method
  405. -public
  406. "
  407. >
  408. <h4 class="phpdocumentor-element__name" id="method_aboutEquals">
  409. aboutEquals()
  410. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_aboutEquals" class="headerlink"><i class="fas fa-link"></i></a>
  411. </h4>
  412. <aside class="phpdocumentor-element-found-in">
  413. <abbr class="phpdocumentor-element-found-in__file" title="src/Detector/ResultPoint.php"><a href="files/src-detector-resultpoint.html"><abbr title="src/Detector/ResultPoint.php">ResultPoint.php</abbr></a></abbr>
  414. :
  415. <span class="phpdocumentor-element-found-in__line">51</span>
  416. </aside>
  417. <p class="phpdocumentor-summary">Determines if this finder pattern &quot;about equals&quot; a finder pattern at the stated
  418. position and size -- meaning, it is at nearly the same center with nearly the same size.</p>
  419. <code class="phpdocumentor-code phpdocumentor-signature ">
  420. <span class="phpdocumentor-signature__visibility">public</span>
  421. <span class="phpdocumentor-signature__name">aboutEquals</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">float&nbsp;</span><span class="phpdocumentor-signature__argument__name">$moduleSize</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">float&nbsp;</span><span class="phpdocumentor-signature__argument__name">$i</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">float&nbsp;</span><span class="phpdocumentor-signature__argument__name">$j</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  422. <div class="phpdocumentor-label-line">
  423. </div>
  424. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  425. <dl class="phpdocumentor-argument-list">
  426. <dt class="phpdocumentor-argument-list__entry">
  427. <span class="phpdocumentor-signature__argument__name">$moduleSize</span>
  428. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  429. </dt>
  430. <dd class="phpdocumentor-argument-list__definition">
  431. </dd>
  432. <dt class="phpdocumentor-argument-list__entry">
  433. <span class="phpdocumentor-signature__argument__name">$i</span>
  434. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  435. </dt>
  436. <dd class="phpdocumentor-argument-list__definition">
  437. </dd>
  438. <dt class="phpdocumentor-argument-list__entry">
  439. <span class="phpdocumentor-signature__argument__name">$j</span>
  440. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  441. </dt>
  442. <dd class="phpdocumentor-argument-list__definition">
  443. </dd>
  444. </dl>
  445. <section>
  446. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  447. <span class="phpdocumentor-signature__response_type">bool</span>
  448. </section>
  449. </article>
  450. <article
  451. class="phpdocumentor-element
  452. -method
  453. -public
  454. "
  455. >
  456. <h4 class="phpdocumentor-element__name" id="method_combineEstimate">
  457. combineEstimate()
  458. <a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#method_combineEstimate" class="headerlink"><i class="fas fa-link"></i></a>
  459. </h4>
  460. <aside class="phpdocumentor-element-found-in">
  461. <abbr class="phpdocumentor-element-found-in__file" title="src/Detector/FinderPattern.php"><a href="files/src-detector-finderpattern.html"><abbr title="src/Detector/FinderPattern.php">FinderPattern.php</abbr></a></abbr>
  462. :
  463. <span class="phpdocumentor-element-found-in__line">59</span>
  464. </aside>
  465. <p class="phpdocumentor-summary">Combines this object&#039;s current estimate of a finder pattern position and module size
  466. with a new estimate. It returns a new FinderPattern containing a weighted average
  467. based on count.</p>
  468. <code class="phpdocumentor-code phpdocumentor-signature ">
  469. <span class="phpdocumentor-signature__visibility">public</span>
  470. <span class="phpdocumentor-signature__name">combineEstimate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">float&nbsp;</span><span class="phpdocumentor-signature__argument__name">$i</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">float&nbsp;</span><span class="phpdocumentor-signature__argument__name">$j</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">float&nbsp;</span><span class="phpdocumentor-signature__argument__name">$newModuleSize</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  471. <div class="phpdocumentor-label-line">
  472. </div>
  473. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  474. <dl class="phpdocumentor-argument-list">
  475. <dt class="phpdocumentor-argument-list__entry">
  476. <span class="phpdocumentor-signature__argument__name">$i</span>
  477. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  478. </dt>
  479. <dd class="phpdocumentor-argument-list__definition">
  480. </dd>
  481. <dt class="phpdocumentor-argument-list__entry">
  482. <span class="phpdocumentor-signature__argument__name">$j</span>
  483. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  484. </dt>
  485. <dd class="phpdocumentor-argument-list__definition">
  486. </dd>
  487. <dt class="phpdocumentor-argument-list__entry">
  488. <span class="phpdocumentor-signature__argument__name">$newModuleSize</span>
  489. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  490. </dt>
  491. <dd class="phpdocumentor-argument-list__definition">
  492. </dd>
  493. </dl>
  494. <section>
  495. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  496. <span class="phpdocumentor-signature__response_type">static</span>
  497. </section>
  498. </article>
  499. <article
  500. class="phpdocumentor-element
  501. -method
  502. -public
  503. -static "
  504. >
  505. <h4 class="phpdocumentor-element__name" id="method_distance">
  506. distance()
  507. <a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#method_distance" class="headerlink"><i class="fas fa-link"></i></a>
  508. </h4>
  509. <aside class="phpdocumentor-element-found-in">
  510. <abbr class="phpdocumentor-element-found-in__file" title="src/Detector/FinderPattern.php"><a href="files/src-detector-finderpattern.html"><abbr title="src/Detector/FinderPattern.php">FinderPattern.php</abbr></a></abbr>
  511. :
  512. <span class="phpdocumentor-element-found-in__line">77</span>
  513. </aside>
  514. <code class="phpdocumentor-code phpdocumentor-signature ">
  515. <span class="phpdocumentor-signature__visibility">public</span>
  516. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">distance</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">float&nbsp;</span><span class="phpdocumentor-signature__argument__name">$aX</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">float&nbsp;</span><span class="phpdocumentor-signature__argument__name">$aY</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">float&nbsp;</span><span class="phpdocumentor-signature__argument__name">$bX</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">float&nbsp;</span><span class="phpdocumentor-signature__argument__name">$bY</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">float</span></code>
  517. <div class="phpdocumentor-label-line">
  518. </div>
  519. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  520. <dl class="phpdocumentor-argument-list">
  521. <dt class="phpdocumentor-argument-list__entry">
  522. <span class="phpdocumentor-signature__argument__name">$aX</span>
  523. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  524. </dt>
  525. <dd class="phpdocumentor-argument-list__definition">
  526. </dd>
  527. <dt class="phpdocumentor-argument-list__entry">
  528. <span class="phpdocumentor-signature__argument__name">$aY</span>
  529. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  530. </dt>
  531. <dd class="phpdocumentor-argument-list__definition">
  532. </dd>
  533. <dt class="phpdocumentor-argument-list__entry">
  534. <span class="phpdocumentor-signature__argument__name">$bX</span>
  535. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  536. </dt>
  537. <dd class="phpdocumentor-argument-list__definition">
  538. </dd>
  539. <dt class="phpdocumentor-argument-list__entry">
  540. <span class="phpdocumentor-signature__argument__name">$bY</span>
  541. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  542. </dt>
  543. <dd class="phpdocumentor-argument-list__definition">
  544. </dd>
  545. </dl>
  546. <section>
  547. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  548. <span class="phpdocumentor-signature__response_type">float</span>
  549. </section>
  550. </article>
  551. <article
  552. class="phpdocumentor-element
  553. -method
  554. -public
  555. "
  556. >
  557. <h4 class="phpdocumentor-element__name" id="method_getCount">
  558. getCount()
  559. <a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#method_getCount" class="headerlink"><i class="fas fa-link"></i></a>
  560. </h4>
  561. <aside class="phpdocumentor-element-found-in">
  562. <abbr class="phpdocumentor-element-found-in__file" title="src/Detector/FinderPattern.php"><a href="files/src-detector-finderpattern.html"><abbr title="src/Detector/FinderPattern.php">FinderPattern.php</abbr></a></abbr>
  563. :
  564. <span class="phpdocumentor-element-found-in__line">34</span>
  565. </aside>
  566. <code class="phpdocumentor-code phpdocumentor-signature ">
  567. <span class="phpdocumentor-signature__visibility">public</span>
  568. <span class="phpdocumentor-signature__name">getCount</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  569. <div class="phpdocumentor-label-line">
  570. </div>
  571. <section>
  572. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  573. <span class="phpdocumentor-signature__response_type">int</span>
  574. </section>
  575. </article>
  576. <article
  577. class="phpdocumentor-element
  578. -method
  579. -public
  580. "
  581. >
  582. <h4 class="phpdocumentor-element__name" id="method_getDistance">
  583. getDistance()
  584. <a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#method_getDistance" class="headerlink"><i class="fas fa-link"></i></a>
  585. </h4>
  586. <aside class="phpdocumentor-element-found-in">
  587. <abbr class="phpdocumentor-element-found-in__file" title="src/Detector/FinderPattern.php"><a href="files/src-detector-finderpattern.html"><abbr title="src/Detector/FinderPattern.php">FinderPattern.php</abbr></a></abbr>
  588. :
  589. <span class="phpdocumentor-element-found-in__line">43</span>
  590. </aside>
  591. <code class="phpdocumentor-code phpdocumentor-signature ">
  592. <span class="phpdocumentor-signature__visibility">public</span>
  593. <span class="phpdocumentor-signature__name">getDistance</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Detector-FinderPattern.html"><abbr title="\chillerlan\QRCode\Detector\FinderPattern">FinderPattern</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$b</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">float</span></code>
  594. <div class="phpdocumentor-label-line">
  595. </div>
  596. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  597. <dl class="phpdocumentor-argument-list">
  598. <dt class="phpdocumentor-argument-list__entry">
  599. <span class="phpdocumentor-signature__argument__name">$b</span>
  600. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Detector-FinderPattern.html"><abbr title="\chillerlan\QRCode\Detector\FinderPattern">FinderPattern</abbr></a></span>
  601. </dt>
  602. <dd class="phpdocumentor-argument-list__definition">
  603. <section class="phpdocumentor-description"><p>second pattern</p>
  604. </section>
  605. </dd>
  606. </dl>
  607. <section>
  608. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  609. <span class="phpdocumentor-signature__response_type">float</span>
  610. &mdash;
  611. <section class="phpdocumentor-description"><p>distance between two points</p>
  612. </section>
  613. </section>
  614. </article>
  615. <article
  616. class="phpdocumentor-element
  617. -method
  618. -public
  619. "
  620. >
  621. <h4 class="phpdocumentor-element__name" id="method_getEstimatedModuleSize">
  622. getEstimatedModuleSize()
  623. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getEstimatedModuleSize" class="headerlink"><i class="fas fa-link"></i></a>
  624. </h4>
  625. <aside class="phpdocumentor-element-found-in">
  626. <abbr class="phpdocumentor-element-found-in__file" title="src/Detector/ResultPoint.php"><a href="files/src-detector-resultpoint.html"><abbr title="src/Detector/ResultPoint.php">ResultPoint.php</abbr></a></abbr>
  627. :
  628. <span class="phpdocumentor-element-found-in__line">43</span>
  629. </aside>
  630. <code class="phpdocumentor-code phpdocumentor-signature ">
  631. <span class="phpdocumentor-signature__visibility">public</span>
  632. <span class="phpdocumentor-signature__name">getEstimatedModuleSize</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">float</span></code>
  633. <div class="phpdocumentor-label-line">
  634. </div>
  635. <section>
  636. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  637. <span class="phpdocumentor-signature__response_type">float</span>
  638. </section>
  639. </article>
  640. <article
  641. class="phpdocumentor-element
  642. -method
  643. -public
  644. "
  645. >
  646. <h4 class="phpdocumentor-element__name" id="method_getSquaredDistance">
  647. getSquaredDistance()
  648. <a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#method_getSquaredDistance" class="headerlink"><i class="fas fa-link"></i></a>
  649. </h4>
  650. <aside class="phpdocumentor-element-found-in">
  651. <abbr class="phpdocumentor-element-found-in__file" title="src/Detector/FinderPattern.php"><a href="files/src-detector-finderpattern.html"><abbr title="src/Detector/FinderPattern.php">FinderPattern.php</abbr></a></abbr>
  652. :
  653. <span class="phpdocumentor-element-found-in__line">50</span>
  654. </aside>
  655. <p class="phpdocumentor-summary">Get square of distance between a and b.</p>
  656. <code class="phpdocumentor-code phpdocumentor-signature ">
  657. <span class="phpdocumentor-signature__visibility">public</span>
  658. <span class="phpdocumentor-signature__name">getSquaredDistance</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Detector-FinderPattern.html"><abbr title="\chillerlan\QRCode\Detector\FinderPattern">FinderPattern</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$b</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">float</span></code>
  659. <div class="phpdocumentor-label-line">
  660. </div>
  661. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  662. <dl class="phpdocumentor-argument-list">
  663. <dt class="phpdocumentor-argument-list__entry">
  664. <span class="phpdocumentor-signature__argument__name">$b</span>
  665. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Detector-FinderPattern.html"><abbr title="\chillerlan\QRCode\Detector\FinderPattern">FinderPattern</abbr></a></span>
  666. </dt>
  667. <dd class="phpdocumentor-argument-list__definition">
  668. </dd>
  669. </dl>
  670. <section>
  671. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  672. <span class="phpdocumentor-signature__response_type">float</span>
  673. </section>
  674. </article>
  675. <article
  676. class="phpdocumentor-element
  677. -method
  678. -public
  679. "
  680. >
  681. <h4 class="phpdocumentor-element__name" id="method_getX">
  682. getX()
  683. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getX" class="headerlink"><i class="fas fa-link"></i></a>
  684. </h4>
  685. <aside class="phpdocumentor-element-found-in">
  686. <abbr class="phpdocumentor-element-found-in__file" title="src/Detector/ResultPoint.php"><a href="files/src-detector-resultpoint.html"><abbr title="src/Detector/ResultPoint.php">ResultPoint.php</abbr></a></abbr>
  687. :
  688. <span class="phpdocumentor-element-found-in__line">35</span>
  689. </aside>
  690. <code class="phpdocumentor-code phpdocumentor-signature ">
  691. <span class="phpdocumentor-signature__visibility">public</span>
  692. <span class="phpdocumentor-signature__name">getX</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">float</span></code>
  693. <div class="phpdocumentor-label-line">
  694. </div>
  695. <section>
  696. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  697. <span class="phpdocumentor-signature__response_type">float</span>
  698. </section>
  699. </article>
  700. <article
  701. class="phpdocumentor-element
  702. -method
  703. -public
  704. "
  705. >
  706. <h4 class="phpdocumentor-element__name" id="method_getY">
  707. getY()
  708. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getY" class="headerlink"><i class="fas fa-link"></i></a>
  709. </h4>
  710. <aside class="phpdocumentor-element-found-in">
  711. <abbr class="phpdocumentor-element-found-in__file" title="src/Detector/ResultPoint.php"><a href="files/src-detector-resultpoint.html"><abbr title="src/Detector/ResultPoint.php">ResultPoint.php</abbr></a></abbr>
  712. :
  713. <span class="phpdocumentor-element-found-in__line">39</span>
  714. </aside>
  715. <code class="phpdocumentor-code phpdocumentor-signature ">
  716. <span class="phpdocumentor-signature__visibility">public</span>
  717. <span class="phpdocumentor-signature__name">getY</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">float</span></code>
  718. <div class="phpdocumentor-label-line">
  719. </div>
  720. <section>
  721. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  722. <span class="phpdocumentor-signature__response_type">float</span>
  723. </section>
  724. </article>
  725. <article
  726. class="phpdocumentor-element
  727. -method
  728. -private
  729. -static "
  730. >
  731. <h4 class="phpdocumentor-element__name" id="method_squaredDistance">
  732. squaredDistance()
  733. <a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#method_squaredDistance" class="headerlink"><i class="fas fa-link"></i></a>
  734. </h4>
  735. <aside class="phpdocumentor-element-found-in">
  736. <abbr class="phpdocumentor-element-found-in__file" title="src/Detector/FinderPattern.php"><a href="files/src-detector-finderpattern.html"><abbr title="src/Detector/FinderPattern.php">FinderPattern.php</abbr></a></abbr>
  737. :
  738. <span class="phpdocumentor-element-found-in__line">70</span>
  739. </aside>
  740. <code class="phpdocumentor-code phpdocumentor-signature ">
  741. <span class="phpdocumentor-signature__visibility">private</span>
  742. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">squaredDistance</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">float&nbsp;</span><span class="phpdocumentor-signature__argument__name">$aX</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">float&nbsp;</span><span class="phpdocumentor-signature__argument__name">$aY</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">float&nbsp;</span><span class="phpdocumentor-signature__argument__name">$bX</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">float&nbsp;</span><span class="phpdocumentor-signature__argument__name">$bY</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">float</span></code>
  743. <div class="phpdocumentor-label-line">
  744. </div>
  745. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  746. <dl class="phpdocumentor-argument-list">
  747. <dt class="phpdocumentor-argument-list__entry">
  748. <span class="phpdocumentor-signature__argument__name">$aX</span>
  749. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  750. </dt>
  751. <dd class="phpdocumentor-argument-list__definition">
  752. </dd>
  753. <dt class="phpdocumentor-argument-list__entry">
  754. <span class="phpdocumentor-signature__argument__name">$aY</span>
  755. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  756. </dt>
  757. <dd class="phpdocumentor-argument-list__definition">
  758. </dd>
  759. <dt class="phpdocumentor-argument-list__entry">
  760. <span class="phpdocumentor-signature__argument__name">$bX</span>
  761. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  762. </dt>
  763. <dd class="phpdocumentor-argument-list__definition">
  764. </dd>
  765. <dt class="phpdocumentor-argument-list__entry">
  766. <span class="phpdocumentor-signature__argument__name">$bY</span>
  767. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  768. </dt>
  769. <dd class="phpdocumentor-argument-list__definition">
  770. </dd>
  771. </dl>
  772. <section>
  773. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  774. <span class="phpdocumentor-signature__response_type">float</span>
  775. </section>
  776. </article>
  777. </section>
  778. <div class="phpdocumentor-modal" id="source-view">
  779. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  780. <div class="phpdocumentor-modal-container">
  781. <div class="phpdocumentor-modal-content">
  782. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Detector/FinderPattern.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  783. </div>
  784. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  785. </div>
  786. </div>
  787. <script type="text/javascript">
  788. (function () {
  789. function loadExternalCodeSnippet(el, url, line) {
  790. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  791. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  792. const language = 'php';
  793. const code = document.createElement('code');
  794. code.className = 'language-' + language;
  795. pre.textContent = '';
  796. pre.setAttribute('data-line', line)
  797. code.textContent = 'Loading…';
  798. pre.appendChild(code);
  799. var xhr = new XMLHttpRequest();
  800. xhr.open('GET', src, true);
  801. xhr.onreadystatechange = function () {
  802. if (xhr.readyState !== 4) {
  803. return;
  804. }
  805. if (xhr.status < 400 && xhr.responseText) {
  806. code.textContent = xhr.responseText;
  807. Prism.highlightElement(code);
  808. return;
  809. }
  810. if (xhr.status === 404) {
  811. code.textContent = '✖ Error: File could not be found';
  812. return;
  813. }
  814. if (xhr.status >= 400) {
  815. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  816. return;
  817. }
  818. code.textContent = '✖ Error: An unknown error occurred';
  819. };
  820. xhr.send(null);
  821. });
  822. }
  823. const modalButtons = document.querySelectorAll("[data-modal]");
  824. const openedAsLocalFile = window.location.protocol === 'file:';
  825. if (modalButtons.length > 0 && openedAsLocalFile) {
  826. console.warn(
  827. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  828. 'browsers block XHR requests when a page is opened this way'
  829. );
  830. }
  831. modalButtons.forEach(function (trigger) {
  832. if (openedAsLocalFile) {
  833. trigger.setAttribute("hidden", "hidden");
  834. }
  835. trigger.addEventListener("click", function (event) {
  836. event.preventDefault();
  837. const modal = document.getElementById(trigger.dataset.modal);
  838. if (!modal) {
  839. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  840. return;
  841. }
  842. modal.classList.add("phpdocumentor-modal__open");
  843. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  844. const exits = modal.querySelectorAll("[data-exit-button]");
  845. exits.forEach(function (exit) {
  846. exit.addEventListener("click", function (event) {
  847. event.preventDefault();
  848. modal.classList.remove("phpdocumentor-modal__open");
  849. });
  850. });
  851. });
  852. });
  853. })();
  854. </script>
  855. </article>
  856. </section>
  857. <section class="phpdocumentor-on-this-page__sidebar">
  858. <section class="phpdocumentor-on-this-page__content">
  859. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  860. <ul class="phpdocumentor-list -clean">
  861. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  862. <li>
  863. <ul class="phpdocumentor-list -clean">
  864. <li><a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#toc-properties">Properties</a></li>
  865. <li><a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#toc-methods">Methods</a></li>
  866. </ul>
  867. </li>
  868. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  869. <li>
  870. <ul class="phpdocumentor-list -clean">
  871. <li class=""><a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_estimatedModuleSize">$estimatedModuleSize</a></li>
  872. <li class=""><a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_x">$x</a></li>
  873. <li class=""><a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_y">$y</a></li>
  874. <li class=""><a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#property_count">$count</a></li>
  875. </ul>
  876. </li>
  877. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  878. <li>
  879. <ul class="phpdocumentor-list -clean">
  880. <li class=""><a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#method___construct">__construct()</a></li>
  881. <li class=""><a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_aboutEquals">aboutEquals()</a></li>
  882. <li class=""><a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#method_combineEstimate">combineEstimate()</a></li>
  883. <li class=""><a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#method_distance">distance()</a></li>
  884. <li class=""><a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#method_getCount">getCount()</a></li>
  885. <li class=""><a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#method_getDistance">getDistance()</a></li>
  886. <li class=""><a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getEstimatedModuleSize">getEstimatedModuleSize()</a></li>
  887. <li class=""><a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#method_getSquaredDistance">getSquaredDistance()</a></li>
  888. <li class=""><a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getX">getX()</a></li>
  889. <li class=""><a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getY">getY()</a></li>
  890. <li class=""><a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#method_squaredDistance">squaredDistance()</a></li>
  891. </ul>
  892. </li>
  893. </ul>
  894. </section>
  895. </section>
  896. </div>
  897. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  898. <section class="phpdocumentor-search-results__dialog">
  899. <header class="phpdocumentor-search-results__header">
  900. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  901. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  902. </header>
  903. <section class="phpdocumentor-search-results__body">
  904. <ul class="phpdocumentor-search-results__entries"></ul>
  905. </section>
  906. </section>
  907. </section>
  908. </div>
  909. <a href="classes/chillerlan-QRCode-Detector-FinderPattern.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  910. </main>
  911. <script>
  912. cssVars({});
  913. </script>
  914. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  915. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  916. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  917. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  918. </body>
  919. </html>