docs/javadoc/com/google/zxing/qrcode/decoder/Decoder.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!--NewPage-->
   3 <HTML>
   4 <HEAD>
   5 <!-- Generated by javadoc (build 1.6.0_13) on Fri Jun 26 13:12:29 EDT 2009 -->
   6 <TITLE>
   7 Decoder
   8 </TITLE>
   9
  10 <META NAME="date" CONTENT="2009-06-26">
  11
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
  13
  14 <SCRIPT type="text/javascript">
  15 function windowTitle()
  16 {
  17     if (location.href.indexOf('is-external=true') == -1) {
  18         parent.document.title="Decoder";
  19     }
  20 }
  21 </SCRIPT>
  22 <NOSCRIPT>
  23 </NOSCRIPT>
  24
  25 </HEAD>
  26
  27 <BODY BGCOLOR="white" onload="windowTitle();">
  28 <HR>
  29
  30
  31 <!-- ========= START OF TOP NAVBAR ======= -->
  32 <A NAME="navbar_top"><!-- --></A>
  33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  35 <TR>
  36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  37 <A NAME="navbar_top_firstrow"><!-- --></A>
  38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  39   <TR ALIGN="center" VALIGN="top">
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  42   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  47   </TR>
  48 </TABLE>
  49 </TD>
  50 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  51 </EM>
  52 </TD>
  53 </TR>
  54
  55 <TR>
  56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  57 &nbsp;PREV CLASS&nbsp;
  58 &nbsp;<A HREF="../../../../../com/google/zxing/qrcode/decoder/ErrorCorrectionLevel.html" title="class in com.google.zxing.qrcode.decoder"><B>NEXT CLASS</B></A></FONT></TD>
  59 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  60   <A HREF="../../../../../index.html?com/google/zxing/qrcode/decoder/Decoder.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  61 &nbsp;<A HREF="Decoder.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  62 &nbsp;<SCRIPT type="text/javascript">
  63   <!--
  64   if(window==top) {
  65     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  66   }
  67   //-->
  68 </SCRIPT>
  69 <NOSCRIPT>
  70   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
  71 </NOSCRIPT>
  72
  73
  74 </FONT></TD>
  75 </TR>
  76 <TR>
  77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  78   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  79 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  80 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  81 </TR>
  82 </TABLE>
  83 <A NAME="skip-navbar_top"></A>
  84 <!-- ========= END OF TOP NAVBAR ========= -->
  85
  86 <HR>
  87 <!-- ======== START OF CLASS DATA ======== -->
  88 <H2>
  89 <FONT SIZE="-1">
  90 com.google.zxing.qrcode.decoder</FONT>
  91 <BR>
  92 Class Decoder</H2>
  93 <PRE>
  94 java.lang.Object
  95   <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.google.zxing.qrcode.decoder.Decoder</B>
  96 </PRE>
  97 <HR>
  98 <DL>
  99 <DT><PRE>public final class <B>Decoder</B><DT>extends java.lang.Object</DL>
 100 </PRE>
 101
 102 <P>
 103 <p>The main class which implements QR Code decoding -- as opposed to locating and extracting
 104  the QR Code from an image.</p>
 105 <P>
 106
 107 <P>
 108 <DL>
 109 <DT><B>Author:</B></DT>
 110   <DD>Sean Owen</DD>
 111 </DL>
 112 <HR>
 113
 114 <P>
 115
 116 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 117
 118 <A NAME="constructor_summary"><!-- --></A>
 119 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 120 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 121 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 122 <B>Constructor Summary</B></FONT></TH>
 123 </TR>
 124 <TR BGCOLOR="white" CLASS="TableRowColor">
 125 <TD><CODE><B><A HREF="../../../../../com/google/zxing/qrcode/decoder/Decoder.html#Decoder()">Decoder</A></B>()</CODE>
 126
 127 <BR>
 128 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 129 </TR>
 130 </TABLE>
 131 &nbsp;
 132 <!-- ========== METHOD SUMMARY =========== -->
 133
 134 <A NAME="method_summary"><!-- --></A>
 135 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 136 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 137 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 138 <B>Method Summary</B></FONT></TH>
 139 </TR>
 140 <TR BGCOLOR="white" CLASS="TableRowColor">
 141 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 142 <CODE>&nbsp;<A HREF="../../../../../com/google/zxing/common/DecoderResult.html" title="class in com.google.zxing.common">DecoderResult</A></CODE></FONT></TD>
 143 <TD><CODE><B><A HREF="../../../../../com/google/zxing/qrcode/decoder/Decoder.html#decode(com.google.zxing.common.BitMatrix)">decode</A></B>(<A HREF="../../../../../com/google/zxing/common/BitMatrix.html" title="class in com.google.zxing.common">BitMatrix</A>&nbsp;bits)</CODE>
 144
 145 <BR>
 146 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decodes a QR Code represented as a <A HREF="../../../../../com/google/zxing/common/BitMatrix.html" title="class in com.google.zxing.common"><CODE>BitMatrix</CODE></A>.</TD>
 147 </TR>
 148 <TR BGCOLOR="white" CLASS="TableRowColor">
 149 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 150 <CODE>&nbsp;<A HREF="../../../../../com/google/zxing/common/DecoderResult.html" title="class in com.google.zxing.common">DecoderResult</A></CODE></FONT></TD>
 151 <TD><CODE><B><A HREF="../../../../../com/google/zxing/qrcode/decoder/Decoder.html#decode(boolean[][])">decode</A></B>(boolean[][]&nbsp;image)</CODE>
 152
 153 <BR>
 154 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convenience method that can decode a QR Code represented as a 2D array of booleans.</TD>
 155 </TR>
 156 </TABLE>
 157 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 158 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 159 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 160 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
 161 </TR>
 162 <TR BGCOLOR="white" CLASS="TableRowColor">
 163 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
 164 </TR>
 165 </TABLE>
 166 &nbsp;
 167 <P>
 168
 169 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 170
 171 <A NAME="constructor_detail"><!-- --></A>
 172 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 173 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 174 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 175 <B>Constructor Detail</B></FONT></TH>
 176 </TR>
 177 </TABLE>
 178
 179 <A NAME="Decoder()"><!-- --></A><H3>
 180 Decoder</H3>
 181 <PRE>
 182 public <B>Decoder</B>()</PRE>
 183 <DL>
 184 </DL>
 185
 186 <!-- ============ METHOD DETAIL ========== -->
 187
 188 <A NAME="method_detail"><!-- --></A>
 189 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 190 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 191 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 192 <B>Method Detail</B></FONT></TH>
 193 </TR>
 194 </TABLE>
 195
 196 <A NAME="decode(boolean[][])"><!-- --></A><H3>
 197 decode</H3>
 198 <PRE>
 199 public <A HREF="../../../../../com/google/zxing/common/DecoderResult.html" title="class in com.google.zxing.common">DecoderResult</A> <B>decode</B>(boolean[][]&nbsp;image)
 200                      throws <A HREF="../../../../../com/google/zxing/ReaderException.html" title="class in com.google.zxing">ReaderException</A></PRE>
 201 <DL>
 202 <DD><p>Convenience method that can decode a QR Code represented as a 2D array of booleans.
 203  "true" is taken to mean a black module.</p>
 204 <P>
 205 <DD><DL>
 206 <DT><B>Parameters:</B><DD><CODE>image</CODE> - booleans representing white/black QR Code modules
 207 <DT><B>Returns:</B><DD>text and bytes encoded within the QR Code
 208 <DT><B>Throws:</B>
 209 <DD><CODE><A HREF="../../../../../com/google/zxing/ReaderException.html" title="class in com.google.zxing">ReaderException</A></CODE> - if the QR Code cannot be decoded</DL>
 210 </DD>
 211 </DL>
 212 <HR>
 213
 214 <A NAME="decode(com.google.zxing.common.BitMatrix)"><!-- --></A><H3>
 215 decode</H3>
 216 <PRE>
 217 public <A HREF="../../../../../com/google/zxing/common/DecoderResult.html" title="class in com.google.zxing.common">DecoderResult</A> <B>decode</B>(<A HREF="../../../../../com/google/zxing/common/BitMatrix.html" title="class in com.google.zxing.common">BitMatrix</A>&nbsp;bits)
 218                      throws <A HREF="../../../../../com/google/zxing/ReaderException.html" title="class in com.google.zxing">ReaderException</A></PRE>
 219 <DL>
 220 <DD><p>Decodes a QR Code represented as a <A HREF="../../../../../com/google/zxing/common/BitMatrix.html" title="class in com.google.zxing.common"><CODE>BitMatrix</CODE></A>. A 1 or "true" is taken to mean a black module.</p>
 221 <P>
 222 <DD><DL>
 223 <DT><B>Parameters:</B><DD><CODE>bits</CODE> - booleans representing white/black QR Code modules
 224 <DT><B>Returns:</B><DD>text and bytes encoded within the QR Code
 225 <DT><B>Throws:</B>
 226 <DD><CODE><A HREF="../../../../../com/google/zxing/ReaderException.html" title="class in com.google.zxing">ReaderException</A></CODE> - if the QR Code cannot be decoded</DL>
 227 </DD>
 228 </DL>
 229 <!-- ========= END OF CLASS DATA ========= -->
 230 <HR>
 231
 232
 233 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 234 <A NAME="navbar_bottom"><!-- --></A>
 235 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 236 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 237 <TR>
 238 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 239 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 240 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 241   <TR ALIGN="center" VALIGN="top">
 242   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 243   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 244   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 245   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 246   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 247   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 248   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 249   </TR>
 250 </TABLE>
 251 </TD>
 252 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 253 <script type="text/javascript"> var gaJsHost = (("https:" == document.location.protocol) ?  "https://ssl." : "http://www."); document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); </script> <script type="text/javascript"> var pageTracker = _gat._getTracker("UA-788492-5"); pageTracker._initData(); pageTracker._trackPageview(); </script></EM>
 254 </TD>
 255 </TR>
 256
 257 <TR>
 258 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 259 &nbsp;PREV CLASS&nbsp;
 260 &nbsp;<A HREF="../../../../../com/google/zxing/qrcode/decoder/ErrorCorrectionLevel.html" title="class in com.google.zxing.qrcode.decoder"><B>NEXT CLASS</B></A></FONT></TD>
 261 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 262   <A HREF="../../../../../index.html?com/google/zxing/qrcode/decoder/Decoder.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 263 &nbsp;<A HREF="Decoder.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 264 &nbsp;<SCRIPT type="text/javascript">
 265   <!--
 266   if(window==top) {
 267     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 268   }
 269   //-->
 270 </SCRIPT>
 271 <NOSCRIPT>
 272   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 273 </NOSCRIPT>
 274
 275
 276 </FONT></TD>
 277 </TR>
 278 <TR>
 279 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 280   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 281 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 282 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 283 </TR>
 284 </TABLE>
 285 <A NAME="skip-navbar_bottom"></A>
 286 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 287
 288 <HR>
 289
 290 </BODY>
 291 </HTML>