chillerlan-QRCode-Detector-FinderPattern.html 56 KB

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