chillerlan-QRCode-Detector-AlignmentPattern.html 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/template.js"></script>
  22. <script src="js/search.js"></script>
  23. <script defer src="js/searchIndex.js"></script>
  24. </head>
  25. <body id="top">
  26. <header class="phpdocumentor-header phpdocumentor-section">
  27. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  28. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  29. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  30. <i class="fas fa-bars"></i>
  31. </label>
  32. <section data-search-form class="phpdocumentor-search">
  33. <label>
  34. <span class="visually-hidden">Search for</span>
  35. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  36. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  37. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  38. </svg>
  39. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  40. </label>
  41. </section>
  42. <nav class="phpdocumentor-topnav">
  43. <ul class="phpdocumentor-topnav__menu">
  44. <li class="phpdocumentor-topnav__menu-item -menu">
  45. <a href="https://php-qrcode.readthedocs.io">
  46. <span>
  47. User Manual
  48. </span>
  49. </a>
  50. </li>
  51. <li class="phpdocumentor-topnav__menu-item -social">
  52. <a href="https://github.com/chillerlan/php-qrcode">
  53. <span>
  54. <i class="fab fa-github"></i>
  55. </span>
  56. </a>
  57. </li>
  58. <li class="phpdocumentor-topnav__menu-item -social">
  59. <a href="https://github.com/chillerlan/php-qrcode/discussions">
  60. <span>
  61. <i class="fas fa-envelope-open-text"></i>
  62. </span>
  63. </a>
  64. </li>
  65. </ul>
  66. </nav>
  67. </header>
  68. <main class="phpdocumentor">
  69. <div class="phpdocumentor-section">
  70. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  71. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  72. Menu
  73. </label>
  74. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  75. <section class="phpdocumentor-sidebar__category -namespaces">
  76. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  77. <h4 class="phpdocumentor-sidebar__root-namespace">
  78. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  79. </h4>
  80. <ul class="phpdocumentor-list">
  81. <li>
  82. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  83. </li>
  84. <li>
  85. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  86. </li>
  87. </ul>
  88. </section>
  89. <section class="phpdocumentor-sidebar__category -packages">
  90. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  91. <h4 class="phpdocumentor-sidebar__root-namespace">
  92. <a href="packages/Application.html" class="">Application</a>
  93. </h4>
  94. </section>
  95. <section class="phpdocumentor-sidebar__category -reports">
  96. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  97. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  98. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  99. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  100. </section>
  101. <section class="phpdocumentor-sidebar__category -indices">
  102. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  103. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  104. </section>
  105. </aside>
  106. <div class="phpdocumentor-column -nine phpdocumentor-content">
  107. <section>
  108. <ul class="phpdocumentor-breadcrumbs">
  109. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  110. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  111. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-detector.html">Detector</a></li>
  112. </ul>
  113. <article class="phpdocumentor-element -class">
  114. <h2 class="phpdocumentor-content__title">
  115. AlignmentPattern
  116. <span class="phpdocumentor-element__extends">
  117. extends <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html"><abbr title="\chillerlan\QRCode\Detector\ResultPoint">ResultPoint</abbr></a>
  118. </span>
  119. <div class="phpdocumentor-element__package">
  120. in package
  121. <ul class="phpdocumentor-breadcrumbs">
  122. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  123. </ul>
  124. </div>
  125. </h2>
  126. <div class="phpdocumentor-label-line">
  127. <div class="phpdocumentor-label phpdocumentor-label--success"><span>Final</span><span>Yes</span></div>
  128. </div>
  129. <aside class="phpdocumentor-element-found-in">
  130. <abbr class="phpdocumentor-element-found-in__file" title="src/Detector/AlignmentPattern.php"><a href="files/src-detector-alignmentpattern.html"><abbr title="src/Detector/AlignmentPattern.php">AlignmentPattern.php</abbr></a></abbr>
  131. :
  132. <span class="phpdocumentor-element-found-in__line">21</span>
  133. </aside>
  134. <p class="phpdocumentor-summary">Encapsulates an alignment pattern, which are the smaller square patterns found in
  135. all but the simplest QR Codes.</p>
  136. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  137. Tags
  138. <a href="classes/chillerlan-QRCode-Detector-AlignmentPattern.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
  139. </h5>
  140. <dl class="phpdocumentor-tag-list">
  141. <dt class="phpdocumentor-tag-list__entry">
  142. <span class="phpdocumentor-tag__name">author</span>
  143. </dt>
  144. <dd class="phpdocumentor-tag-list__definition">
  145. <section class="phpdocumentor-description"><p>Sean Owen</p>
  146. </section>
  147. </dd>
  148. </dl>
  149. <h3 id="toc">
  150. Table of Contents
  151. <a href="classes/chillerlan-QRCode-Detector-AlignmentPattern.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  152. </h3>
  153. <h4 id="toc-properties">
  154. Properties
  155. <a href="classes/chillerlan-QRCode-Detector-AlignmentPattern.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  156. </h4>
  157. <dl class="phpdocumentor-table-of-contents">
  158. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  159. <a class="" href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_estimatedModuleSize">$estimatedModuleSize</a>
  160. <span>
  161. &nbsp;: float </span>
  162. </dt>
  163. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  164. <a class="" href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_x">$x</a>
  165. <span>
  166. &nbsp;: float </span>
  167. </dt>
  168. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  169. <a class="" href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_y">$y</a>
  170. <span>
  171. &nbsp;: float </span>
  172. </dt>
  173. </dl>
  174. <h4 id="toc-methods">
  175. Methods
  176. <a href="classes/chillerlan-QRCode-Detector-AlignmentPattern.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  177. </h4>
  178. <dl class="phpdocumentor-table-of-contents">
  179. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  180. <a class="" href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method___construct">__construct()</a>
  181. <span>
  182. &nbsp;: mixed </span>
  183. </dt>
  184. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  185. <a class="" href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_aboutEquals">aboutEquals()</a>
  186. <span>
  187. &nbsp;: bool </span>
  188. </dt>
  189. <dd>Determines if this finder pattern &quot;about equals&quot; a finder pattern at the stated
  190. position and size -- meaning, it is at nearly the same center with nearly the same size.</dd>
  191. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  192. <a class="" href="classes/chillerlan-QRCode-Detector-AlignmentPattern.html#method_combineEstimate">combineEstimate()</a>
  193. <span>
  194. &nbsp;: static </span>
  195. </dt>
  196. <dd>Combines this object&#039;s current estimate of a finder pattern position and module size
  197. with a new estimate. It returns a new FinderPattern containing an average of the two.</dd>
  198. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  199. <a class="" href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getEstimatedModuleSize">getEstimatedModuleSize()</a>
  200. <span>
  201. &nbsp;: float </span>
  202. </dt>
  203. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  204. <a class="" href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getX">getX()</a>
  205. <span>
  206. &nbsp;: float </span>
  207. </dt>
  208. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  209. <a class="" href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getY">getY()</a>
  210. <span>
  211. &nbsp;: float </span>
  212. </dt>
  213. </dl>
  214. <section class="phpdocumentor-properties">
  215. <h3 class="phpdocumentor-elements__header" id="properties">
  216. Properties
  217. <a href="classes/chillerlan-QRCode-Detector-AlignmentPattern.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  218. </h3>
  219. <article
  220. class="
  221. phpdocumentor-element
  222. -property
  223. -protected
  224. "
  225. >
  226. <h4 class="phpdocumentor-element__name" id="property_estimatedModuleSize">
  227. $estimatedModuleSize
  228. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_estimatedModuleSize" class="headerlink"><i class="fas fa-link"></i></a>
  229. <span class="phpdocumentor-element__modifiers">
  230. </span>
  231. </h4>
  232. <aside class="phpdocumentor-element-found-in">
  233. <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>
  234. :
  235. <span class="phpdocumentor-element-found-in__line">27</span>
  236. </aside>
  237. <code class="phpdocumentor-code phpdocumentor-signature ">
  238. <span class="phpdocumentor-signature__visibility">protected</span>
  239. <span class="phpdocumentor-signature__type">float</span>
  240. <span class="phpdocumentor-signature__name">$estimatedModuleSize</span>
  241. </code>
  242. </article>
  243. <article
  244. class="
  245. phpdocumentor-element
  246. -property
  247. -protected
  248. "
  249. >
  250. <h4 class="phpdocumentor-element__name" id="property_x">
  251. $x
  252. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_x" class="headerlink"><i class="fas fa-link"></i></a>
  253. <span class="phpdocumentor-element__modifiers">
  254. </span>
  255. </h4>
  256. <aside class="phpdocumentor-element-found-in">
  257. <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>
  258. :
  259. <span class="phpdocumentor-element-found-in__line">25</span>
  260. </aside>
  261. <code class="phpdocumentor-code phpdocumentor-signature ">
  262. <span class="phpdocumentor-signature__visibility">protected</span>
  263. <span class="phpdocumentor-signature__type">float</span>
  264. <span class="phpdocumentor-signature__name">$x</span>
  265. </code>
  266. </article>
  267. <article
  268. class="
  269. phpdocumentor-element
  270. -property
  271. -protected
  272. "
  273. >
  274. <h4 class="phpdocumentor-element__name" id="property_y">
  275. $y
  276. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_y" class="headerlink"><i class="fas fa-link"></i></a>
  277. <span class="phpdocumentor-element__modifiers">
  278. </span>
  279. </h4>
  280. <aside class="phpdocumentor-element-found-in">
  281. <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>
  282. :
  283. <span class="phpdocumentor-element-found-in__line">26</span>
  284. </aside>
  285. <code class="phpdocumentor-code phpdocumentor-signature ">
  286. <span class="phpdocumentor-signature__visibility">protected</span>
  287. <span class="phpdocumentor-signature__type">float</span>
  288. <span class="phpdocumentor-signature__name">$y</span>
  289. </code>
  290. </article>
  291. </section>
  292. <section class="phpdocumentor-methods">
  293. <h3 class="phpdocumentor-elements__header" id="methods">
  294. Methods
  295. <a href="classes/chillerlan-QRCode-Detector-AlignmentPattern.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  296. </h3>
  297. <article
  298. class="phpdocumentor-element
  299. -method
  300. -public
  301. "
  302. >
  303. <h4 class="phpdocumentor-element__name" id="method___construct">
  304. __construct()
  305. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  306. </h4>
  307. <aside class="phpdocumentor-element-found-in">
  308. <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>
  309. :
  310. <span class="phpdocumentor-element-found-in__line">29</span>
  311. </aside>
  312. <code class="phpdocumentor-code phpdocumentor-signature ">
  313. <span class="phpdocumentor-signature__visibility">public</span>
  314. <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">$x</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">$y</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>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  315. <div class="phpdocumentor-label-line">
  316. </div>
  317. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  318. <dl class="phpdocumentor-argument-list">
  319. <dt class="phpdocumentor-argument-list__entry">
  320. <span class="phpdocumentor-signature__argument__name">$x</span>
  321. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  322. </dt>
  323. <dd class="phpdocumentor-argument-list__definition">
  324. </dd>
  325. <dt class="phpdocumentor-argument-list__entry">
  326. <span class="phpdocumentor-signature__argument__name">$y</span>
  327. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  328. </dt>
  329. <dd class="phpdocumentor-argument-list__definition">
  330. </dd>
  331. <dt class="phpdocumentor-argument-list__entry">
  332. <span class="phpdocumentor-signature__argument__name">$estimatedModuleSize</span>
  333. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  334. </dt>
  335. <dd class="phpdocumentor-argument-list__definition">
  336. </dd>
  337. </dl>
  338. </article>
  339. <article
  340. class="phpdocumentor-element
  341. -method
  342. -public
  343. "
  344. >
  345. <h4 class="phpdocumentor-element__name" id="method_aboutEquals">
  346. aboutEquals()
  347. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_aboutEquals" class="headerlink"><i class="fas fa-link"></i></a>
  348. </h4>
  349. <aside class="phpdocumentor-element-found-in">
  350. <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>
  351. :
  352. <span class="phpdocumentor-element-found-in__line">51</span>
  353. </aside>
  354. <p class="phpdocumentor-summary">Determines if this finder pattern &quot;about equals&quot; a finder pattern at the stated
  355. position and size -- meaning, it is at nearly the same center with nearly the same size.</p>
  356. <code class="phpdocumentor-code phpdocumentor-signature ">
  357. <span class="phpdocumentor-signature__visibility">public</span>
  358. <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>
  359. <div class="phpdocumentor-label-line">
  360. </div>
  361. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  362. <dl class="phpdocumentor-argument-list">
  363. <dt class="phpdocumentor-argument-list__entry">
  364. <span class="phpdocumentor-signature__argument__name">$moduleSize</span>
  365. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  366. </dt>
  367. <dd class="phpdocumentor-argument-list__definition">
  368. </dd>
  369. <dt class="phpdocumentor-argument-list__entry">
  370. <span class="phpdocumentor-signature__argument__name">$i</span>
  371. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  372. </dt>
  373. <dd class="phpdocumentor-argument-list__definition">
  374. </dd>
  375. <dt class="phpdocumentor-argument-list__entry">
  376. <span class="phpdocumentor-signature__argument__name">$j</span>
  377. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  378. </dt>
  379. <dd class="phpdocumentor-argument-list__definition">
  380. </dd>
  381. </dl>
  382. <section>
  383. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  384. <span class="phpdocumentor-signature__response_type">bool</span>
  385. </section>
  386. </article>
  387. <article
  388. class="phpdocumentor-element
  389. -method
  390. -public
  391. "
  392. >
  393. <h4 class="phpdocumentor-element__name" id="method_combineEstimate">
  394. combineEstimate()
  395. <a href="classes/chillerlan-QRCode-Detector-AlignmentPattern.html#method_combineEstimate" class="headerlink"><i class="fas fa-link"></i></a>
  396. </h4>
  397. <aside class="phpdocumentor-element-found-in">
  398. <abbr class="phpdocumentor-element-found-in__file" title="src/Detector/AlignmentPattern.php"><a href="files/src-detector-alignmentpattern.html"><abbr title="src/Detector/AlignmentPattern.php">AlignmentPattern.php</abbr></a></abbr>
  399. :
  400. <span class="phpdocumentor-element-found-in__line">27</span>
  401. </aside>
  402. <p class="phpdocumentor-summary">Combines this object&#039;s current estimate of a finder pattern position and module size
  403. with a new estimate. It returns a new FinderPattern containing an average of the two.</p>
  404. <code class="phpdocumentor-code phpdocumentor-signature ">
  405. <span class="phpdocumentor-signature__visibility">public</span>
  406. <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>
  407. <div class="phpdocumentor-label-line">
  408. </div>
  409. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  410. <dl class="phpdocumentor-argument-list">
  411. <dt class="phpdocumentor-argument-list__entry">
  412. <span class="phpdocumentor-signature__argument__name">$i</span>
  413. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  414. </dt>
  415. <dd class="phpdocumentor-argument-list__definition">
  416. </dd>
  417. <dt class="phpdocumentor-argument-list__entry">
  418. <span class="phpdocumentor-signature__argument__name">$j</span>
  419. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  420. </dt>
  421. <dd class="phpdocumentor-argument-list__definition">
  422. </dd>
  423. <dt class="phpdocumentor-argument-list__entry">
  424. <span class="phpdocumentor-signature__argument__name">$newModuleSize</span>
  425. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  426. </dt>
  427. <dd class="phpdocumentor-argument-list__definition">
  428. </dd>
  429. </dl>
  430. <section>
  431. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  432. <span class="phpdocumentor-signature__response_type">static</span>
  433. </section>
  434. </article>
  435. <article
  436. class="phpdocumentor-element
  437. -method
  438. -public
  439. "
  440. >
  441. <h4 class="phpdocumentor-element__name" id="method_getEstimatedModuleSize">
  442. getEstimatedModuleSize()
  443. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getEstimatedModuleSize" class="headerlink"><i class="fas fa-link"></i></a>
  444. </h4>
  445. <aside class="phpdocumentor-element-found-in">
  446. <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>
  447. :
  448. <span class="phpdocumentor-element-found-in__line">43</span>
  449. </aside>
  450. <code class="phpdocumentor-code phpdocumentor-signature ">
  451. <span class="phpdocumentor-signature__visibility">public</span>
  452. <span class="phpdocumentor-signature__name">getEstimatedModuleSize</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">float</span></code>
  453. <div class="phpdocumentor-label-line">
  454. </div>
  455. <section>
  456. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  457. <span class="phpdocumentor-signature__response_type">float</span>
  458. </section>
  459. </article>
  460. <article
  461. class="phpdocumentor-element
  462. -method
  463. -public
  464. "
  465. >
  466. <h4 class="phpdocumentor-element__name" id="method_getX">
  467. getX()
  468. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getX" class="headerlink"><i class="fas fa-link"></i></a>
  469. </h4>
  470. <aside class="phpdocumentor-element-found-in">
  471. <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>
  472. :
  473. <span class="phpdocumentor-element-found-in__line">35</span>
  474. </aside>
  475. <code class="phpdocumentor-code phpdocumentor-signature ">
  476. <span class="phpdocumentor-signature__visibility">public</span>
  477. <span class="phpdocumentor-signature__name">getX</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">float</span></code>
  478. <div class="phpdocumentor-label-line">
  479. </div>
  480. <section>
  481. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  482. <span class="phpdocumentor-signature__response_type">float</span>
  483. </section>
  484. </article>
  485. <article
  486. class="phpdocumentor-element
  487. -method
  488. -public
  489. "
  490. >
  491. <h4 class="phpdocumentor-element__name" id="method_getY">
  492. getY()
  493. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getY" class="headerlink"><i class="fas fa-link"></i></a>
  494. </h4>
  495. <aside class="phpdocumentor-element-found-in">
  496. <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>
  497. :
  498. <span class="phpdocumentor-element-found-in__line">39</span>
  499. </aside>
  500. <code class="phpdocumentor-code phpdocumentor-signature ">
  501. <span class="phpdocumentor-signature__visibility">public</span>
  502. <span class="phpdocumentor-signature__name">getY</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">float</span></code>
  503. <div class="phpdocumentor-label-line">
  504. </div>
  505. <section>
  506. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  507. <span class="phpdocumentor-signature__response_type">float</span>
  508. </section>
  509. </article>
  510. </section>
  511. <div class="phpdocumentor-modal" id="source-view">
  512. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  513. <div class="phpdocumentor-modal-container">
  514. <div class="phpdocumentor-modal-content">
  515. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Detector/AlignmentPattern.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  516. </div>
  517. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  518. </div>
  519. </div>
  520. <script type="text/javascript">
  521. (function () {
  522. function loadExternalCodeSnippet(el, url, line) {
  523. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  524. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  525. const language = 'php';
  526. const code = document.createElement('code');
  527. code.className = 'language-' + language;
  528. pre.textContent = '';
  529. pre.setAttribute('data-line', line)
  530. code.textContent = 'Loading…';
  531. pre.appendChild(code);
  532. var xhr = new XMLHttpRequest();
  533. xhr.open('GET', src, true);
  534. xhr.onreadystatechange = function () {
  535. if (xhr.readyState !== 4) {
  536. return;
  537. }
  538. if (xhr.status < 400 && xhr.responseText) {
  539. code.textContent = xhr.responseText;
  540. Prism.highlightElement(code);
  541. d=document.getElementsByClassName("line-numbers");
  542. d[0].scrollTop = d[0].children[1].offsetTop;
  543. return;
  544. }
  545. if (xhr.status === 404) {
  546. code.textContent = '✖ Error: File could not be found';
  547. return;
  548. }
  549. if (xhr.status >= 400) {
  550. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  551. return;
  552. }
  553. code.textContent = '✖ Error: An unknown error occurred';
  554. };
  555. xhr.send(null);
  556. });
  557. }
  558. const modalButtons = document.querySelectorAll("[data-modal]");
  559. const openedAsLocalFile = window.location.protocol === 'file:';
  560. if (modalButtons.length > 0 && openedAsLocalFile) {
  561. console.warn(
  562. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  563. 'browsers block XHR requests when a page is opened this way'
  564. );
  565. }
  566. modalButtons.forEach(function (trigger) {
  567. if (openedAsLocalFile) {
  568. trigger.setAttribute("hidden", "hidden");
  569. }
  570. trigger.addEventListener("click", function (event) {
  571. event.preventDefault();
  572. const modal = document.getElementById(trigger.dataset.modal);
  573. if (!modal) {
  574. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  575. return;
  576. }
  577. modal.classList.add("phpdocumentor-modal__open");
  578. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  579. const exits = modal.querySelectorAll("[data-exit-button]");
  580. exits.forEach(function (exit) {
  581. exit.addEventListener("click", function (event) {
  582. event.preventDefault();
  583. modal.classList.remove("phpdocumentor-modal__open");
  584. });
  585. });
  586. });
  587. });
  588. })();
  589. </script>
  590. </article>
  591. </section>
  592. <section class="phpdocumentor-on-this-page__sidebar">
  593. <section class="phpdocumentor-on-this-page__content">
  594. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  595. <ul class="phpdocumentor-list -clean">
  596. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  597. <li>
  598. <ul class="phpdocumentor-list -clean">
  599. <li><a href="classes/chillerlan-QRCode-Detector-AlignmentPattern.html#toc-properties">Properties</a></li>
  600. <li><a href="classes/chillerlan-QRCode-Detector-AlignmentPattern.html#toc-methods">Methods</a></li>
  601. </ul>
  602. </li>
  603. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  604. <li>
  605. <ul class="phpdocumentor-list -clean">
  606. <li class=""><a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_estimatedModuleSize">$estimatedModuleSize</a></li>
  607. <li class=""><a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_x">$x</a></li>
  608. <li class=""><a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_y">$y</a></li>
  609. </ul>
  610. </li>
  611. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  612. <li>
  613. <ul class="phpdocumentor-list -clean">
  614. <li class=""><a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method___construct">__construct()</a></li>
  615. <li class=""><a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_aboutEquals">aboutEquals()</a></li>
  616. <li class=""><a href="classes/chillerlan-QRCode-Detector-AlignmentPattern.html#method_combineEstimate">combineEstimate()</a></li>
  617. <li class=""><a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getEstimatedModuleSize">getEstimatedModuleSize()</a></li>
  618. <li class=""><a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getX">getX()</a></li>
  619. <li class=""><a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getY">getY()</a></li>
  620. </ul>
  621. </li>
  622. </ul>
  623. </section>
  624. </section>
  625. </div>
  626. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  627. <section class="phpdocumentor-search-results__dialog">
  628. <header class="phpdocumentor-search-results__header">
  629. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  630. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  631. </header>
  632. <section class="phpdocumentor-search-results__body">
  633. <ul class="phpdocumentor-search-results__entries"></ul>
  634. </section>
  635. </section>
  636. </section>
  637. </div>
  638. <a href="classes/chillerlan-QRCode-Detector-AlignmentPattern.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  639. </main>
  640. <script>
  641. cssVars({});
  642. </script>
  643. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  644. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  645. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  646. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  647. </body>
  648. </html>