chillerlan-QRCode-Detector-AlignmentPattern.html 38 KB

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