Try adding current javadoc to SVN
[zxing.git] / docs / javadoc / com / google / zxing / qrcode / detector / FinderPattern.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 FinderPattern
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="FinderPattern";
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;<A HREF="../../../../../com/google/zxing/qrcode/detector/Detector.html" title="class in com.google.zxing.qrcode.detector"><B>PREV CLASS</B></A>&nbsp;
58 &nbsp;<A HREF="../../../../../com/google/zxing/qrcode/detector/FinderPatternFinder.html" title="class in com.google.zxing.qrcode.detector"><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/detector/FinderPattern.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61 &nbsp;<A HREF="FinderPattern.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;CONSTR&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;CONSTR&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.detector</FONT>
91 <BR>
92 Class FinderPattern</H2>
93 <PRE>
94 java.lang.Object
95   <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../com/google/zxing/ResultPoint.html" title="class in com.google.zxing">com.google.zxing.ResultPoint</A>
96       <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.google.zxing.qrcode.detector.FinderPattern</B>
97 </PRE>
98 <HR>
99 <DL>
100 <DT><PRE>public final class <B>FinderPattern</B><DT>extends <A HREF="../../../../../com/google/zxing/ResultPoint.html" title="class in com.google.zxing">ResultPoint</A></DL>
101 </PRE>
102
103 <P>
104 <p>Encapsulates a finder pattern, which are the three square patterns found in
105  the corners of QR Codes. It also encapsulates a count of similar finder patterns,
106  as a convenience to the finder's bookkeeping.</p>
107 <P>
108
109 <P>
110 <DL>
111 <DT><B>Author:</B></DT>
112   <DD>Sean Owen</DD>
113 </DL>
114 <HR>
115
116 <P>
117
118 <!-- ========== METHOD SUMMARY =========== -->
119
120 <A NAME="method_summary"><!-- --></A>
121 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
122 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
123 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
124 <B>Method Summary</B></FONT></TH>
125 </TR>
126 <TR BGCOLOR="white" CLASS="TableRowColor">
127 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
128 <CODE>&nbsp;float</CODE></FONT></TD>
129 <TD><CODE><B><A HREF="../../../../../com/google/zxing/qrcode/detector/FinderPattern.html#getEstimatedModuleSize()">getEstimatedModuleSize</A></B>()</CODE>
130
131 <BR>
132 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
133 </TR>
134 </TABLE>
135 &nbsp;<A NAME="methods_inherited_from_class_com.google.zxing.ResultPoint"><!-- --></A>
136 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
137 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
138 <TH ALIGN="left"><B>Methods inherited from class com.google.zxing.<A HREF="../../../../../com/google/zxing/ResultPoint.html" title="class in com.google.zxing">ResultPoint</A></B></TH>
139 </TR>
140 <TR BGCOLOR="white" CLASS="TableRowColor">
141 <TD><CODE><A HREF="../../../../../com/google/zxing/ResultPoint.html#crossProductZ(com.google.zxing.ResultPoint, com.google.zxing.ResultPoint, com.google.zxing.ResultPoint)">crossProductZ</A>, <A HREF="../../../../../com/google/zxing/ResultPoint.html#distance(com.google.zxing.ResultPoint, com.google.zxing.ResultPoint)">distance</A>, <A HREF="../../../../../com/google/zxing/ResultPoint.html#equals(java.lang.Object)">equals</A>, <A HREF="../../../../../com/google/zxing/ResultPoint.html#getX()">getX</A>, <A HREF="../../../../../com/google/zxing/ResultPoint.html#getY()">getY</A>, <A HREF="../../../../../com/google/zxing/ResultPoint.html#hashCode()">hashCode</A>, <A HREF="../../../../../com/google/zxing/ResultPoint.html#orderBestPatterns(com.google.zxing.ResultPoint[])">orderBestPatterns</A>, <A HREF="../../../../../com/google/zxing/ResultPoint.html#toString()">toString</A></CODE></TD>
142 </TR>
143 </TABLE>
144 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
145 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
146 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
147 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
148 </TR>
149 <TR BGCOLOR="white" CLASS="TableRowColor">
150 <TD><CODE>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
151 </TR>
152 </TABLE>
153 &nbsp;
154 <P>
155
156 <!-- ============ METHOD DETAIL ========== -->
157
158 <A NAME="method_detail"><!-- --></A>
159 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
160 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
161 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
162 <B>Method Detail</B></FONT></TH>
163 </TR>
164 </TABLE>
165
166 <A NAME="getEstimatedModuleSize()"><!-- --></A><H3>
167 getEstimatedModuleSize</H3>
168 <PRE>
169 public float <B>getEstimatedModuleSize</B>()</PRE>
170 <DL>
171 <DD><DL>
172 </DL>
173 </DD>
174 </DL>
175 <!-- ========= END OF CLASS DATA ========= -->
176 <HR>
177
178
179 <!-- ======= START OF BOTTOM NAVBAR ====== -->
180 <A NAME="navbar_bottom"><!-- --></A>
181 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
182 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
183 <TR>
184 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
185 <A NAME="navbar_bottom_firstrow"><!-- --></A>
186 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
187   <TR ALIGN="center" VALIGN="top">
188   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
189   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
190   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
191   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
192   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
193   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
194   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
195   </TR>
196 </TABLE>
197 </TD>
198 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
199 <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>
200 </TD>
201 </TR>
202
203 <TR>
204 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
205 &nbsp;<A HREF="../../../../../com/google/zxing/qrcode/detector/Detector.html" title="class in com.google.zxing.qrcode.detector"><B>PREV CLASS</B></A>&nbsp;
206 &nbsp;<A HREF="../../../../../com/google/zxing/qrcode/detector/FinderPatternFinder.html" title="class in com.google.zxing.qrcode.detector"><B>NEXT CLASS</B></A></FONT></TD>
207 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
208   <A HREF="../../../../../index.html?com/google/zxing/qrcode/detector/FinderPattern.html" target="_top"><B>FRAMES</B></A>  &nbsp;
209 &nbsp;<A HREF="FinderPattern.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
210 &nbsp;<SCRIPT type="text/javascript">
211   <!--
212   if(window==top) {
213     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
214   }
215   //-->
216 </SCRIPT>
217 <NOSCRIPT>
218   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
219 </NOSCRIPT>
220
221
222 </FONT></TD>
223 </TR>
224 <TR>
225 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
226   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
227 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
228 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
229 </TR>
230 </TABLE>
231 <A NAME="skip-navbar_bottom"></A>
232 <!-- ======== END OF BOTTOM NAVBAR ======= -->
233
234 <HR>
235
236 </BODY>
237 </HTML>