upstream version 1.2.2
[debian/freetts] / javadoc / com / sun / speech / freetts / PhoneDuration.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:29 CET 2009 -->\r
6 <TITLE>\r
7 PhoneDuration (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.PhoneDuration 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="PhoneDuration (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/PathExtractorImpl.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
53 &nbsp;<A HREF="../../../../com/sun/speech/freetts/PhoneDurationsImpl.html" title="class in com.sun.speech.freetts"><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="PhoneDuration.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</FONT>\r
85 <BR>\r
86 Class PhoneDuration</H2>\r
87 <PRE>\r
88 java.lang.Object\r
89   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.PhoneDuration</B>\r
90 </PRE>\r
91 <HR>\r
92 <DL>\r
93 <DT>public class <B>PhoneDuration</B><DT>extends java.lang.Object</DL>\r
94 \r
95 <P>\r
96 Maintains the mean duration and standard deviation about a phone.
97  These are meant to be used by the code that calculates segment
98  durations via statistical methods, and are paired with the phone
99  by <code>PhoneDurations</code>.\r
100 <P>\r
101 \r
102 <P>\r
103 <DL>\r
104 <DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/PhoneDurations.html" title="interface in com.sun.speech.freetts"><CODE>PhoneDurations</CODE></A></DL>\r
105 <HR>\r
106 \r
107 <P>\r
108 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
109 \r
110 \r
111 <!-- =========== FIELD SUMMARY =========== -->\r
112 \r
113 \r
114 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
115 \r
116 <A NAME="constructor_summary"><!-- --></A>
117 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
118 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
119 <TD COLSPAN=2><FONT SIZE="+2">\r
120 <B>Constructor Summary</B></FONT></TD>\r
121 </TR>\r
122 <TR BGCOLOR="white" CLASS="TableRowColor">\r
123 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/PhoneDuration.html#PhoneDuration(float, float)">PhoneDuration</A></B>(float&nbsp;mean,
124               float&nbsp;standardDeviation)</CODE>\r
125 \r
126 <BR>\r
127 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new <code>PhoneDuration</code> with the given mean
128  and standard deviation.</TD>\r
129 </TR>\r
130 </TABLE>\r
131 &nbsp;\r
132 <!-- ========== METHOD SUMMARY =========== -->\r
133 \r
134 <A NAME="method_summary"><!-- --></A>
135 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
136 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
137 <TD COLSPAN=2><FONT SIZE="+2">\r
138 <B>Method Summary</B></FONT></TD>\r
139 </TR>\r
140 <TR BGCOLOR="white" CLASS="TableRowColor">\r
141 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
142 <CODE>&nbsp;float</CODE></FONT></TD>\r
143 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/PhoneDuration.html#getMean()">getMean</A></B>()</CODE>\r
144 \r
145 <BR>\r
146 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the mean.  </TD>\r
147 </TR>\r
148 <TR BGCOLOR="white" CLASS="TableRowColor">\r
149 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
150 <CODE>&nbsp;float</CODE></FONT></TD>\r
151 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/PhoneDuration.html#getStandardDeviation()">getStandardDeviation</A></B>()</CODE>\r
152 \r
153 <BR>\r
154 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the standard deviation from the mean.</TD>\r
155 </TR>\r
156 </TABLE>\r
157 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
158 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
159 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
160 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
161 </TR>\r
162 <TR BGCOLOR="white" CLASS="TableRowColor">\r
163 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
164 </TR>\r
165 </TABLE>\r
166 &nbsp;\r
167 <P>\r
168 \r
169 <!-- ============ FIELD DETAIL =========== -->\r
170 \r
171 \r
172 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
173 \r
174 <A NAME="constructor_detail"><!-- --></A>
175 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
176 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
177 <TD COLSPAN=1><FONT SIZE="+2">\r
178 <B>Constructor Detail</B></FONT></TD>\r
179 </TR>\r
180 </TABLE>\r
181 \r
182 <A NAME="PhoneDuration(float, float)"><!-- --></A><H3>\r
183 PhoneDuration</H3>\r
184 <PRE>\r
185 public <B>PhoneDuration</B>(float&nbsp;mean,
186                      float&nbsp;standardDeviation)</PRE>\r
187 <DL>\r
188 <DD>Creates a new <code>PhoneDuration</code> with the given mean
189  and standard deviation.\r
190 <P>\r
191 <DT><B>Parameters:</B><DD><CODE>mean</CODE> - mean duration, typically in seconds<DD><CODE>standardDeviation</CODE> - standardDeviation from the mean</DL>\r
192 \r
193 <!-- ============ METHOD DETAIL ========== -->\r
194 \r
195 <A NAME="method_detail"><!-- --></A>
196 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
197 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
198 <TD COLSPAN=1><FONT SIZE="+2">\r
199 <B>Method Detail</B></FONT></TD>\r
200 </TR>\r
201 </TABLE>\r
202 \r
203 <A NAME="getMean()"><!-- --></A><H3>\r
204 getMean</H3>\r
205 <PRE>\r
206 public float <B>getMean</B>()</PRE>\r
207 <DL>\r
208 <DD>Gets the mean.  The return value is typically in seconds.\r
209 <P>\r
210 <DD><DL>\r
211
212 <DT><B>Returns:</B><DD>the mean</DL>\r
213 </DD>\r
214 </DL>\r
215 <HR>\r
216 \r
217 <A NAME="getStandardDeviation()"><!-- --></A><H3>\r
218 getStandardDeviation</H3>\r
219 <PRE>\r
220 public float <B>getStandardDeviation</B>()</PRE>\r
221 <DL>\r
222 <DD>Gets the standard deviation from the mean.\r
223 <P>\r
224 <DD><DL>\r
225
226 <DT><B>Returns:</B><DD>the standard deviation from the mean</DL>\r
227 </DD>\r
228 </DL>\r
229 <!-- ========= END OF CLASS DATA ========= -->\r
230 <HR>\r
231 \r
232
233 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
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="">\r
237 <TR>\r
238 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
239 <A NAME="navbar_bottom_firstrow"><!-- --></A>
240 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
241   <TR ALIGN="center" VALIGN="top">\r
242   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
243   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
244   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
245   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
246   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
247   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
248   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
249   </TR>\r
250 </TABLE>\r
251 </TD>\r
252 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
253 </EM>\r
254 </TD>\r
255 </TR>\r
256 \r
257 <TR>\r
258 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
259 &nbsp;<A HREF="../../../../com/sun/speech/freetts/PathExtractorImpl.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
260 &nbsp;<A HREF="../../../../com/sun/speech/freetts/PhoneDurationsImpl.html" title="class in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>\r
261 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
262   <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
263 &nbsp;<A HREF="PhoneDuration.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
264 &nbsp;<SCRIPT type="text/javascript">\r
265   <!--\r
266   if(window==top) {\r
267     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
268   }\r
269   //-->\r
270 </SCRIPT>\r
271 <NOSCRIPT>\r
272   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
273 </NOSCRIPT>
274 \r
275 </FONT></TD>\r
276 </TR>\r
277 <TR>\r
278 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
279   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
280 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
281 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
282 </TR>\r
283 </TABLE>\r
284 <A NAME="skip-navbar_bottom"></A>
285 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
286 \r
287 <HR>\r
288 \r
289 </BODY>\r
290 </HTML>\r