upstream version 1.2.2
[debian/freetts] / javadoc / com / sun / speech / freetts / diphone / DiphonePitchmarkGenerator.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 DiphonePitchmarkGenerator (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.diphone.DiphonePitchmarkGenerator 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="DiphonePitchmarkGenerator (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;<A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html" title="class in com.sun.speech.freetts.diphone"><B>PREV CLASS</B></A>&nbsp;\r
53 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/diphone/DiphoneUnitDatabase.html" title="class in com.sun.speech.freetts.diphone"><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="DiphonePitchmarkGenerator.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.diphone</FONT>\r
85 <BR>\r
86 Class DiphonePitchmarkGenerator</H2>\r
87 <PRE>\r
88 java.lang.Object\r
89   <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.diphone.DiphonePitchmarkGenerator</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>DiphonePitchmarkGenerator</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 pitchmarks. This is an utterance processor that expects
100  the utterance to have a target relation. It will create an
101  LPCResult and add it to the utterance based upon features of the
102  target relation.\r
103 <P>\r
104 \r
105 <P>\r
106 <DL>\r
107 <DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/freetts/relp/LPCResult.html" title="class in com.sun.speech.freetts.relp"><CODE>LPCResult</CODE></A>, 
108 <A HREF="../../../../../com/sun/speech/freetts/Relation.html" title="class in com.sun.speech.freetts"><CODE>Relation</CODE></A>, 
109 <A HREF="../../../../../com/sun/speech/freetts/relp/SampleInfo.html" title="class in com.sun.speech.freetts.relp"><CODE>SampleInfo</CODE></A></DL>\r
110 <HR>\r
111 \r
112 <P>\r
113 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
114 \r
115 \r
116 <!-- =========== FIELD SUMMARY =========== -->\r
117 \r
118 \r
119 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
120 \r
121 <A NAME="constructor_summary"><!-- --></A>
122 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
123 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
124 <TD COLSPAN=2><FONT SIZE="+2">\r
125 <B>Constructor Summary</B></FONT></TD>\r
126 </TR>\r
127 <TR BGCOLOR="white" CLASS="TableRowColor">\r
128 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/diphone/DiphonePitchmarkGenerator.html#DiphonePitchmarkGenerator()">DiphonePitchmarkGenerator</A></B>()</CODE>\r
129 \r
130 <BR>\r
131 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
132 </TR>\r
133 </TABLE>\r
134 &nbsp;\r
135 <!-- ========== METHOD SUMMARY =========== -->\r
136 \r
137 <A NAME="method_summary"><!-- --></A>
138 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
139 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
140 <TD COLSPAN=2><FONT SIZE="+2">\r
141 <B>Method Summary</B></FONT></TD>\r
142 </TR>\r
143 <TR BGCOLOR="white" CLASS="TableRowColor">\r
144 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
145 <CODE>&nbsp;void</CODE></FONT></TD>\r
146 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/diphone/DiphonePitchmarkGenerator.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
147 \r
148 <BR>\r
149 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Generates the LPCResult for this utterance.</TD>\r
150 </TR>\r
151 <TR BGCOLOR="white" CLASS="TableRowColor">\r
152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
153 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
154 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/diphone/DiphonePitchmarkGenerator.html#toString()">toString</A></B>()</CODE>\r
155 \r
156 <BR>\r
157 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string representation of this object.</TD>\r
158 </TR>\r
159 </TABLE>\r
160 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
161 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
162 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
163 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
164 </TR>\r
165 <TR BGCOLOR="white" CLASS="TableRowColor">\r
166 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>\r
167 </TR>\r
168 </TABLE>\r
169 &nbsp;\r
170 <P>\r
171 \r
172 <!-- ============ FIELD DETAIL =========== -->\r
173 \r
174 \r
175 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
176 \r
177 <A NAME="constructor_detail"><!-- --></A>
178 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
179 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
180 <TD COLSPAN=1><FONT SIZE="+2">\r
181 <B>Constructor Detail</B></FONT></TD>\r
182 </TR>\r
183 </TABLE>\r
184 \r
185 <A NAME="DiphonePitchmarkGenerator()"><!-- --></A><H3>\r
186 DiphonePitchmarkGenerator</H3>\r
187 <PRE>\r
188 public <B>DiphonePitchmarkGenerator</B>()</PRE>\r
189 <DL>\r
190 </DL>\r
191 \r
192 <!-- ============ METHOD DETAIL ========== -->\r
193 \r
194 <A NAME="method_detail"><!-- --></A>
195 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
196 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
197 <TD COLSPAN=1><FONT SIZE="+2">\r
198 <B>Method Detail</B></FONT></TD>\r
199 </TR>\r
200 </TABLE>\r
201 \r
202 <A NAME="processUtterance(com.sun.speech.freetts.Utterance)"><!-- --></A><H3>\r
203 processUtterance</H3>\r
204 <PRE>\r
205 public void <B>processUtterance</B>(<A HREF="../../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A>&nbsp;utterance)
206                       throws <A HREF="../../../../../com/sun/speech/freetts/ProcessException.html" title="class in com.sun.speech.freetts">ProcessException</A></PRE>\r
207 <DL>\r
208 <DD>Generates the LPCResult for this utterance.\r
209 <P>\r
210 <DD><DL>\r
211 <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
212 </DD>\r
213 <DD><DL>\r
214 <DT><B>Parameters:</B><DD><CODE>utterance</CODE> - the utterance to process
215 <DT><B>Throws:</B>
216 <DD><CODE><A HREF="../../../../../com/sun/speech/freetts/ProcessException.html" title="class in com.sun.speech.freetts">ProcessException</A></CODE> - if an error occurs while processing
217      the utterance
218 <DD><CODE>java.lang.IllegalStateException</CODE> - if the given utterance has no
219                 relation named Relation.TARGET or a feature named
220                 SampleInfo.UTT_NAME</DL>\r
221 </DD>\r
222 </DL>\r
223 <HR>\r
224 \r
225 <A NAME="toString()"><!-- --></A><H3>\r
226 toString</H3>\r
227 <PRE>\r
228 public java.lang.String <B>toString</B>()</PRE>\r
229 <DL>\r
230 <DD>Returns a string representation of this object.\r
231 <P>\r
232 <DD><DL>\r
233 </DL>\r
234 </DD>\r
235 <DD><DL>\r
236
237 <DT><B>Returns:</B><DD>a string representation of this object</DL>\r
238 </DD>\r
239 </DL>\r
240 <!-- ========= END OF CLASS DATA ========= -->\r
241 <HR>\r
242 \r
243
244 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
245 <A NAME="navbar_bottom"><!-- --></A>
246 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
247 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
248 <TR>\r
249 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
250 <A NAME="navbar_bottom_firstrow"><!-- --></A>
251 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
252   <TR ALIGN="center" VALIGN="top">\r
253   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
254   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
255   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
256   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
257   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
258   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
259   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
260   </TR>\r
261 </TABLE>\r
262 </TD>\r
263 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
264 </EM>\r
265 </TD>\r
266 </TR>\r
267 \r
268 <TR>\r
269 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
270 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html" title="class in com.sun.speech.freetts.diphone"><B>PREV CLASS</B></A>&nbsp;\r
271 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/diphone/DiphoneUnitDatabase.html" title="class in com.sun.speech.freetts.diphone"><B>NEXT CLASS</B></A></FONT></TD>\r
272 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
273   <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
274 &nbsp;<A HREF="DiphonePitchmarkGenerator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
275 &nbsp;<SCRIPT type="text/javascript">\r
276   <!--\r
277   if(window==top) {\r
278     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
279   }\r
280   //-->\r
281 </SCRIPT>\r
282 <NOSCRIPT>\r
283   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
284 </NOSCRIPT>
285 \r
286 </FONT></TD>\r
287 </TR>\r
288 <TR>\r
289 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
290   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
291 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
292 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
293 </TR>\r
294 </TABLE>\r
295 <A NAME="skip-navbar_bottom"></A>
296 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
297 \r
298 <HR>\r
299 \r
300 </BODY>\r
301 </HTML>\r