chillerlan-QRCode-Detector-AlignmentPattern.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726
  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=Source+Sans+Pro:wght@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/search.js"></script>
  22. <script defer src="js/searchIndex.js"></script>
  23. </head>
  24. <body id="top">
  25. <header class="phpdocumentor-header phpdocumentor-section">
  26. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  27. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  28. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  29. <i class="fas fa-bars"></i>
  30. </label>
  31. <section data-search-form class="phpdocumentor-search">
  32. <label>
  33. <span class="visually-hidden">Search for</span>
  34. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  35. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  36. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  37. </svg>
  38. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  39. </label>
  40. </section>
  41. <nav class="phpdocumentor-topnav">
  42. <ul class="phpdocumentor-topnav__menu">
  43. <li class="phpdocumentor-topnav__menu-item -menu">
  44. <a href="https://php-qrcode.readthedocs.io">
  45. <span>
  46. User Manual
  47. </span>
  48. </a>
  49. </li>
  50. <li class="phpdocumentor-topnav__menu-item -social">
  51. <a href="https://github.com/chillerlan/php-qrcode">
  52. <span>
  53. <i class="fab fa-github"></i>
  54. </span>
  55. </a>
  56. </li>
  57. </ul>
  58. </nav>
  59. </header>
  60. <main class="phpdocumentor">
  61. <div class="phpdocumentor-section">
  62. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  63. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  64. Menu
  65. </label>
  66. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  67. <section class="phpdocumentor-sidebar__category">
  68. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  69. <h4 class="phpdocumentor-sidebar__root-namespace">
  70. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  71. </h4>
  72. <ul class="phpdocumentor-list">
  73. <li>
  74. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  75. </li>
  76. <li>
  77. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  78. </li>
  79. </ul>
  80. </section>
  81. <section class="phpdocumentor-sidebar__category">
  82. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  83. <h4 class="phpdocumentor-sidebar__root-namespace">
  84. <a href="packages/Application.html" class="">Application</a>
  85. </h4>
  86. </section>
  87. <section class="phpdocumentor-sidebar__category">
  88. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  89. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  90. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  91. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  92. </section>
  93. <section class="phpdocumentor-sidebar__category">
  94. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  95. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  96. </section>
  97. </aside>
  98. <div class="phpdocumentor-column -eight phpdocumentor-content">
  99. <ul class="phpdocumentor-breadcrumbs">
  100. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  101. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  102. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-detector.html">Detector</a></li>
  103. </ul>
  104. <article class="phpdocumentor-element -class">
  105. <h2 class="phpdocumentor-content__title">
  106. AlignmentPattern
  107. <span class="phpdocumentor-element__extends">
  108. extends <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html"><abbr title="\chillerlan\QRCode\Detector\ResultPoint">ResultPoint</abbr></a>
  109. </span>
  110. <div class="phpdocumentor-element__package">
  111. in package
  112. <ul class="phpdocumentor-breadcrumbs">
  113. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  114. </ul>
  115. </div>
  116. </h2>
  117. <aside class="phpdocumentor-element-found-in">
  118. <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>
  119. :
  120. <span class="phpdocumentor-element-found-in__line">20</span>
  121. </aside>
  122. <p class="phpdocumentor-summary">Encapsulates an alignment pattern, which are the smaller square patterns found in
  123. all but the simplest QR Codes.</p>
  124. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  125. Tags
  126. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  127. </h5>
  128. <dl class="phpdocumentor-tag-list">
  129. <dt class="phpdocumentor-tag-list__entry">
  130. <span class="phpdocumentor-tag__name">author</span>
  131. </dt>
  132. <dd class="phpdocumentor-tag-list__definition">
  133. <section class="phpdocumentor-description"><p>Sean Owen</p>
  134. </section>
  135. </dd>
  136. </dl>
  137. <h3 id="toc">
  138. Table of Contents
  139. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  140. </h3>
  141. <dl class="phpdocumentor-table-of-contents">
  142. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  143. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_estimatedModuleSize">$estimatedModuleSize</a>
  144. <span>
  145. &nbsp;: float </span>
  146. </dt>
  147. <dd></dd>
  148. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  149. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_x">$x</a>
  150. <span>
  151. &nbsp;: float </span>
  152. </dt>
  153. <dd></dd>
  154. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  155. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_y">$y</a>
  156. <span>
  157. &nbsp;: float </span>
  158. </dt>
  159. <dd></dd>
  160. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  161. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method___construct">__construct()</a>
  162. <span>
  163. &nbsp;: mixed </span>
  164. </dt>
  165. <dd></dd>
  166. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  167. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_aboutEquals">aboutEquals()</a>
  168. <span>
  169. &nbsp;: bool </span>
  170. </dt>
  171. <dd>Determines if this finder pattern &quot;about equals&quot; a finder pattern at the stated
  172. position and size -- meaning, it is at nearly the same center with nearly the same size.</dd>
  173. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  174. <a href="classes/chillerlan-QRCode-Detector-AlignmentPattern.html#method_combineEstimate">combineEstimate()</a>
  175. <span>
  176. &nbsp;: self </span>
  177. </dt>
  178. <dd>Combines this object&#039;s current estimate of a finder pattern position and module size
  179. with a new estimate. It returns a new FinderPattern containing an average of the two.</dd>
  180. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  181. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getEstimatedModuleSize">getEstimatedModuleSize()</a>
  182. <span>
  183. &nbsp;: float </span>
  184. </dt>
  185. <dd></dd>
  186. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  187. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getX">getX()</a>
  188. <span>
  189. &nbsp;: float </span>
  190. </dt>
  191. <dd></dd>
  192. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  193. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getY">getY()</a>
  194. <span>
  195. &nbsp;: float </span>
  196. </dt>
  197. <dd></dd>
  198. </dl>
  199. <section class="phpdocumentor-properties">
  200. <h3 class="phpdocumentor-elements__header" id="properties">
  201. Properties
  202. <a href="classes/chillerlan-QRCode-Detector-AlignmentPattern.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  203. </h3>
  204. <article
  205. class="
  206. phpdocumentor-element
  207. -property
  208. -protected
  209. "
  210. >
  211. <h4 class="phpdocumentor-element__name" id="property_estimatedModuleSize">
  212. $estimatedModuleSize
  213. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_estimatedModuleSize" class="headerlink"><i class="fas fa-link"></i></a>
  214. <span class="phpdocumentor-element__modifiers">
  215. </span>
  216. </h4>
  217. <aside class="phpdocumentor-element-found-in">
  218. <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>
  219. :
  220. <span class="phpdocumentor-element-found-in__line">26</span>
  221. </aside>
  222. <code class="phpdocumentor-code phpdocumentor-signature ">
  223. <span class="phpdocumentor-signature__visibility">protected</span>
  224. <span class="phpdocumentor-signature__type">float</span>
  225. <span class="phpdocumentor-signature__name">$estimatedModuleSize</span>
  226. </code>
  227. <section class="phpdocumentor-description"></section>
  228. <section class="phpdocumentor-description"></section>
  229. </article>
  230. <article
  231. class="
  232. phpdocumentor-element
  233. -property
  234. -protected
  235. "
  236. >
  237. <h4 class="phpdocumentor-element__name" id="property_x">
  238. $x
  239. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_x" class="headerlink"><i class="fas fa-link"></i></a>
  240. <span class="phpdocumentor-element__modifiers">
  241. </span>
  242. </h4>
  243. <aside class="phpdocumentor-element-found-in">
  244. <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>
  245. :
  246. <span class="phpdocumentor-element-found-in__line">24</span>
  247. </aside>
  248. <code class="phpdocumentor-code phpdocumentor-signature ">
  249. <span class="phpdocumentor-signature__visibility">protected</span>
  250. <span class="phpdocumentor-signature__type">float</span>
  251. <span class="phpdocumentor-signature__name">$x</span>
  252. </code>
  253. <section class="phpdocumentor-description"></section>
  254. <section class="phpdocumentor-description"></section>
  255. </article>
  256. <article
  257. class="
  258. phpdocumentor-element
  259. -property
  260. -protected
  261. "
  262. >
  263. <h4 class="phpdocumentor-element__name" id="property_y">
  264. $y
  265. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#property_y" class="headerlink"><i class="fas fa-link"></i></a>
  266. <span class="phpdocumentor-element__modifiers">
  267. </span>
  268. </h4>
  269. <aside class="phpdocumentor-element-found-in">
  270. <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>
  271. :
  272. <span class="phpdocumentor-element-found-in__line">25</span>
  273. </aside>
  274. <code class="phpdocumentor-code phpdocumentor-signature ">
  275. <span class="phpdocumentor-signature__visibility">protected</span>
  276. <span class="phpdocumentor-signature__type">float</span>
  277. <span class="phpdocumentor-signature__name">$y</span>
  278. </code>
  279. <section class="phpdocumentor-description"></section>
  280. <section class="phpdocumentor-description"></section>
  281. </article>
  282. </section>
  283. <section class="phpdocumentor-methods">
  284. <h3 class="phpdocumentor-elements__header" id="methods">
  285. Methods
  286. <a href="classes/chillerlan-QRCode-Detector-AlignmentPattern.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  287. </h3>
  288. <article
  289. class="phpdocumentor-element
  290. -method
  291. -public
  292. "
  293. >
  294. <h4 class="phpdocumentor-element__name" id="method___construct">
  295. __construct()
  296. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  297. </h4>
  298. <aside class="phpdocumentor-element-found-in">
  299. <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>
  300. :
  301. <span class="phpdocumentor-element-found-in__line">31</span>
  302. </aside>
  303. <code class="phpdocumentor-code phpdocumentor-signature ">
  304. <span class="phpdocumentor-signature__visibility">public</span>
  305. <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>
  306. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  307. <dl class="phpdocumentor-argument-list">
  308. <dt class="phpdocumentor-argument-list__entry">
  309. <span class="phpdocumentor-signature__argument__name">$x</span>
  310. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  311. </dt>
  312. <dd class="phpdocumentor-argument-list__definition">
  313. <section class="phpdocumentor-description"></section>
  314. </dd>
  315. <dt class="phpdocumentor-argument-list__entry">
  316. <span class="phpdocumentor-signature__argument__name">$y</span>
  317. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  318. </dt>
  319. <dd class="phpdocumentor-argument-list__definition">
  320. <section class="phpdocumentor-description"></section>
  321. </dd>
  322. <dt class="phpdocumentor-argument-list__entry">
  323. <span class="phpdocumentor-signature__argument__name">$estimatedModuleSize</span>
  324. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  325. </dt>
  326. <dd class="phpdocumentor-argument-list__definition">
  327. <section class="phpdocumentor-description"></section>
  328. </dd>
  329. </dl>
  330. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  331. <span class="phpdocumentor-signature__response_type">mixed</span>
  332. &mdash;
  333. </article>
  334. <article
  335. class="phpdocumentor-element
  336. -method
  337. -public
  338. "
  339. >
  340. <h4 class="phpdocumentor-element__name" id="method_aboutEquals">
  341. aboutEquals()
  342. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_aboutEquals" class="headerlink"><i class="fas fa-link"></i></a>
  343. </h4>
  344. <aside class="phpdocumentor-element-found-in">
  345. <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>
  346. :
  347. <span class="phpdocumentor-element-found-in__line">62</span>
  348. </aside>
  349. <p class="phpdocumentor-summary">Determines if this finder pattern &quot;about equals&quot; a finder pattern at the stated
  350. position and size -- meaning, it is at nearly the same center with nearly the same size.</p>
  351. <code class="phpdocumentor-code phpdocumentor-signature ">
  352. <span class="phpdocumentor-signature__visibility">public</span>
  353. <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>
  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. <section class="phpdocumentor-description"></section>
  362. </dd>
  363. <dt class="phpdocumentor-argument-list__entry">
  364. <span class="phpdocumentor-signature__argument__name">$i</span>
  365. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  366. </dt>
  367. <dd class="phpdocumentor-argument-list__definition">
  368. <section class="phpdocumentor-description"></section>
  369. </dd>
  370. <dt class="phpdocumentor-argument-list__entry">
  371. <span class="phpdocumentor-signature__argument__name">$j</span>
  372. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  373. </dt>
  374. <dd class="phpdocumentor-argument-list__definition">
  375. <section class="phpdocumentor-description"></section>
  376. </dd>
  377. </dl>
  378. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  379. <span class="phpdocumentor-signature__response_type">bool</span>
  380. &mdash;
  381. </article>
  382. <article
  383. class="phpdocumentor-element
  384. -method
  385. -public
  386. "
  387. >
  388. <h4 class="phpdocumentor-element__name" id="method_combineEstimate">
  389. combineEstimate()
  390. <a href="classes/chillerlan-QRCode-Detector-AlignmentPattern.html#method_combineEstimate" class="headerlink"><i class="fas fa-link"></i></a>
  391. </h4>
  392. <aside class="phpdocumentor-element-found-in">
  393. <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>
  394. :
  395. <span class="phpdocumentor-element-found-in__line">26</span>
  396. </aside>
  397. <p class="phpdocumentor-summary">Combines this object&#039;s current estimate of a finder pattern position and module size
  398. with a new estimate. It returns a new FinderPattern containing an average of the two.</p>
  399. <code class="phpdocumentor-code phpdocumentor-signature ">
  400. <span class="phpdocumentor-signature__visibility">public</span>
  401. <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>
  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. <section class="phpdocumentor-description"></section>
  410. </dd>
  411. <dt class="phpdocumentor-argument-list__entry">
  412. <span class="phpdocumentor-signature__argument__name">$j</span>
  413. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  414. </dt>
  415. <dd class="phpdocumentor-argument-list__definition">
  416. <section class="phpdocumentor-description"></section>
  417. </dd>
  418. <dt class="phpdocumentor-argument-list__entry">
  419. <span class="phpdocumentor-signature__argument__name">$newModuleSize</span>
  420. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  421. </dt>
  422. <dd class="phpdocumentor-argument-list__definition">
  423. <section class="phpdocumentor-description"></section>
  424. </dd>
  425. </dl>
  426. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  427. <span class="phpdocumentor-signature__response_type">self</span>
  428. &mdash;
  429. </article>
  430. <article
  431. class="phpdocumentor-element
  432. -method
  433. -public
  434. "
  435. >
  436. <h4 class="phpdocumentor-element__name" id="method_getEstimatedModuleSize">
  437. getEstimatedModuleSize()
  438. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getEstimatedModuleSize" class="headerlink"><i class="fas fa-link"></i></a>
  439. </h4>
  440. <aside class="phpdocumentor-element-found-in">
  441. <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>
  442. :
  443. <span class="phpdocumentor-element-found-in__line">54</span>
  444. </aside>
  445. <code class="phpdocumentor-code phpdocumentor-signature ">
  446. <span class="phpdocumentor-signature__visibility">public</span>
  447. <span class="phpdocumentor-signature__name">getEstimatedModuleSize</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">float</span></code>
  448. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  449. <span class="phpdocumentor-signature__response_type">float</span>
  450. &mdash;
  451. </article>
  452. <article
  453. class="phpdocumentor-element
  454. -method
  455. -public
  456. "
  457. >
  458. <h4 class="phpdocumentor-element__name" id="method_getX">
  459. getX()
  460. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getX" class="headerlink"><i class="fas fa-link"></i></a>
  461. </h4>
  462. <aside class="phpdocumentor-element-found-in">
  463. <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>
  464. :
  465. <span class="phpdocumentor-element-found-in__line">40</span>
  466. </aside>
  467. <code class="phpdocumentor-code phpdocumentor-signature ">
  468. <span class="phpdocumentor-signature__visibility">public</span>
  469. <span class="phpdocumentor-signature__name">getX</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">float</span></code>
  470. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  471. <span class="phpdocumentor-signature__response_type">float</span>
  472. &mdash;
  473. </article>
  474. <article
  475. class="phpdocumentor-element
  476. -method
  477. -public
  478. "
  479. >
  480. <h4 class="phpdocumentor-element__name" id="method_getY">
  481. getY()
  482. <a href="classes/chillerlan-QRCode-Detector-ResultPoint.html#method_getY" class="headerlink"><i class="fas fa-link"></i></a>
  483. </h4>
  484. <aside class="phpdocumentor-element-found-in">
  485. <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>
  486. :
  487. <span class="phpdocumentor-element-found-in__line">47</span>
  488. </aside>
  489. <code class="phpdocumentor-code phpdocumentor-signature ">
  490. <span class="phpdocumentor-signature__visibility">public</span>
  491. <span class="phpdocumentor-signature__name">getY</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">float</span></code>
  492. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  493. <span class="phpdocumentor-signature__response_type">float</span>
  494. &mdash;
  495. </article>
  496. </section>
  497. <script type="text/javascript">
  498. function loadExternalCodeSnippets(line) {
  499. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  500. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  501. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  502. var language = 'php';
  503. var code = document.createElement('code');
  504. code.className = 'language-' + language;
  505. pre.textContent = '';
  506. pre.setAttribute('data-line', line)
  507. code.textContent = 'Loading…';
  508. pre.appendChild(code);
  509. var xhr = new XMLHttpRequest();
  510. xhr.open('GET', src, true);
  511. xhr.onreadystatechange = function () {
  512. if (xhr.readyState == 4) {
  513. if (xhr.status < 400 && xhr.responseText) {
  514. code.textContent = xhr.responseText;
  515. Prism.highlightElement(code);
  516. }
  517. else if (xhr.status >= 400) {
  518. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  519. }
  520. else {
  521. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  522. }
  523. }
  524. };
  525. xhr.send(null);
  526. });
  527. }
  528. var modals = document.querySelectorAll("[data-modal]");
  529. modals.forEach(function (trigger) {
  530. trigger.addEventListener("click", function (event) {
  531. //event.preventDefault();
  532. const modal = document.getElementById(trigger.dataset.modal);
  533. modal.classList.add("phpdocumentor-modal__open");
  534. loadExternalCodeSnippets(trigger.dataset.line)
  535. const exits = modal.querySelectorAll("[data-exit-button]");
  536. exits.forEach(function (exit) {
  537. exit.addEventListener("click", function (event) {
  538. event.preventDefault();
  539. modal.classList.remove("phpdocumentor-modal__open");
  540. });
  541. });
  542. });
  543. });
  544. </script>
  545. </article>
  546. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  547. <section class="phpdocumentor-search-results__dialog">
  548. <header class="phpdocumentor-search-results__header">
  549. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  550. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  551. </header>
  552. <section class="phpdocumentor-search-results__body">
  553. <ul class="phpdocumentor-search-results__entries"></ul>
  554. </section>
  555. </section>
  556. </section>
  557. </div>
  558. </div>
  559. <a href="classes/chillerlan-QRCode-Detector-AlignmentPattern.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  560. </main>
  561. <script>
  562. cssVars({});
  563. </script>
  564. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  565. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  566. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  567. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  568. </body>
  569. </html>