chillerlan-QRCode-Detector-AlignmentPattern.html 38 KB

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