chillerlan-qrcode-decoder.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
  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. </ul>
  44. </nav>
  45. </header>
  46. <main class="phpdocumentor">
  47. <div class="phpdocumentor-section">
  48. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  49. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  50. Menu
  51. </label>
  52. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  55. <h4 class="phpdocumentor-sidebar__root-namespace">
  56. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  57. </h4>
  58. <ul class="phpdocumentor-list">
  59. <li>
  60. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  61. </li>
  62. <li>
  63. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  64. </li>
  65. </ul>
  66. </section>
  67. <section class="phpdocumentor-sidebar__category">
  68. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  69. <h4 class="phpdocumentor-sidebar__root-namespace">
  70. <a href="packages/Application.html" class="">Application</a>
  71. </h4>
  72. </section>
  73. <section class="phpdocumentor-sidebar__category">
  74. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  75. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  76. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  78. </section>
  79. <section class="phpdocumentor-sidebar__category">
  80. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  81. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  82. </section>
  83. </aside>
  84. <div class="phpdocumentor-column -eight phpdocumentor-content">
  85. <ul class="phpdocumentor-breadcrumbs">
  86. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  87. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  88. </ul>
  89. <article class="phpdocumentor-element -namespace">
  90. <h2 class="phpdocumentor-content__title">Decoder</h2>
  91. <h3 id="interfaces_class_traits">
  92. Interfaces, Classes, Traits and Enums
  93. <a href="#interfaces_class_traits" class="headerlink"><i class="fas fa-link"></i></a>
  94. </h3>
  95. <dl class="phpdocumentor-table-of-contents">
  96. <dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceInterface.html"><abbr title="\chillerlan\QRCode\Decoder\LuminanceSourceInterface">LuminanceSourceInterface</abbr></a></dt>
  97. <dd></dd>
  98. <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Decoder-Binarizer.html"><abbr title="\chillerlan\QRCode\Decoder\Binarizer">Binarizer</abbr></a></dt>
  99. <dd>This class implements a local thresholding algorithm, which while slower than the
  100. GlobalHistogramBinarizer, is fairly efficient for what it does. It is designed for
  101. high frequency images of barcodes with black data on white backgrounds. For this application,
  102. it does a much better job than a global blackpoint with severe shadows and gradients.</dd>
  103. <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Decoder-BitMatrix.html"><abbr title="\chillerlan\QRCode\Decoder\BitMatrix">BitMatrix</abbr></a></dt>
  104. <dd>Holds a numerical representation of the final QR Code;
  105. maps the ECC coded binary data and applies the mask pattern</dd>
  106. <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Decoder-Decoder.html"><abbr title="\chillerlan\QRCode\Decoder\Decoder">Decoder</abbr></a></dt>
  107. <dd>The main class which implements QR Code decoding -- as opposed to locating and extracting
  108. the QR Code from an image.</dd>
  109. <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></dt>
  110. <dd>Encapsulates the result of decoding a matrix of bits. This typically
  111. applies to 2D barcode formats. For now it contains the raw bytes obtained,
  112. as well as a String interpretation of those bytes, if applicable.</dd>
  113. <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Decoder-GDLuminanceSource.html"><abbr title="\chillerlan\QRCode\Decoder\GDLuminanceSource">GDLuminanceSource</abbr></a></dt>
  114. <dd>This class is used to help decode images from files which arrive as GD Resource
  115. It does not support rotation.</dd>
  116. <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Decoder-IMagickLuminanceSource.html"><abbr title="\chillerlan\QRCode\Decoder\IMagickLuminanceSource">IMagickLuminanceSource</abbr></a></dt>
  117. <dd>This class is used to help decode images from files which arrive as Imagick Resource
  118. It does not support rotation.</dd>
  119. <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html"><abbr title="\chillerlan\QRCode\Decoder\LuminanceSourceAbstract">LuminanceSourceAbstract</abbr></a></dt>
  120. <dd>The purpose of this class hierarchy is to abstract different bitmap implementations across
  121. platforms into a standard interface for requesting greyscale luminance values. The interface
  122. only provides immutable methods; therefore crop and rotation create copies. This is to ensure
  123. that one Reader does not modify the original luminance source and leave it in an unknown state
  124. for other Readers in the chain.</dd>
  125. <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html"><abbr title="\chillerlan\QRCode\Decoder\QRCodeDecoderException">QRCodeDecoderException</abbr></a></dt>
  126. <dd>An exception container</dd>
  127. </dl>
  128. </article>
  129. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  130. <section class="phpdocumentor-search-results__dialog">
  131. <header class="phpdocumentor-search-results__header">
  132. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  133. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  134. </header>
  135. <section class="phpdocumentor-search-results__body">
  136. <ul class="phpdocumentor-search-results__entries"></ul>
  137. </section>
  138. </section>
  139. </section>
  140. </div>
  141. </div>
  142. <a href="namespaces/chillerlan-qrcode-decoder.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  143. </main>
  144. <script>
  145. cssVars({});
  146. </script>
  147. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  148. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  149. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  150. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  151. </body>
  152. </html>