add a cleanup script to elide the non-free jsapi binary blob from the sources
[debian/freetts] / javadoc / com / sun / speech / freetts / en / ContourGenerator.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
2 <!--NewPage-->\r
3 <HTML>\r
4 <HEAD>\r
5 <!-- Generated by javadoc (build 1.4.2_16) on Mon Mar 09 18:20:30 CET 2009 -->\r
6 <TITLE>\r
7 ContourGenerator (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.en.ContourGenerator class">\r
11 \r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">\r
13 \r
14 <SCRIPT type="text/javascript">\r
15 function windowTitle()\r
16 {\r
17     parent.document.title="ContourGenerator (FreeTTS 1.2)";\r
18 }\r
19 </SCRIPT>\r
20 \r
21 </HEAD>\r
22 \r
23 <BODY BGCOLOR="white" onload="windowTitle();">\r
24 \r
25
26 <!-- ========= START OF TOP NAVBAR ======= -->\r
27 <A NAME="navbar_top"><!-- --></A>
28 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
30 <TR>\r
31 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
32 <A NAME="navbar_top_firstrow"><!-- --></A>
33 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
34   <TR ALIGN="center" VALIGN="top">\r
35   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
36   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
37   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
39   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
42   </TR>\r
43 </TABLE>\r
44 </TD>\r
45 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
46 </EM>\r
47 </TD>\r
48 </TR>\r
49 \r
50 <TR>\r
51 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
52 &nbsp;PREV CLASS&nbsp;\r
53 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/en/PartOfSpeechTagger.html" title="class in com.sun.speech.freetts.en"><B>NEXT CLASS</B></A></FONT></TD>\r
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
55   <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
56 &nbsp;<A HREF="ContourGenerator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
57 &nbsp;<SCRIPT type="text/javascript">\r
58   <!--\r
59   if(window==top) {\r
60     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
61   }\r
62   //-->\r
63 </SCRIPT>\r
64 <NOSCRIPT>\r
65   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
66 </NOSCRIPT>
67 \r
68 </FONT></TD>\r
69 </TR>\r
70 <TR>\r
71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
72   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
74 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
75 </TR>\r
76 </TABLE>\r
77 <A NAME="skip-navbar_top"></A>
78 <!-- ========= END OF TOP NAVBAR ========= -->\r
79 \r
80 <HR>\r
81 <!-- ======== START OF CLASS DATA ======== -->\r
82 <H2>\r
83 <FONT SIZE="-1">\r
84 com.sun.speech.freetts.en</FONT>\r
85 <BR>\r
86 Class ContourGenerator</H2>\r
87 <PRE>\r
88 java.lang.Object\r
89   <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.en.ContourGenerator</B>\r
90 </PRE>\r
91 <DL>\r
92 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../com/sun/speech/freetts/UtteranceProcessor.html" title="interface in com.sun.speech.freetts">UtteranceProcessor</A></DD>\r
93 </DL>\r
94 <HR>\r
95 <DL>\r
96 <DT>public class <B>ContourGenerator</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../com/sun/speech/freetts/UtteranceProcessor.html" title="interface in com.sun.speech.freetts">UtteranceProcessor</A></DL>\r
97 \r
98 <P>\r
99 Calculates the F0 curve for an utterance based on the Black and
100  Hunt article "Generating F0 Contours from ToBI Labels Using Linear
101  Regression," ICSLP96, vol.&nbsp;3, pp 1385-1388, Philadelphia,
102  PA.&nbsp;1996.\r
103 <P>\r
104 \r
105 <P>\r
106 <HR>\r
107 \r
108 <P>\r
109 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
110 \r
111 \r
112 <!-- =========== FIELD SUMMARY =========== -->\r
113 \r
114 \r
115 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
116 \r
117 <A NAME="constructor_summary"><!-- --></A>
118 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
119 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
120 <TD COLSPAN=2><FONT SIZE="+2">\r
121 <B>Constructor Summary</B></FONT></TD>\r
122 </TR>\r
123 <TR BGCOLOR="white" CLASS="TableRowColor">\r
124 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/ContourGenerator.html#ContourGenerator(java.net.URL, float, float)">ContourGenerator</A></B>(java.net.URL&nbsp;url,
125                  float&nbsp;modelMean,
126                  float&nbsp;modelStddev)</CODE>\r
127 \r
128 <BR>\r
129 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a ContourGenerator utterance processor.</TD>\r
130 </TR>\r
131 </TABLE>\r
132 &nbsp;\r
133 <!-- ========== METHOD SUMMARY =========== -->\r
134 \r
135 <A NAME="method_summary"><!-- --></A>
136 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
137 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
138 <TD COLSPAN=2><FONT SIZE="+2">\r
139 <B>Method Summary</B></FONT></TD>\r
140 </TR>\r
141 <TR BGCOLOR="white" CLASS="TableRowColor">\r
142 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
143 <CODE>protected &nbsp;void</CODE></FONT></TD>\r
144 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/ContourGenerator.html#parseAndAdd(java.util.List, java.lang.String)">parseAndAdd</A></B>(java.util.List&nbsp;list,
145             java.lang.String&nbsp;line)</CODE>\r
146 \r
147 <BR>\r
148 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parses the line into an F0ModelTerm.</TD>\r
149 </TR>\r
150 <TR BGCOLOR="white" CLASS="TableRowColor">\r
151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
152 <CODE>&nbsp;void</CODE></FONT></TD>\r
153 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/ContourGenerator.html#processUtterance(com.sun.speech.freetts.Utterance)">processUtterance</A></B>(<A HREF="../../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A>&nbsp;utterance)</CODE>\r
154 \r
155 <BR>\r
156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Generates the F0 contour for the utterance.</TD>\r
157 </TR>\r
158 <TR BGCOLOR="white" CLASS="TableRowColor">\r
159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
160 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
161 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/en/ContourGenerator.html#toString()">toString</A></B>()</CODE>\r
162 \r
163 <BR>\r
164 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the string representation of the object.</TD>\r
165 </TR>\r
166 </TABLE>\r
167 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
168 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
169 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
170 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
171 </TR>\r
172 <TR BGCOLOR="white" CLASS="TableRowColor">\r
173 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>\r
174 </TR>\r
175 </TABLE>\r
176 &nbsp;\r
177 <P>\r
178 \r
179 <!-- ============ FIELD DETAIL =========== -->\r
180 \r
181 \r
182 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
183 \r
184 <A NAME="constructor_detail"><!-- --></A>
185 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
186 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
187 <TD COLSPAN=1><FONT SIZE="+2">\r
188 <B>Constructor Detail</B></FONT></TD>\r
189 </TR>\r
190 </TABLE>\r
191 \r
192 <A NAME="ContourGenerator(java.net.URL, float, float)"><!-- --></A><H3>\r
193 ContourGenerator</H3>\r
194 <PRE>\r
195 public <B>ContourGenerator</B>(java.net.URL&nbsp;url,
196                         float&nbsp;modelMean,
197                         float&nbsp;modelStddev)
198                  throws java.io.IOException</PRE>\r
199 <DL>\r
200 <DD>Creates a ContourGenerator utterance processor.\r
201 <P>\r
202 <DT><B>Parameters:</B><DD><CODE>url</CODE> - source of the data<DD><CODE>modelMean</CODE> - the average frequency<DD><CODE>modelStddev</CODE> - the std deviation of the frequency
203 <DT><B>Throws:</B>
204 <DD><CODE>java.io.IOException</CODE> - if an error occurs while loading data</DL>\r
205 \r
206 <!-- ============ METHOD DETAIL ========== -->\r
207 \r
208 <A NAME="method_detail"><!-- --></A>
209 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
210 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
211 <TD COLSPAN=1><FONT SIZE="+2">\r
212 <B>Method Detail</B></FONT></TD>\r
213 </TR>\r
214 </TABLE>\r
215 \r
216 <A NAME="processUtterance(com.sun.speech.freetts.Utterance)"><!-- --></A><H3>\r
217 processUtterance</H3>\r
218 <PRE>\r
219 public void <B>processUtterance</B>(<A HREF="../../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A>&nbsp;utterance)
220                       throws <A HREF="../../../../../com/sun/speech/freetts/ProcessException.html" title="class in com.sun.speech.freetts">ProcessException</A></PRE>\r
221 <DL>\r
222 <DD>Generates the F0 contour for the utterance.\r
223 <P>\r
224 <DD><DL>\r
225 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/UtteranceProcessor.html#processUtterance(com.sun.speech.freetts.Utterance)">processUtterance</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/UtteranceProcessor.html" title="interface in com.sun.speech.freetts">UtteranceProcessor</A></CODE></DL>\r
226 </DD>\r
227 <DD><DL>\r
228 <DT><B>Parameters:</B><DD><CODE>utterance</CODE> - the utterance to process
229 <DT><B>Throws:</B>
230 <DD><CODE><A HREF="../../../../../com/sun/speech/freetts/ProcessException.html" title="class in com.sun.speech.freetts">ProcessException</A></CODE> - if an <code>IOException</code> is 
231                 thrown during the processing of the utterance</DL>\r
232 </DD>\r
233 </DL>\r
234 <HR>\r
235 \r
236 <A NAME="parseAndAdd(java.util.List, java.lang.String)"><!-- --></A><H3>\r
237 parseAndAdd</H3>\r
238 <PRE>\r
239 protected void <B>parseAndAdd</B>(java.util.List&nbsp;list,
240                            java.lang.String&nbsp;line)</PRE>\r
241 <DL>\r
242 <DD>Parses the line into an F0ModelTerm.\r
243 <P>\r
244 <DD><DL>\r
245 </DL>\r
246 </DD>\r
247 <DD><DL>\r
248 <DT><B>Parameters:</B><DD><CODE>list</CODE> - resulting F0ModelTerm is added to this list<DD><CODE>line</CODE> - the string to parse</DL>\r
249 </DD>\r
250 </DL>\r
251 <HR>\r
252 \r
253 <A NAME="toString()"><!-- --></A><H3>\r
254 toString</H3>\r
255 <PRE>\r
256 public java.lang.String <B>toString</B>()</PRE>\r
257 <DL>\r
258 <DD>Returns the string representation of the object.\r
259 <P>\r
260 <DD><DL>\r
261 </DL>\r
262 </DD>\r
263 <DD><DL>\r
264
265 <DT><B>Returns:</B><DD>the string representation of the object</DL>\r
266 </DD>\r
267 </DL>\r
268 <!-- ========= END OF CLASS DATA ========= -->\r
269 <HR>\r
270 \r
271
272 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
273 <A NAME="navbar_bottom"><!-- --></A>
274 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
275 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
276 <TR>\r
277 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
278 <A NAME="navbar_bottom_firstrow"><!-- --></A>
279 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
280   <TR ALIGN="center" VALIGN="top">\r
281   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
282   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
283   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
284   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
285   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
286   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
287   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
288   </TR>\r
289 </TABLE>\r
290 </TD>\r
291 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
292 </EM>\r
293 </TD>\r
294 </TR>\r
295 \r
296 <TR>\r
297 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
298 &nbsp;PREV CLASS&nbsp;\r
299 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/en/PartOfSpeechTagger.html" title="class in com.sun.speech.freetts.en"><B>NEXT CLASS</B></A></FONT></TD>\r
300 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
301   <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
302 &nbsp;<A HREF="ContourGenerator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
303 &nbsp;<SCRIPT type="text/javascript">\r
304   <!--\r
305   if(window==top) {\r
306     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
307   }\r
308   //-->\r
309 </SCRIPT>\r
310 <NOSCRIPT>\r
311   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
312 </NOSCRIPT>
313 \r
314 </FONT></TD>\r
315 </TR>\r
316 <TR>\r
317 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
318   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
319 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
320 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
321 </TR>\r
322 </TABLE>\r
323 <A NAME="skip-navbar_bottom"></A>
324 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
325 \r
326 <HR>\r
327 \r
328 </BODY>\r
329 </HTML>\r