chillerlan-QRCode-Detector-FinderPattern.html 57 KB

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