1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.4.2_16) on Mon Mar 09 18:20:29 CET 2009 -->
\r
7 Intonator (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.cart.Intonator class">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 parent.document.title="Intonator (FreeTTS 1.2)";
\r
23 <BODY BGCOLOR="white" onload="windowTitle();">
\r
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
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> </TD>
\r
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
45 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
51 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
52 <A HREF="../../../../../com/sun/speech/freetts/cart/Durator.html" title="class in com.sun.speech.freetts.cart"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../../com/sun/speech/freetts/cart/Phraser.html" title="class in com.sun.speech.freetts.cart"><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>
\r
56 <A HREF="Intonator.html" target="_top"><B>NO FRAMES</B></A>
\r
57 <SCRIPT type="text/javascript">
\r
60 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
65 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
72 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
74 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
77 <A NAME="skip-navbar_top"></A>
78 <!-- ========= END OF TOP NAVBAR ========= -->
\r
81 <!-- ======== START OF CLASS DATA ======== -->
\r
84 com.sun.speech.freetts.cart</FONT>
\r
86 Class Intonator</H2>
\r
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.cart.Intonator</B>
\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
96 <DT>public class <B>Intonator</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
99 Annotates the <code>Relation.SYLLABLE</code> relations of an
100 utterance with "accent"
101 and "endtone" features. Though not required, a typical use of
102 this is to use the ToBI (tones and break indeces) scheme for
103 transcribing intonation and accent in English, developed by Janet
104 Pierrehumbert and Mary Beckman. This implementation is independent
105 of the ToBI scheme: ToBI annotations are not
106 used by this class, but are merely copied from the CART result
107 to the "accent" and "endtone" features of the
108 <code>Relation.SYLLABLE</code> relation.
\r
115 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
118 <!-- =========== FIELD SUMMARY =========== -->
\r
120 <A NAME="field_summary"><!-- --></A>
121 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
122 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
123 <TD COLSPAN=2><FONT SIZE="+2">
\r
124 <B>Field Summary</B></FONT></TD>
\r
126 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
127 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
128 <CODE>protected <A HREF="../../../../../com/sun/speech/freetts/cart/CART.html" title="interface in com.sun.speech.freetts.cart">CART</A></CODE></FONT></TD>
\r
129 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/cart/Intonator.html#accentCart">accentCart</A></B></CODE>
\r
132 The accent CART used for this Intonation UtteranceProcessor. </TD>
\r
134 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
135 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
136 <CODE>protected <A HREF="../../../../../com/sun/speech/freetts/cart/CART.html" title="interface in com.sun.speech.freetts.cart">CART</A></CODE></FONT></TD>
\r
137 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/cart/Intonator.html#toneCart">toneCart</A></B></CODE>
\r
140 The tone CART used for this Intonation UtteranceProcessor. </TD>
\r
144 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
146 <A NAME="constructor_summary"><!-- --></A>
147 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
148 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
149 <TD COLSPAN=2><FONT SIZE="+2">
\r
150 <B>Constructor Summary</B></FONT></TD>
\r
152 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
153 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/cart/Intonator.html#Intonator(com.sun.speech.freetts.cart.CART, com.sun.speech.freetts.cart.CART)">Intonator</A></B>(<A HREF="../../../../../com/sun/speech/freetts/cart/CART.html" title="interface in com.sun.speech.freetts.cart">CART</A> accentCart,
154 <A HREF="../../../../../com/sun/speech/freetts/cart/CART.html" title="interface in com.sun.speech.freetts.cart">CART</A> toneCart)</CODE>
\r
157 Creates a new Intonation UtteranceProcessor with the given
162 <!-- ========== METHOD SUMMARY =========== -->
\r
164 <A NAME="method_summary"><!-- --></A>
165 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
166 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
167 <TD COLSPAN=2><FONT SIZE="+2">
\r
168 <B>Method Summary</B></FONT></TD>
\r
170 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
171 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
172 <CODE> void</CODE></FONT></TD>
\r
173 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/cart/Intonator.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> utterance)</CODE>
\r
176 Annotates the <code>Relation.SYLLABLE</code> relations of an
177 utterance with "accent"
178 and "endtone" features. </TD>
\r
180 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
181 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
182 <CODE> java.lang.String</CODE></FONT></TD>
\r
183 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/cart/Intonator.html#toString()">toString</A></B>()</CODE>
\r
186 </TD>
\r
189 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
190 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
191 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
192 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
194 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
195 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
\r
201 <!-- ============ FIELD DETAIL =========== -->
\r
203 <A NAME="field_detail"><!-- --></A>
204 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
205 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
206 <TD COLSPAN=1><FONT SIZE="+2">
\r
207 <B>Field Detail</B></FONT></TD>
\r
211 <A NAME="accentCart"><!-- --></A><H3>
\r
214 protected <A HREF="../../../../../com/sun/speech/freetts/cart/CART.html" title="interface in com.sun.speech.freetts.cart">CART</A> <B>accentCart</B></PRE>
\r
216 <DD>The accent CART used for this Intonation UtteranceProcessor. It is
217 passed into the constructor.
\r
224 <A NAME="toneCart"><!-- --></A><H3>
\r
227 protected <A HREF="../../../../../com/sun/speech/freetts/cart/CART.html" title="interface in com.sun.speech.freetts.cart">CART</A> <B>toneCart</B></PRE>
\r
229 <DD>The tone CART used for this Intonation UtteranceProcessor. It is
230 passed into the constructor.
\r
236 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
238 <A NAME="constructor_detail"><!-- --></A>
239 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
240 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
241 <TD COLSPAN=1><FONT SIZE="+2">
\r
242 <B>Constructor Detail</B></FONT></TD>
\r
246 <A NAME="Intonator(com.sun.speech.freetts.cart.CART, com.sun.speech.freetts.cart.CART)"><!-- --></A><H3>
\r
249 public <B>Intonator</B>(<A HREF="../../../../../com/sun/speech/freetts/cart/CART.html" title="interface in com.sun.speech.freetts.cart">CART</A> accentCart,
250 <A HREF="../../../../../com/sun/speech/freetts/cart/CART.html" title="interface in com.sun.speech.freetts.cart">CART</A> toneCart)</PRE>
\r
252 <DD>Creates a new Intonation UtteranceProcessor with the given
255 <DT><B>Parameters:</B><DD><CODE>accentCart</CODE> - the CART for doing accents<DD><CODE>toneCart</CODE> - the CART for doing end tones</DL>
\r
257 <!-- ============ METHOD DETAIL ========== -->
\r
259 <A NAME="method_detail"><!-- --></A>
260 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
261 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
262 <TD COLSPAN=1><FONT SIZE="+2">
\r
263 <B>Method Detail</B></FONT></TD>
\r
267 <A NAME="processUtterance(com.sun.speech.freetts.Utterance)"><!-- --></A><H3>
\r
268 processUtterance</H3>
\r
270 public void <B>processUtterance</B>(<A HREF="../../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A> utterance)
271 throws <A HREF="../../../../../com/sun/speech/freetts/ProcessException.html" title="class in com.sun.speech.freetts">ProcessException</A></PRE>
\r
273 <DD>Annotates the <code>Relation.SYLLABLE</code> relations of an
274 utterance with "accent"
275 and "endtone" features. Depends upon "NONE" being returned by
276 either the accent or tone CART to indicate there isn't an
277 intonation feature for a syllable.
\r
280 <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
283 <DT><B>Parameters:</B><DD><CODE>utterance</CODE> - the utterance to process/tokenize
285 <DD><CODE><A HREF="../../../../../com/sun/speech/freetts/ProcessException.html" title="class in com.sun.speech.freetts">ProcessException</A></CODE> - if an IOException is thrown during the
286 processing of the utterance</DL>
\r
291 <A NAME="toString()"><!-- --></A><H3>
\r
294 public java.lang.String <B>toString</B>()</PRE>
\r
303 <!-- ========= END OF CLASS DATA ========= -->
\r
307 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
308 <A NAME="navbar_bottom"><!-- --></A>
309 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
310 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
312 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
313 <A NAME="navbar_bottom_firstrow"><!-- --></A>
314 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
315 <TR ALIGN="center" VALIGN="top">
\r
316 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
317 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
318 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
319 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
320 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
321 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
322 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
326 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
332 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
333 <A HREF="../../../../../com/sun/speech/freetts/cart/Durator.html" title="class in com.sun.speech.freetts.cart"><B>PREV CLASS</B></A>
\r
334 <A HREF="../../../../../com/sun/speech/freetts/cart/Phraser.html" title="class in com.sun.speech.freetts.cart"><B>NEXT CLASS</B></A></FONT></TD>
\r
335 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
336 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
337 <A HREF="Intonator.html" target="_top"><B>NO FRAMES</B></A>
\r
338 <SCRIPT type="text/javascript">
\r
341 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
346 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
352 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
353 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
354 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
355 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
358 <A NAME="skip-navbar_bottom"></A>
359 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r