~ubuntu-branches/ubuntu/utopic/speech-tools/utopic-proposed

« back to all changes in this revision

Viewing changes to debian/patches/doc-main.diff

  • Committer: Package Import Robot
  • Author(s): Samuel Thibault, Samuel Thibault, Sergio Oller
  • Date: 2014-04-20 02:44:41 UTC
  • Revision ID: package-import@ubuntu.com-20140420024441-9vqkmx9m4gqjqyzr
Tags: 1:2.1~release-7
[ Samuel Thibault ]
* Team upload.
* rules: Remove config/config on clean.
* Bump Standards-Version to 3.9.5 (no changes).
* patches/doc-doc.diff: Fix build when libestools is not installed yet.
* rules: Do not install refman.pdf, it does not build.

[ Sergio Oller ]
* EST_Tokenstream: Add support to read from istream to reduce
  Festival HTS disk input/output usage.
* Add several methods to EST_WaveFile and EST_Wave to write waves
  by parts (header and data separately) in order improve text2wave
  performance in festival package on long texts.
* rules: dh_auto_clean must depend on dh_auto_configure to clean safely.
* Check fread worked when loading files: (Closes: #715728, #716618,
  #716578, #716193, #716464)
* Build -dbg packages.
* Build speech-tools-doc package.
* Allow "-pc LONGEST" in ch_wave. (LP: #723854)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
--- a/main/align_main.cc
 
2
+++ b/main/align_main.cc
 
3
@@ -63,33 +63,7 @@
 
4
 static void load_sentence(EST_Utterance &u, const EST_String &relname,
 
5
                          EST_String &relval);
 
6
 
 
7
-/** @name <command>align</command> <emphasis>align stream with reference stream</emphasis>
 
8
-    @id align-manual
 
9
-  * @toc
 
10
- */
 
11
 
 
12
-//@{
 
13
-
 
14
-
 
15
-/**@name Synopsis
 
16
-  */
 
17
-//@{
 
18
-
 
19
-//@synopsis
 
20
-
 
21
-/**
 
22
-
 
23
- */
 
24
-
 
25
-//@}
 
26
-
 
27
-/**@name OPTIONS
 
28
-  */
 
29
-//@{
 
30
-
 
31
-//@options
 
32
-
 
33
-//@}
 
34
 int main(int argc, char **argv)
 
35
 {
 
36
 
 
37
--- a/main/bcat_main.cc
 
38
+++ b/main/bcat_main.cc
 
39
@@ -47,38 +47,6 @@
 
40
 
 
41
 #define BUFFER_SIZE (1024)
 
42
 
 
43
-
 
44
-/** @name <command>bcat</command> <emphasis>Binary safe version of cat</emphasis>
 
45
-    @id bcat-manual
 
46
-  * @toc
 
47
- */
 
48
-
 
49
-//@{
 
50
-
 
51
-
 
52
-/**@name Synopsis
 
53
-  */
 
54
-//@{
 
55
-
 
56
-//@synopsis
 
57
-
 
58
-/**
 
59
-bcat is a trivial file concatenation program. It exists to allow testing
 
60
-of various file splitting operations under the cygwin environment on Windows
 
61
-where the distinction between binary and text data is important.
 
62
- */
 
63
-
 
64
-//@}
 
65
-
 
66
-/**@name OPTIONS
 
67
-  */
 
68
-//@{
 
69
-
 
70
-//@options
 
71
-
 
72
-//@}
 
73
-
 
74
-
 
75
 int main(int argc, char *argv[]) 
 
76
 { 
 
77
     EST_StrList files;
 
78
--- a/main/ch_lab_main.cc
 
79
+++ b/main/ch_lab_main.cc
 
80
@@ -45,35 +45,6 @@
 
81
 
 
82
 int check_vocab(EST_Relation &a, EST_StrList &vocab);
 
83
 
 
84
-/** @name <command>ch_lab</command> <emphasis>Label file manipulation</emphasis>
 
85
-    @id ch_lab_manual
 
86
-  * @toc
 
87
- */
 
88
-
 
89
-//@{
 
90
-
 
91
-/**@name Synopsis
 
92
-  */
 
93
-//@{
 
94
-
 
95
-//@synopsis
 
96
-
 
97
-/**
 
98
-ch_lab is used to manipulate the format of label files and 
 
99
-serves as a wrap-around for the EST_Relation class.
 
100
-
 
101
-*/
 
102
-
 
103
-//@}
 
104
-
 
105
-/**@name OPTIONS
 
106
-  */
 
107
-//@{
 
108
-
 
109
-//@options
 
110
-
 
111
-//@}
 
112
-
 
113
 int main(int argc, char *argv[])
 
114
 {
 
115
     EST_String out_file, ext;
 
116
--- a/main/ch_track_main.cc
 
117
+++ b/main/ch_track_main.cc
 
118
@@ -52,48 +52,6 @@
 
119
                               EST_Option &al);
 
120
 
 
121
 void extract(EST_Track &tr, EST_Option &al);
 
122
-/** @name <command>ch_track</command> <emphasis>Track file manipulation</emphasis>
 
123
-  * @id ch-track-manual
 
124
-  * @toc
 
125
- */
 
126
-
 
127
-//@{
 
128
-
 
129
-
 
130
-/**@name Synopsis
 
131
-  */
 
132
-//@{
 
133
-
 
134
-//@synopsis
 
135
-
 
136
-/**
 
137
-ch_track is used to manipulate the format of a track
 
138
-file. Operations include:
 
139
-
 
140
-<itemizedlist>
 
141
-<listitem><para>file format conversion</para></listitem>
 
142
-<listitem><para>smoothing</para></listitem>
 
143
-<listitem><para>changing the frame spacing of a track (resampling)</para></listitem>
 
144
-<listitem><para>producing differentiated and delta tracks</para></listitem>
 
145
-<listitem><para>Using a threshold to convert a track file to a label file</para></listitem>
 
146
-
 
147
-<listitem><para>making multiple input files into a single multi-channel output file</para></listitem>
 
148
-<listitem><para>extracting a single channel from a multi-channel track</para></listitem>
 
149
-<listitem><para>extracting a time-delimited portion of the waveform</para></listitem>
 
150
-</itemizedlist>
 
151
-
 
152
- */
 
153
-
 
154
-//@}
 
155
-
 
156
-/**@name Options
 
157
-  */
 
158
-//@{
 
159
-
 
160
-//@options
 
161
-
 
162
-//@}
 
163
-
 
164
 
 
165
 int main(int argc, char *argv[])
 
166
 {
 
167
--- a/main/ch_wave_main.cc
 
168
+++ b/main/ch_wave_main.cc
 
169
@@ -51,52 +51,6 @@
 
170
 
 
171
 void extract_channels(EST_Wave &single, const EST_Wave &multi,  EST_IList &ch_list);
 
172
 
 
173
-/** @name <command>ch_wave</command> <emphasis>Audio file manipulation</emphasis>
 
174
-    @id ch_wave_manual
 
175
-  * @toc
 
176
- */
 
177
-
 
178
-//@{
 
179
-
 
180
-
 
181
-/**@name Synopsis
 
182
-  */
 
183
-//@{
 
184
-
 
185
-//@synopsis
 
186
-
 
187
-/**
 
188
-ch_wave is used to manipulate the format of a waveform
 
189
-file. Operations include:
 
190
-
 
191
-<itemizedlist>
 
192
-<listitem><para>file format conversion</para></listitem>
 
193
-<listitem><para>resampling (changing the sampling frequency)</para></listitem>
 
194
-<listitem><para>byte-swapping</para></listitem>
 
195
-<listitem><para>making multiple input files into a single multi-channel output file</para></listitem>
 
196
-<listitem><para>making multiple input files into a single single-channel output file</para></listitem>
 
197
-<listitem><para>extracting a single channel from a multi-channel waveform</para></listitem>
 
198
-<listitem><para>scaling the amplitude of the waveform</para></listitem>
 
199
-<listitem><para>low pass and high pass filtering</para></listitem>
 
200
-<listitem><para>extracting a time-delimited portion of the waveform</para></listitem>
 
201
-</itemizedlist>
 
202
-
 
203
-ch_wave is a executable program that serves as a wrap-around for the
 
204
-EST_Wave class and the basic wave manipulation functions. More
 
205
-advanced waveform processing is performed by the signal processing library.
 
206
-
 
207
-*/
 
208
-
 
209
-//@}
 
210
-
 
211
-/**@name OPTIONS
 
212
-  */
 
213
-//@{
 
214
-
 
215
-//@options
 
216
-
 
217
-//@}
 
218
-
 
219
 
 
220
 int main (int argc, char *argv[])
 
221
 {
 
222
@@ -304,180 +258,4 @@
 
223
     return 0;
 
224
 }
 
225
 
 
226
-/** @name Making multiple waves into a single wave
 
227
-
 
228
-If multiple input files are specified, by default they are concatenated into 
 
229
-the output file.
 
230
-</para>
 
231
-<para>
 
232
-<screen>
 
233
-$ ch_wave kdt_010.wav kdt_011.wav kdt_012.wav kdt_013.wav -o out.wav
 
234
-</screen>
 
235
-</para>
 
236
-<para>
 
237
-In the above example, 4 single channel input files are converted to
 
238
-one single channel output file. Multi-channel waveforms can also be
 
239
-concatenated provided they all have the same number of input channels.
 
240
-
 
241
-</para><para>
 
242
-
 
243
-Multiple input files can be made into a multi-channel output file by 
 
244
-using the -pc option:
 
245
-
 
246
-</para><para>
 
247
-<screen>
 
248
-$ ch_wave kdt_010.wav kdt_011.wav kdt_012.wav kdt_013.wav -o -pc LONGEST out.wav
 
249
-</screen>
 
250
-</para>
 
251
-<para>
 
252
-The argument to -pc can either be LONGEST, in which the output
 
253
-waveform is the length of the longest input file, or FIRST in which it
 
254
-is the length of the first input file.
 
255
-
 
256
-*/
 
257
-
 
258
-//@{
 
259
-//@}
 
260
-
 
261
-/** @name Extracting channels from multi-channel waves
 
262
-
 
263
-The -c option is used to specify channels which should be extracted
 
264
-from the input.  If the input is a 4 channel wave,
 
265
-</para><para>
 
266
-<screen>
 
267
-$ ch_wave kdt_m.wav -o a.wav -c "0 2"
 
268
-</screen>
 
269
-</para>
 
270
-<para>
 
271
-will extract the 0th and 2nd channel (counting starts from 0). The
 
272
-argument to -c can be either a single number of a list of numbers
 
273
-(wrapped in quotes)
 
274
-
 
275
- */
 
276
-//@{
 
277
-//@}
 
278
-
 
279
-
 
280
-/** @name Extracting of a single region from a waveform
 
281
-
 
282
-There are several ways of extracting a region of a waveform. The
 
283
-simplest way is by using the start, end, to and from commands to
 
284
-delimit a sub portion of the input wave. For example
 
285
-</para><para>
 
286
-<screen>
 
287
-$ ch_wave kdt_010.wav -o small.wav -start 1.45 -end 1.768
 
288
-</screen>
 
289
-</para>
 
290
-<para>
 
291
-extracts a subwave starting at 1.45 seconds and extending to 1.768 seconds.
 
292
-
 
293
-alternatively,
 
294
-</para><para>
 
295
-<screen>
 
296
-$ ch_wave kd_010.wav -o small.wav -from 5000 -to 10000
 
297
-</screen>
 
298
-</para>
 
299
-<para>
 
300
-extracts a subwave starting at 5000 samples and extending to 10000
 
301
-samples. Times and samples can be mixed in sub-wave extraction. The
 
302
-output waveform will have the same number of channels as the input
 
303
-waveform.
 
304
-
 
305
-*/
 
306
-//@{
 
307
-//@}
 
308
-
 
309
-/** @name Extracting of a multiple regions from a waveform
 
310
-
 
311
-Multiple regions can be extracted from a waveform, but as it would be
 
312
-too complicated to specify the start and end points on the command
 
313
-line, a label file with start and end points, and file names is used.
 
314
-
 
315
-The file is called a key label file and in xwaves label format looks
 
316
-like:
 
317
-</para>
 
318
-<para>
 
319
-<screen>
 
320
-separator ;
 
321
-#
 
322
-0.308272  121 sil ;    file kdt_010.01 ;
 
323
-0.440021  121 are ;     file kdt_010.02 ;
 
324
-0.512930  121 your ;    file kdt_010.03 ;
 
325
-0.784097  121 grades ;  file kdt_010.04 ;
 
326
-1.140969  121 higher ;  file kdt_010.05 ;
 
327
-1.258647  121 or ;      file kdt_010.06 ;
 
328
-1.577145  121 lower ;   file kdt_010.07 ;
 
329
-1.725516  121 than ;    file kdt_010.08 ;
 
330
-2.315186  121 nancy's ; file kdt_010.09 ;
 
331
-</screen>
 
332
-</para>
 
333
-<para>
 
334
-Each line represents one region. The first column is the end time of
 
335
-that region and the start time of the next. The next two columns are
 
336
-colour and an arbitrary name, and the filename in which the output
 
337
-waveform is to be stored is kept as a field called file in the last column.
 
338
-In this example, each region corresponds to a single word in the file.
 
339
-
 
340
-If the above file is called "kdt_010.words.keylab", the command:
 
341
-</para>
 
342
-<para>
 
343
-<screen>
 
344
-$ ch_wave kdt_010.wav -key kdt_010.words -ext .wav -divide
 
345
-</screen>
 
346
-</para>
 
347
-<para>
 
348
-will divide the input waveform into 9 output waveforms called
 
349
-kdt_010.01.wav, kdt_010.02.wav ... kdt_010.09.wav. The -ext option
 
350
-specifies the extension of the new waveforms, and the -divide command
 
351
-specifies that division of the entire waveform is to take place.
 
352
-
 
353
-If only a single file is required the -extract option can be used, in
 
354
-which case its argument is the filename required.
 
355
-</para>
 
356
-<para>
 
357
-<screen>
 
358
-$ ch_wave kdt_010.wav -key kdt_010.words -ext .wav -extract kdt_010.03 \
 
359
-          -o kdt_010.03.wav
 
360
-</screen>
 
361
-</para>
 
362
-<para>
 
363
-Note that an output filename should be specified with this option.
 
364
-*/
 
365
-//@{
 
366
-//@}
 
367
-
 
368
-/** @name Adding headers and format conversion
 
369
-
 
370
-It is usually a good idea for all waveform files to have headers as
 
371
-this way different byte orders, sampling rates etc can be handled
 
372
-safely. ch_wave provides a means of adding headers to raw files.
 
373
-
 
374
-The following adds a header to a file of 16 bit shorts
 
375
-</para>
 
376
-<para>
 
377
-<screen>
 
378
-$ ch_wave kdt_010.raw1 -o kdt_010.h1.wav -otype nist -f 16000 -itype raw
 
379
-</screen>
 
380
-</para>
 
381
-<para>
 
382
-The following downsamples the input to 8 KHz
 
383
-</para>
 
384
-<para>
 
385
-<screen>
 
386
-$ ch_wave kdt_010.raw1 -o kdt_010.h2.wav -otype nist -f 16000  \
 
387
-                 -F 8000 -itype raw
 
388
-</screen>
 
389
-</para>
 
390
-<para>
 
391
-The following takes a 8K ulaw input file and produces a 16bit, 20Khz output file:
 
392
-</para>
 
393
-<para>
 
394
-<screen>
 
395
-$ ch_wave kdt_010.raw2 -o kdt_010.h3.wav -otype nist -istype ulaw \
 
396
-                  -f 8000 -F 20000 -itype raw
 
397
-</screen>
 
398
-*/
 
399
-  //@{
 
400
-  //@}
 
401
 
 
402
-//@}
 
403
--- a/main/design_filter_main.cc
 
404
+++ b/main/design_filter_main.cc
 
405
@@ -45,38 +45,6 @@
 
406
 #include "EST_cmd_line_options.h"
 
407
 #include "sigpr/EST_filter_design.h"
 
408
 
 
409
-/** @name <command>design_filter</command>
 
410
-  * @id designfilter-manual
 
411
-  * @toc
 
412
- */
 
413
-
 
414
-//@{
 
415
-
 
416
-/**@name Synopsis
 
417
-  */
 
418
-//@{
 
419
-
 
420
-//@synopsis
 
421
-
 
422
-/**
 
423
-<command>designfilter</command> computes the coefficients of a FIR
 
424
-filter with a given frequency response. The user supplies the
 
425
-frequency response as a vector of evenly spaced gains ranging from 0
 
426
-to half the sampling frequency. The length of this vector must be a
 
427
-power of 2. The filter coefficients can be used by the \Ref{sigfilter}
 
428
-program.
 
429
-
 
430
-*/
 
431
-
 
432
-//@}
 
433
-
 
434
-/**@name Options
 
435
-  */
 
436
-//@{
 
437
-
 
438
-//@options
 
439
-
 
440
-//@}
 
441
 
 
442
 int main (int argc, char *argv[])
 
443
 {
 
444
@@ -161,7 +129,7 @@
 
445
 </para>
 
446
 <para>
 
447
 where filter.freq_response is the above file, and filter.coefficients
 
448
-is the output file which can be used by \Ref{sigfilter}.
 
449
+is the output file which can be used by \ref sigfilter .
 
450
 </para>
 
451
 
 
452
 */
 
453
--- a/main/dp_main.cc
 
454
+++ b/main/dp_main.cc
 
455
@@ -105,55 +105,6 @@
 
456
 EST_String distance_measure = "simple"; // could be "matrix"
 
457
 
 
458
 
 
459
-
 
460
-
 
461
-/** @name <command>dp</command> <emphasis> Perform dynamic programming on label sequences</emphasis>
 
462
-  * @id dp-manual
 
463
-  * @toc
 
464
- */
 
465
-
 
466
-//@{
 
467
-
 
468
-/**@name Synopsis
 
469
-  */
 
470
-//@{
 
471
-
 
472
-//@synopsis
 
473
-
 
474
-/**
 
475
-dp provides simple dynamic programming to find the lowest cost
 
476
-alignment of two symbol sequences. Possible uses include:
 
477
-
 
478
-<itemizedlist>
 
479
-<listitem><para>Label alignment (e.g. speech recogniser output scoring) </para></listitem>
 
480
-</itemizedlist>
 
481
-
 
482
-The costs of inserting/deleting/substituting symbols can be given
 
483
-either with command line options, or as a file containing a full
 
484
-matrix of costs. In the former case, all insertions will have the same
 
485
-cost. In the latter case, each row of the file contains the cost of
 
486
-replacing a symbol in sequence 1 with each possible symbol in the
 
487
-vocabulary to align with sequence 2, including a special "place
 
488
-holder" symbol used for insertions/deletions. See the examples
 
489
-below. The place holder can be redefined.
 
490
-
 
491
-The output is an EST utterance with three Relations: the first two are
 
492
-the input sequences, and the third shows the alignment found by
 
493
-dynamic programming.
 
494
-
 
495
-*/
 
496
-
 
497
-//@}
 
498
-
 
499
-/**@name Options
 
500
-  */
 
501
-//@{
 
502
-
 
503
-//@options
 
504
-
 
505
-//@}
 
506
-
 
507
-
 
508
 int main(int argc, char **argv)
 
509
 {
 
510
     EST_StrList files;
 
511
@@ -381,60 +332,3 @@
 
512
     return FALSE;
 
513
 
 
514
 }
 
515
-
 
516
-
 
517
-/**@name Examples
 
518
-
 
519
-<para>
 
520
-Align two symbol sequences:
 
521
-</para>
 
522
-
 
523
-<para>
 
524
-<screen>
 
525
-$ dp -vocab vocab.file "a b c" "a b d c" -i 1 -d 2 -s 3
 
526
-</screen>
 
527
-</para>
 
528
-
 
529
-<para>
 
530
-where vocab.file contains "a b c d"
 
531
-</para>
 
532
-
 
533
-<para>
 
534
-Or, using a full cost matrix:
 
535
-</para>
 
536
-
 
537
-<para>
 
538
-<screen>
 
539
-$ dp -vocab vocab2.file -cost_matrix foo "a b c" "a b d c"
 
540
-</screen>
 
541
-</para>
 
542
-
 
543
-<para>
 
544
-where vocab2.file contains "a b c d <null>" and the file foo contains:
 
545
-</para>
 
546
-
 
547
-<para>
 
548
-<screen>
 
549
-<para>0 3 3 3 2</para>
 
550
-<para>3 0 3 3 2</para>
 
551
-<para>3 3 0 3 2</para>
 
552
-<para>3 3 3 0 2</para>
 
553
-<para>1 1 1 1 0</para>
 
554
-</screen>
 
555
-</para>
 
556
-
 
557
-<para> Each row of foo shows the cost of replacing an input symbol
 
558
-with each symbol in the vocabulary to match an output symbol. Each row
 
559
-corresponds to an item in the vocabulary (in the order they appear in
 
560
-the vocabulary file). In the example, replacing 'a' with 'a' costs 0,
 
561
-replacing 'a' with any of 'b' 'c' or 'd' costs 3 (a substitution), and
 
562
-replacing 'a' with the place holder symbol 'null' costs 2 (a
 
563
-deletion). The cost of replacing 'null' with anything other than
 
564
-'null' costs 1 (an insertion).  The costs of 1,2 and 3 used here are
 
565
-only for illustration. The cost matrix meed not have the form above -
 
566
-for example, replacing 'a' with 'a' need not cost 0. The entries in
 
567
-foo are read as floats.  </para>
 
568
-
 
569
-*/
 
570
-//@{
 
571
-//@}
 
572
--- a/main/fringe_client_main.cc
 
573
+++ b/main/fringe_client_main.cc
 
574
@@ -44,39 +44,6 @@
 
575
 #include "EST_FringeServer.h"
 
576
 #include "EST_cmd_line.h"
 
577
 
 
578
-/** @name <command>fringe_client</command> <emphasis>Send commands to a running fringe server</emphasis>
 
579
-    @id fringe-client-manual
 
580
-  * @toc
 
581
- */
 
582
-
 
583
-//@{
 
584
-
 
585
-
 
586
-/**@name Synopsis
 
587
-  */
 
588
-//@{
 
589
-
 
590
-//@synopsis
 
591
-
 
592
-/**
 
593
-
 
594
-   <command>fringe_client</command> is a simple program for sending
 
595
-   commands to a <command>fringe</command> process which is running in
 
596
-   server mode.
 
597
-
 
598
- */
 
599
-
 
600
-//@}
 
601
-
 
602
-/**@name OPTIONS
 
603
-  */
 
604
-//@{
 
605
-
 
606
-//@options
 
607
-
 
608
-//@}
 
609
-
 
610
-
 
611
 int main(int argc, char *argv[])
 
612
 {
 
613
     EST_String out_file, ext;
 
614
@@ -179,12 +146,4 @@
 
615
     return(0);
 
616
 }
 
617
 
 
618
-/**@name Finding Fringe.
 
619
-
 
620
-Each <command>fringe</command> which runs in server mode registers
 
621
-it's location in a file called <filename>.estServices</filename> in
 
622
-the users home directory. Multiple servers can be present if they are
 
623
-given different names, and the <option>-n</option> can be used to
 
624
-select which fringe a command is sent to.
 
625
 
 
626
-*/
 
627
--- a/main/na_play_main.cc
 
628
+++ b/main/na_play_main.cc
 
629
@@ -41,86 +41,6 @@
 
630
 #include "EST_audio.h"
 
631
 #include "EST_cmd_line_options.h"
 
632
 
 
633
-/** @name <command>na_play</command><emphasis> Audio Playback</emphasis>
 
634
-    @id na_play_manual
 
635
-  * @toc
 
636
- */
 
637
-
 
638
-//@{
 
639
-
 
640
-
 
641
-/**@name Synopsis
 
642
-  */
 
643
-//@{
 
644
-
 
645
-//@synopsis
 
646
-
 
647
-/**
 
648
-
 
649
-
 
650
-na_play is a general playback program for playing sound files on a variety
 
651
-of platforms and sound cards.
 
652
-
 
653
-Currently, the following audio devices are supported:
 
654
-
 
655
-<itemizedlist mark='@bullet'>
 
656
-<listitem><para>sunaudio:</para><para>
 
657
-8k ulaw direct to <filename>/dev/audio</filename> found on most Sun machines.  This
 
658
-is also found under Linux and FreeBSD, and possibly others.  This
 
659
-is the default if <function>netaudio</function> is not supported.
 
660
-<listitem><para>netaudio:</para><para>
 
661
-NCD's network transparent audio system (NAS).  This allows
 
662
-use of audio devices across a network.  NAS has support for, Suns,
 
663
-Linux, FreeBSD, HPs and probably other machines by now.
 
664
-<listitem><para>sun16audio:</para><para>
 
665
-This is only available on newer Sun workstations and has been
 
666
-enabled at compile time.  This provides 
 
667
-16bit linear PCM at various sample rates.
 
668
-<listitem><para>linux16audio:</para><para>
 
669
-This is only available on Linux workstations and has been enabled
 
670
-at compile time.  This provides 
 
671
-16bit linear PCM at various sample rates.
 
672
-<listitem><para>freebsd16audio:</para><para>
 
673
-This is only available on workstations running FreeBSD and has
 
674
-been enabled at compile time.  This provides 
 
675
-16bit linear PCM at various sample rates.
 
676
-<listitem><para>mplayeraudio:</para><para>
 
677
-This is only available under Windows NT 4.0 and Windows 95 and
 
678
-has been enabled at compile time.  This provides 
 
679
-16bit linear PCM at various sample rates.
 
680
-<listitem><para>win32audio</para><para>
 
681
-This is only available under Windows NT 4.0 and Windows 95 and
 
682
-has been enabled at compile time.  This provides 
 
683
-16bit linear PCM at various sample rates, playing the audio directly
 
684
-rather than saving to a file as with mplayeraudio.
 
685
-<listitem><para>irixaudio</para><para>
 
686
-Audio support for SGI's IRIX 6.2.
 
687
-<listitem><para>Audio_Command:</para><para>
 
688
-Allows the specification of an arbitrary UNIX command to play
 
689
-the waveform.  This won't normally be used with <function>na_play</function> as
 
690
-you could just use the command directly but is necessary with some
 
691
-systems using the speech tools.
 
692
-</itemizedlist>
 
693
-</para>
 
694
-
 
695
-<para>
 
696
-The default audio is netaudio if it is supported.  If not the platform
 
697
-specific auido mode is the default (e.g. sun16audio, linux16audio,
 
698
-freebsd16audio or mplayeraudio).  If none of these is supported,
 
699
-sunaudio is the default. 
 
700
-*/
 
701
-
 
702
-//@}
 
703
-
 
704
-/**@name OPTIONS
 
705
-  */
 
706
-//@{
 
707
-
 
708
-//@options
 
709
-
 
710
-//@}
 
711
-
 
712
-
 
713
 int main (int argc, char *argv[])
 
714
 {
 
715
     EST_Wave sig;
 
716
--- a/main/na_record_main.cc
 
717
+++ b/main/na_record_main.cc
 
718
@@ -49,39 +49,6 @@
 
719
 int win_record_wave(EST_Wave &wave,  EST_Option &al);
 
720
 #endif
 
721
 
 
722
-/** @name <command>na_record</command> <emphasis>Audio file recording</emphasis>
 
723
-    @id na-record-manual
 
724
-  * @toc
 
725
- */
 
726
-
 
727
-//@{
 
728
-
 
729
-
 
730
-/**@name Synopsis
 
731
-  */
 
732
-//@{
 
733
-
 
734
-//@synopsis
 
735
-
 
736
-/**
 
737
-
 
738
-na_record records wavefors from an audio device.  It only supports
 
739
-recording for N seconds (default is 10).  Specifying the frequency
 
740
-defines the recording frequency (if supported by the hardware).  This
 
741
-currently doesn't support NAS audio in.
 
742
-
 
743
- */
 
744
-
 
745
-//@}
 
746
-
 
747
-/**@name OPTIONS
 
748
-  */
 
749
-//@{
 
750
-
 
751
-//@options
 
752
-
 
753
-//@}
 
754
-
 
755
 
 
756
 int main (int argc, char *argv[])
 
757
 {
 
758
--- a/main/ngram_build_main.cc
 
759
+++ b/main/ngram_build_main.cc
 
760
@@ -43,106 +43,6 @@
 
761
 #include "EST_Pathname.h"
 
762
 
 
763
 
 
764
-
 
765
-/** @name <command>ngram_build</command> <emphasis>Train n-gram language model</emphasis>
 
766
-    @id ngram_build_manual
 
767
-  * @toc
 
768
- */
 
769
-
 
770
-//@{
 
771
-
 
772
-
 
773
-/**@name Synopsis
 
774
-  */
 
775
-//@{
 
776
-
 
777
-//@synopsis
 
778
-
 
779
-/**
 
780
-ngram_build offers basic ngram language model estimation. 
 
781
-
 
782
-
 
783
-<formalpara>
 
784
-<para><title>Input data format</title></para>
 
785
-
 
786
-<para> Two input formats are supported. In sentence_per_line format,
 
787
-the program will deal with start and end of sentence (if required) by
 
788
-using special vocabulary items specified by -prev_tag, -prev_prev_tag
 
789
-and -last_tag. For example, the input sentence: </para>
 
790
-
 
791
-<screen>
 
792
-the cat sat on the mat
 
793
-</screen>
 
794
-
 
795
-would be treated as
 
796
-
 
797
-<screen>
 
798
-... prev_prev_tag prev_prev_tag prev_tag the cat sat on the mat last_tag
 
799
-</screen>
 
800
-
 
801
-where prev_prev_tag is the argument to -prev_prev_tag, and so on. A
 
802
-default set of tag names is also available. This input format is only
 
803
-useful for sliding-window type applications (e.g. language modelling
 
804
-for speech recognition).
 
805
-
 
806
-The second input format is ngram_per_line which is useful for either
 
807
-non-sliding-window applications, or where the user requires an
 
808
-alternative treatment of start/end of sentence to that provided
 
809
-above. Now the input file simply contains a complete ngram per
 
810
-line. For the same example as above (to build a trigram model) this
 
811
-would be:
 
812
-
 
813
-<para>
 
814
-<screen>
 
815
-prev_prev_tag prev_tag the
 
816
-prev_tag the cat
 
817
-the cat sat
 
818
-cat sat on
 
819
-sat on the
 
820
-on the mat
 
821
-the mat last_tag
 
822
-</screen>
 
823
-</para>
 
824
-
 
825
-</formalpara>
 
826
-
 
827
-
 
828
-<formalpara>
 
829
-<para><title>Representation</title></para>
 
830
-
 
831
-\[V^N\]
 
832
-
 
833
-<para> The internal representation of the model becomes important for
 
834
-higher values of N where, if V is the vocabulary size, \(V^N\) becomes
 
835
-very large. In such cases, we cannot explicitly hold probabilities for
 
836
-all possible ngrams, and a sparse representation must be used
 
837
-(i.e. only non-zero probabilities are stored).</para> 
 
838
-</formalpara>
 
839
-
 
840
-<formalpara>
 
841
-<para><title>Getting more robust probability estimates</title></para>
 
842
-The common techniques for getting better estimates of the low/zero
 
843
-frequency ngrams are provided: namely smoothing and backing-off</para>
 
844
-</formalpara>
 
845
-
 
846
-<formalpara>
 
847
-<para><title>Testing an ngram model</title></para>
 
848
-Use the <link linkend=ngram-test-manual>ngram_test</link> program.
 
849
-</formalpara>
 
850
-
 
851
-*/
 
852
-
 
853
-//@}
 
854
-
 
855
-/**@name OPTIONS
 
856
-  */
 
857
-//@{
 
858
-
 
859
-//@options
 
860
-
 
861
-//@}
 
862
-
 
863
-
 
864
 int main(int argc, char **argv)
 
865
 {
 
866
     int order;
 
867
--- a/main/ngram_test_main.cc
 
868
+++ b/main/ngram_test_main.cc
 
869
@@ -40,80 +40,6 @@
 
870
 #include "EST_Ngrammar.h"
 
871
 
 
872
 
 
873
-/** @name <command>ngram_test</command> <emphasis> Test n-gram language model </emphasis>
 
874
-    @id ngram_test_manual
 
875
-  * @toc
 
876
- */
 
877
-
 
878
-//@{
 
879
-
 
880
-
 
881
-/**@name Synopsis
 
882
-  */
 
883
-//@{
 
884
-
 
885
-//@synopsis
 
886
-
 
887
-/**
 
888
-ngram_test is for testing ngram models generated from
 
889
-<link linkend=ngram-build-manual>ngram_build</link>.
 
890
-
 
891
-<formalpara> <para> <title> How do we test an ngram model ?  </title>
 
892
-</para>
 
893
-
 
894
-<para> ngram_test will compute the entropy (or perplexity, see below)
 
895
-of some test data, given an ngram model. The entropy gives a measure
 
896
-of how likely the ngram model is to have generated the test
 
897
-data. Entropy is defined (for a sliding-window type ngram) as:
 
898
-
 
899
-\[H = -\frac{1}{Q} \sum_{i=1}^{Q} log P(w_i | w_{i-1}, w_{i-2},... w_{i-N+1}) \]
 
900
-
 
901
-where \(Q\) is the number of words of test data and \(N\) is the order
 
902
-of the ngram model. Perplexity is a more intuitive mease, defined as:
 
903
-
 
904
-\[B = 2^H \]
 
905
-
 
906
-The perplexity of an ngram model with vocabulary size V will be
 
907
-between 1 and V. Low perplexity indicates a more predictable language,
 
908
-and in speech recognition, a models with low perplexity on test data
 
909
-(i.e. data NOT used to estimate the model in the first place)
 
910
-typically give better accuracy recognition than models with higher 
 
911
-perplexity (this is not guaranteed, however).
 
912
-
 
913
-test_ngram works with non-sliding-window type models when the input
 
914
-format is <parameter>ngram_per_line</parameter>.
 
915
-
 
916
-</para>
 
917
-</formalpara>
 
918
-
 
919
-<formalpara>
 
920
-<para><title>Input data format</title></para>
 
921
-<para> The data input format options are the same as
 
922
-<link linkend=ngram-build-manual>ngram_build</link>, as is the treatment of sentence start/end using
 
923
-special tags. 
 
924
-</para>
 
925
-<para>
 
926
-
 
927
-Note: To get meaningful entropy/perplexity figures, it is recommended that
 
928
-you use the same data input format in both
 
929
-<link linkend=ngram-build-manual>ngram_build</link> and <link linkend=ngram-test-manual>ngram_test</link>, and the treatment of
 
930
-sentence start/end should be the same.
 
931
-</para>
 
932
-</formalpara>
 
933
-
 
934
-
 
935
-@see ngram_build */
 
936
-//@}
 
937
-
 
938
-/**@name OPTIONS
 
939
-  */
 
940
-//@{
 
941
-
 
942
-//@options
 
943
-
 
944
-//@}
 
945
-
 
946
-
 
947
 int main(int argc, char **argv)
 
948
 {
 
949
     //int order;
 
950
@@ -384,27 +310,3 @@
 
951
     (void)al;
 
952
 }
 
953
 
 
954
-/** @name Hints
 
955
-
 
956
-<title>I got a perplexity of Infinity - what went wrong ?</title>
 
957
-
 
958
-A perplexity of Infinity means that at least one of the ngrams in your
 
959
-test data had a probability of zero. Possible reasons for this include:
 
960
-
 
961
-<itemizedlist>
 
962
-
 
963
-<listitem><para>The training data had no examples of this ngram, and
 
964
-you did not specify a floor for zero frequency ngrams in
 
965
-\Ref{build_ngram} </para></listitem>
 
966
-<listitem><para>You used differing input formats for \Ref{ngram_build}
 
967
-and \Ref{ngram_test}. </para></listitem>
 
968
-<listitem><para>You used differing sentence start/end treatments in
 
969
-\Ref{ngram_build} and \Ref{ngram_test}. </para></listitem>
 
970
-</itemizedlist>
 
971
-
 
972
-*/
 
973
-
 
974
-  //@{
 
975
-  //@}
 
976
-
 
977
-//@}
 
978
--- a/main/ols_main.cc
 
979
+++ b/main/ols_main.cc
 
980
@@ -47,35 +47,6 @@
 
981
 static void load_ols_data(EST_FMatrix &X, EST_FMatrix &Y, WDataSet &d);
 
982
 static int ols_main(int argc, char **argv);
 
983
 
 
984
-
 
985
-/** @name <command>ols</command> <emphasis>Train linear regression model</emphasis>
 
986
-    @id ols-manual
 
987
-  * @toc
 
988
- */
 
989
-
 
990
-//@{
 
991
-
 
992
-
 
993
-/**@name Synopsis
 
994
-  */
 
995
-//@{
 
996
-
 
997
-//@synopsis
 
998
-
 
999
-/**
 
1000
- */
 
1001
-
 
1002
-//@}
 
1003
-
 
1004
-/**@name OPTIONS
 
1005
-  */
 
1006
-//@{
 
1007
-
 
1008
-//@options
 
1009
-
 
1010
-//@}
 
1011
-
 
1012
-
 
1013
 int main(int argc, char **argv)
 
1014
 {
 
1015
     return ols_main(argc,argv);
 
1016
--- a/main/ols_test_main.cc
 
1017
+++ b/main/ols_test_main.cc
 
1018
@@ -49,33 +49,6 @@
 
1019
 static int ols_test_main(int argc, char **argv);
 
1020
 static void load_ols_data(EST_FMatrix &X, EST_FMatrix &Y, WDataSet &d);
 
1021
 
 
1022
-/** @name <command>ols_test</command> <emphasis>Test linear regression model</emphasis>
 
1023
-    @id ols-test-manual
 
1024
-  * @toc
 
1025
- */
 
1026
-
 
1027
-//@{
 
1028
-
 
1029
-
 
1030
-/**@name Synopsis
 
1031
-  */
 
1032
-//@{
 
1033
-
 
1034
-//@synopsis
 
1035
-
 
1036
-/**
 
1037
- */
 
1038
-
 
1039
-//@}
 
1040
-
 
1041
-/**@name OPTIONS
 
1042
-  */
 
1043
-//@{
 
1044
-
 
1045
-//@options
 
1046
-
 
1047
-//@}
 
1048
-
 
1049
 
 
1050
 int main(int argc, char **argv)
 
1051
 {
 
1052
--- a/main/pda_main.cc
 
1053
+++ b/main/pda_main.cc
 
1054
@@ -48,43 +48,6 @@
 
1055
 
 
1056
 static int save_pm(EST_String filename, EST_Track fz);
 
1057
 
 
1058
-/** @name <command>pda</command> <emphasis>Pitch Detection Algorithm</emphasis>
 
1059
-    @id pda-manual
 
1060
-  * @toc
 
1061
- */
 
1062
-
 
1063
-//@{
 
1064
-
 
1065
-/**@name Synopsis
 
1066
-  */
 
1067
-//@{
 
1068
-
 
1069
-//@synopsis
 
1070
-
 
1071
-/**
 
1072
-pda is a pitch detection algorithm that produces a fundamental frequency
 
1073
-contour from a speech waveform file. At present only the
 
1074
-super resolution pitch determination algorithm is implemented.
 
1075
-See (Medan, Yair, and Chazan, 1991) and (Bagshaw et al., 1993) for a detailed
 
1076
-description of the algorithm.
 
1077
-</para><para>
 
1078
-
 
1079
-The default values given below were found to optimise the performance
 
1080
-of the pitch determination algorithm for speech data sampled at 20kHz
 
1081
-using a 16\-bit waveform and low pass filter with a 600Hz cut-off
 
1082
-frequency and more than \-85dB rejection above 700Hz. The best
 
1083
-performances occur if the [\-p] flag is passed.  </para><para>
 
1084
-*/
 
1085
-
 
1086
-//@}
 
1087
-
 
1088
-/**@name Options
 
1089
-  */
 
1090
-//@{
 
1091
-
 
1092
-//@options
 
1093
-
 
1094
-//@}
 
1095
 
 
1096
 
 
1097
 int main (int argc, char *argv[])
 
1098
@@ -259,14 +222,4 @@
 
1099
     return 0;
 
1100
 }
 
1101
 
 
1102
-/**@name Examples
 
1103
-
 
1104
-Pitch detection on typical male voice, using low pass filtering:
 
1105
-<screen>
 
1106
-$ pda kdt_010.wav -o kdt_010.f0 -fmin 80 -fmax 200 -L
 
1107
-</screen>
 
1108
-*/
 
1109
-//@{
 
1110
 
 
1111
-//@}
 
1112
-//@}
 
1113
--- a/main/pitchmark_main.cc
 
1114
+++ b/main/pitchmark_main.cc
 
1115
@@ -68,88 +68,6 @@
 
1116
 */
 
1117
 
 
1118
 
 
1119
-/** @name <command> pitchmark </command> <emphasis> Find instants of glottal closure in Laryngograph file</emphasis>
 
1120
-
 
1121
-  * @id pitchmark-manual
 
1122
-  * @toc */
 
1123
-
 
1124
-//@{
 
1125
-
 
1126
-
 
1127
-/**@name Synopsis
 
1128
-  */
 
1129
-//@{
 
1130
-
 
1131
-//@synopsis
 
1132
-
 
1133
-/**
 
1134
-<command>pitchmark</command> locates instants of glottal closure in a
 
1135
-laryngograph waveform, and performs post-processing to produce even
 
1136
-pitchmarks. EST does not currently provide any means of pitchmarking a
 
1137
-speech waveform.
 
1138
-
 
1139
-Pitchmarking is performed by calling the
 
1140
-<function>pitchmark()</function> function, which carries out the
 
1141
-following operations: 
 
1142
-
 
1143
-<orderedlist> <listitem><para>Double low pass filter the signal. This
 
1144
-removes noise in the signal. The parameter
 
1145
-<parameter>lx_lf</parameter> specifies the low pass cutoff frequency,
 
1146
-and <parameter>lx_lo</parameter> specifies the order. Double filtering
 
1147
-(feeding the waveform through the filter, then reversing the waveform
 
1148
-and feeding it through again) is performed to reduce any phase shift
 
1149
-between the input and output of the filtering operation.
 
1150
-</para></listitem>
 
1151
-
 
1152
-<listitem><para>Double high pass filter the signal. This removes the
 
1153
-very low frequency swell that is often observed in laryngograph
 
1154
-waveforms.  The parameter <parameter>lx_hf</parameter> specifies the high pass cutoff frequency,
 
1155
-and <parameter>lx_ho</parameter> specifies the order.
 
1156
-Double filtering is performed to reduce any phase shift
 
1157
-between the input and output of the filtering operation.
 
1158
-</para></listitem>
 
1159
-
 
1160
-<listitem><para>Calculate the delta signal. The filtered waveform is
 
1161
-differentiated using the <function>delta()</function>
 
1162
-function.</para></listitem>
 
1163
-
 
1164
-<listitem><para>Low pass filter the delta signal. Some noise may still
 
1165
-be present in the signal, and this is removed by further low pass
 
1166
-filtering. Experimentation has shown that simple mean smoothing is
 
1167
-often more effective than FIR smoothing at this point.  The parameter
 
1168
-<parameter>mo</parameter> is used to specify the size of the mean
 
1169
-smoothing window.  If FIR smoothing is chosen, the parameter
 
1170
-<parameter>df_lf</parameter> specifies the low pass cutoff frequency,
 
1171
-and <parameter>df_lo</parameter> specifies the order. Double filtering
 
1172
-is again used to avoid phase distortion.
 
1173
-
 
1174
-</para></listitem>
 
1175
-
 
1176
-<listitem><para>Pick zero crossings. Now simple zero-crossing is used
 
1177
-to find the pitchmarks themselves.  </para></listitem>
 
1178
-
 
1179
-</orderedlist>
 
1180
-
 
1181
-<command>pitchmark</command> also performs post-processing on the pitchmarks. 
 
1182
-This can be used to eliminate pitchmarks which occur too closely together, 
 
1183
-or to provide estimated evenly spaced pitchmarks during unvoiced regions.
 
1184
-The -fill option switches <action>this facility on</action>, 
 
1185
-and -min, -max, -def, 
 
1186
--end and -wave_end control its operation.
 
1187
-
 
1188
-*/
 
1189
-
 
1190
-//@}
 
1191
-
 
1192
-/**@name OPTIONS
 
1193
-  */
 
1194
-//@{
 
1195
-
 
1196
-//@options
 
1197
-
 
1198
-//@}
 
1199
-
 
1200
-
 
1201
 int main (int argc, char *argv[])
 
1202
 {
 
1203
     EST_Track pm;
 
1204
@@ -399,29 +317,3 @@
 
1205
        op.set("pm_debug", 1);
 
1206
 }
 
1207
 
 
1208
-/** @name Examples
 
1209
-</para>
 
1210
-<formalpara><title>Basic Pitchmarking</title>
 
1211
-<para>
 
1212
-<screen>
 
1213
-$ pitchmark kdt_010.lar -o kdt_010.pm -otype est
 
1214
-</screen>
 
1215
-</para> 
 
1216
-</formalpara>
 
1217
-
 
1218
-<formalpara><title>Pitchmarking with unvoiced regions
 
1219
-filled</title> <para> The following fills unvoiced regions with pitch
 
1220
-periods that are about 0.01 seconds long. It also post-processes the
 
1221
-set of pitchmarks and ensures that noe are above 0.02 seconds long and
 
1222
-none below 0.003. A final unvoiced region extending to the end of the
 
1223
-wave is specified by using the -wave_end option.
 
1224
-</para> </formalpara><para>
 
1225
-<screen>
 
1226
-$ pitchmark kdt_010.lar -o kdt_010.pm -otype est -fill -min 0.003  \
 
1227
-       -max 0.02 -def 0.01 -wave_end
 
1228
-</screen>
 
1229
-
 
1230
-*/
 
1231
-
 
1232
-//@{
 
1233
-//@}
 
1234
--- /dev/null
 
1235
+++ b/main/program_main.cc
 
1236
@@ -0,0 +1,9 @@
 
1237
+#include <cstdio>
 
1238
+
 
1239
+int main(){
 
1240
+    std::cout << "hello world" << std:endl;
 
1241
+    return 0;
 
1242
+}
 
1243
+
 
1244
+/// An example for program_main is shown at \ref program_example
 
1245
+
 
1246
--- a/main/scfg_make_main.cc
 
1247
+++ b/main/scfg_make_main.cc
 
1248
@@ -62,39 +62,7 @@
 
1249
                           const EST_StrList &Terminals);
 
1250
 static void generate_probs(double *probs,int num);
 
1251
 
 
1252
-/** @name <command>scfg_make</command> <emphasis>Make the rules for a stochastic context free grammar</emphasis>
 
1253
-    @id scfg-make-manual
 
1254
-  * @toc
 
1255
- */
 
1256
 
 
1257
-//@{
 
1258
-
 
1259
-
 
1260
-/**@name Synopsis
 
1261
-  */
 
1262
-//@{
 
1263
-
 
1264
-//@synopsis
 
1265
-
 
1266
-/**
 
1267
-
 
1268
-Builds a stochastic context free grammar from a vocabulary of non-terminal
 
1269
-and terminal symbols.  An exhaustive set of all possible binary rules
 
1270
-are generated with random (or equal) probabilities (or negative log
 
1271
-probabilities).  This program is designed for making grammars that
 
1272
-can be trained using scfg_train.
 
1273
-
 
1274
- */
 
1275
-
 
1276
-//@}
 
1277
-
 
1278
-/**@name OPTIONS
 
1279
-  */
 
1280
-//@{
 
1281
-
 
1282
-//@options
 
1283
-
 
1284
-//@}
 
1285
 
 
1286
 
 
1287
 int main(int argc, char **argv)
 
1288
--- a/main/scfg_parse_main.cc
 
1289
+++ b/main/scfg_parse_main.cc
 
1290
@@ -52,42 +52,6 @@
 
1291
 static int scfg_parse_main(int argc, char **argv);
 
1292
 
 
1293
 
 
1294
-/** @name <command>scfg_parse</command> <emphasis>Parse text using a pre-trained stochastic context free grammar</emphasis>
 
1295
-    @id scfg-parse-manual
 
1296
-  * @toc
 
1297
- */
 
1298
-
 
1299
-//@{
 
1300
-
 
1301
-
 
1302
-/**@name Synopsis
 
1303
-  */
 
1304
-//@{
 
1305
-
 
1306
-//@synopsis
 
1307
-
 
1308
-/**
 
1309
-
 
1310
-This parses given text with a given stochastic context free grammar.
 
1311
-Note this program is not designed as an arbitrary parser for
 
1312
-unrestricted English.  It simply parses the input non-terminals
 
1313
-with the given grammar.  If you want to English (or other language)
 
1314
-parses consider using the festival script <command>scfg_parse</command>
 
1315
-which does proper tokenization and part of speech tagging, before
 
1316
-passing it to a SCFG.
 
1317
-
 
1318
- */
 
1319
-
 
1320
-//@}
 
1321
-
 
1322
-/**@name OPTIONS
 
1323
-  */
 
1324
-//@{
 
1325
-
 
1326
-//@options
 
1327
-
 
1328
-//@}
 
1329
-
 
1330
 int main(int argc, char **argv)
 
1331
 {
 
1332
 
 
1333
--- a/main/scfg_test_main.cc
 
1334
+++ b/main/scfg_test_main.cc
 
1335
@@ -52,38 +52,6 @@
 
1336
 
 
1337
 static int scfg_test_main(int argc, char **argv);
 
1338
 
 
1339
-/** @name <command>scfg_test</command> <emphasis>Test the output of a parser</emphasis>
 
1340
-    @id scfg-make-manual
 
1341
-  * @toc
 
1342
- */
 
1343
-
 
1344
-
 
1345
-//@{
 
1346
-
 
1347
-
 
1348
-/**@name Synopsis
 
1349
-  */
 
1350
-//@{
 
1351
-
 
1352
-//@synopsis
 
1353
-
 
1354
-/**
 
1355
-
 
1356
-This program applies a stochastic context free grammar to a given
 
1357
-corpus and reports the parsing accuracy and cross bracketing
 
1358
-accuracy of the grammar with respect to the grammar.
 
1359
-
 
1360
- */
 
1361
-
 
1362
-//@}
 
1363
-
 
1364
-/**@name OPTIONS
 
1365
-  */
 
1366
-//@{
 
1367
-
 
1368
-//@options
 
1369
-
 
1370
-//@}
 
1371
 
 
1372
 
 
1373
 int main(int argc, char **argv)
 
1374
--- a/main/scfg_train_main.cc
 
1375
+++ b/main/scfg_train_main.cc
 
1376
@@ -54,42 +54,6 @@
 
1377
 
 
1378
 static int scfg_train_main(int argc, char **argv);
 
1379
 
 
1380
-/** @name <command>scfg_train</command> <emphasis>Train the parameters of a stochastic context free grammar</emphasis>
 
1381
-    @id scfg-make-manual
 
1382
-  * @toc
 
1383
- */
 
1384
-
 
1385
-//@{
 
1386
-
 
1387
-
 
1388
-/**@name Synopsis
 
1389
-  */
 
1390
-//@{
 
1391
-
 
1392
-//@synopsis
 
1393
-
 
1394
-/**
 
1395
-
 
1396
-scfg_train takes a stochastic context free grammar (SCFG) and trains
 
1397
-the probabilities with respect to a given bracket corpus using the
 
1398
-inside-outside algorithm.   This is basically an implementation
 
1399
-of Pereira and Schabes 1992.
 
1400
-
 
1401
-Note using this program properly may require months of CPU time.
 
1402
-
 
1403
- */
 
1404
-
 
1405
-//@}
 
1406
-
 
1407
-/**@name OPTIONS
 
1408
-  */
 
1409
-//@{
 
1410
-
 
1411
-
 
1412
-//@options
 
1413
-
 
1414
-//@}
 
1415
-
 
1416
 
 
1417
 int main(int argc, char **argv)
 
1418
 {
 
1419
--- a/main/sig2fv_main.cc
 
1420
+++ b/main/sig2fv_main.cc
 
1421
@@ -90,55 +90,6 @@
 
1422
 
 
1423
 
 
1424
 
 
1425
-/** @name <command>sig2fv</command> <emphasis>Generate signal processing coefficients from waveforms</emphasis>
 
1426
-  * @id sigfv-manual
 
1427
-  * @toc
 
1428
- */
 
1429
-
 
1430
-//@{
 
1431
-
 
1432
-/**@name Synopsis
 
1433
-  */
 
1434
-//@{
 
1435
-
 
1436
-//@synopsis
 
1437
-
 
1438
-/**
 
1439
-sig2fv is used to create signal processing feature vector analysis on speech
 
1440
-waveforms.
 
1441
-The following types of analysis are provided:
 
1442
-
 
1443
-<itemizedlist>
 
1444
-<listitem><para>Linear prediction (LPC)</para></listitem>
 
1445
-<listitem><para>Cepstrum coding from lpc coefficients</para></listitem>
 
1446
-<listitem><para>Mel scale cepstrum coding via fbank</para></listitem>
 
1447
-<listitem><para>Mel scale log filterbank analysis</para></listitem>
 
1448
-<listitem><para>Line spectral frequencies</para></listitem>
 
1449
-<listitem><para>Linear prediction reflection coefficients</para></listitem>
 
1450
-<listitem><para>Root mean square energy</para></listitem>
 
1451
-<listitem><para>Power</para></listitem>
 
1452
-<listitem><para>fundamental frequency (pitch)</para></listitem>
 
1453
-<listitem><para>calculation of delta and acceleration coefficients of all of the 
 
1454
-above</para></listitem>
 
1455
-</itemizedlist>
 
1456
-
 
1457
-The -coefs option is used to specify a list of the names of what sort
 
1458
-of basic processing is required, and -delta and -acc are used for
 
1459
-delta and acceleration coefficients respectively.
 
1460
-
 
1461
-*/
 
1462
-
 
1463
-//@}
 
1464
-
 
1465
-/**@name Options
 
1466
-  */
 
1467
-//@{
 
1468
-
 
1469
-//@options
 
1470
-
 
1471
-//@}
 
1472
-
 
1473
-
 
1474
 int main(int argc, char *argv[])
 
1475
 {
 
1476
     EST_String out_file("-");
 
1477
@@ -339,75 +290,4 @@
 
1478
 
 
1479
 }
 
1480
 
 
1481
-/**@name Examples
 
1482
-
 
1483
-
 
1484
-Fixed frame basic linear prediction:
 
1485
-
 
1486
-To produce a set of linear prediction coefficients at every 10ms, using
 
1487
-pre-emphasis  and saving in EST format:
 
1488
-
 
1489
-<para>
 
1490
-<screen>
 
1491
-$ sig2fv kdt_010.wav -o kdt_010.lpc -coefs "lpc" -otype est -shift 0.01 -preemph 0.5
 
1492
-</screen>
 
1493
-</para>
 
1494
-<formalpara><title>
 
1495
-Pitch Synchronous linear prediction</title><para>. The following used the set of pitchmarks
 
1496
-in kdt_010.pm as the centres of the analysis windows.
 
1497
-</para>
 
1498
-</formalpara>
 
1499
-
 
1500
-<para>
 
1501
-<screen>
 
1502
-$ sig2fv kdt_010.wav -pm kdt_010.pm -o kdt_010.lpc -coefs "lpc" -otype est -shift 0.01 -preemph 0.5
 
1503
-</screen>
 
1504
-</para>
 
1505
-
 
1506
-<para>
 
1507
-F0, Linear prediction and cepstral coefficients:
 
1508
-
 
1509
-<screen>
 
1510
-$ sig2fv kdt_010.wav -o kdt_010.lpc -coefs "f0 lpc cep" -otype est -shift 0.01
 
1511
-</screen>
 
1512
-
 
1513
-Note that pitchtracking can also be done with the
 
1514
-<command>pda</command> program. Both use the same underlying
 
1515
-technique, but the pda program offers much finer control over the
 
1516
-pitch track specific processing parameters.
 
1517
-
 
1518
-</para>
 
1519
-
 
1520
-<para>Energy, Linear Prediction and Cepstral coefficients, with a 10ms frame shift
 
1521
-during analysis but a 5ms frame shift in the output file:
 
1522
-
 
1523
-<para>
 
1524
-<screen>
 
1525
-$ sig2fv kdt_010.wav -o kdt_010.lpc -coefs "f0 lpc cep" -otype est -S 0.005
 
1526
-      -shift 0.01
 
1527
-</screen>
 
1528
-</para>
 
1529
-
 
1530
-<para>Delta  and acc coefficients can be calculated even if their base form is not 
 
1531
-required. This produces normal energy coefficients and cepstral delta coefficients:
 
1532
-
 
1533
-<para>
 
1534
-<screen>
 
1535
-$ sig2fv ../kdt_010.wav -o kdt_010.lpc -coefs "energy" -delta "cep" -otype est
 
1536
-</screen>
 
1537
-</para>
 
1538
-
 
1539
-<para>Mel-scaled cepstra, Delta and acc coefficients, as is common in speech 
 
1540
-recognition:
 
1541
-<para>
 
1542
-<screen>
 
1543
-$ sig2fv ../kdt_010.wav -o kdt_010.lpc -coefs "melcep" -delta "melcep" -acc "melcep" -otype est -preemph 0.96
 
1544
-</screen>
 
1545
-
 
1546
-*/
 
1547
-//@{
 
1548
-//@}
 
1549
-
 
1550
-
 
1551
 
 
1552
-//@}
 
1553
--- a/main/sigfilter_main.cc
 
1554
+++ b/main/sigfilter_main.cc
 
1555
@@ -53,34 +53,6 @@
 
1556
 void FIR_double_filter(EST_Wave &in_sig, EST_Wave &out_sig, 
 
1557
                       const EST_FVector &numerator);
 
1558
 
 
1559
-/** @name <command>sigfilter</command> <emphasis>Filter waveforms</emphasis>
 
1560
-  * @id sigfilter-manual
 
1561
-  * @toc
 
1562
- */
 
1563
-
 
1564
-//@{
 
1565
-
 
1566
-/**@name Synopsis
 
1567
-  */
 
1568
-//@{
 
1569
-
 
1570
-//@synopsis
 
1571
-
 
1572
-/**
 
1573
-<command>sigfilter</command> filters an input waveform and produces a 
 
1574
-output waveform.
 
1575
-
 
1576
-*/
 
1577
-
 
1578
-//@}
 
1579
-
 
1580
-/**@name Options
 
1581
-  */
 
1582
-//@{
 
1583
-
 
1584
-//@options
 
1585
-
 
1586
-//@}
 
1587
 
 
1588
 int main (int argc, char *argv[])
 
1589
 {
 
1590
--- a/main/siod_main.cc
 
1591
+++ b/main/siod_main.cc
 
1592
@@ -48,40 +48,6 @@
 
1593
 
 
1594
 void siod_server_init(void);
 
1595
 
 
1596
-/** @name <command>siod</command> <emphasis>Scheme Interpreter</emphasis>
 
1597
-    @id siod-manual
 
1598
-  * @toc
 
1599
- */
 
1600
-
 
1601
-//@{
 
1602
-
 
1603
-
 
1604
-/**@name Synopsis
 
1605
-  */
 
1606
-//@{
 
1607
-
 
1608
-//@synopsis
 
1609
-
 
1610
-/**
 
1611
 
1612
-   <command>siod</command> is a command line interface to the
 
1613
-   <productname>Scheme In One Defun</productname> Scheme interpreter,
 
1614
-   as modified by CSTR for use in &theEST;. It is essentially &festival;
 
1615
-   without the speech synthesis code.
 
1616
-
 
1617
- */
 
1618
-
 
1619
-//@}
 
1620
-
 
1621
-/**@name OPTIONS
 
1622
-  */
 
1623
-//@{
 
1624
-
 
1625
-//@options
 
1626
-
 
1627
-//@}
 
1628
-
 
1629
-
 
1630
 int main(int argc, char **argv)
 
1631
 {
 
1632
     EST_Option al;
 
1633
--- a/main/spectgen_main.cc
 
1634
+++ b/main/spectgen_main.cc
 
1635
@@ -48,43 +48,6 @@
 
1636
 
 
1637
 void set_options(EST_Features &op, EST_Option &al);
 
1638
 
 
1639
-/** @name <command>spectgen</command> <emphasis>Make spectrograms</emphasis>
 
1640
-  * @id spectgen-manual
 
1641
-  * @toc
 
1642
- */
 
1643
-
 
1644
-//@{
 
1645
-
 
1646
-/**@name Synopsis
 
1647
-  */
 
1648
-//@{
 
1649
-
 
1650
-//@synopsis
 
1651
-
 
1652
-/**
 
1653
-spectgen is used to create spectrograms, which are 3d plots of
 
1654
-amplitude against time and frequency. Spectgen takes a waveform and
 
1655
-produces a track, where each channel represents one frequency bin. 
 
1656
-
 
1657
-By default spectgen produces a "wide-band" spectrogram, that is one
 
1658
-with high time resolution and low frequency resolution. "Narrow-band"
 
1659
-spectrograms can be produced by using the -shift and -length options.
 
1660
-
 
1661
-Typical values for -shift and -length are:
 
1662
-
 
1663
-
 
1664
-
 
1665
-*/
 
1666
-
 
1667
-//@}
 
1668
-
 
1669
-/**@name Options
 
1670
-  */
 
1671
-//@{
 
1672
-
 
1673
-//@options
 
1674
-
 
1675
-//@}
 
1676
 
 
1677
 
 
1678
 int main(int argc, char *argv[])
 
1679
--- a/main/tilt_analysis_main.cc
 
1680
+++ b/main/tilt_analysis_main.cc
 
1681
@@ -61,39 +61,10 @@
 
1682
 
 
1683
 
 
1684
 
 
1685
-/** @name <command>tilt_analysis</command> <emphasis>Produce tilt descriptions from F0 contours</emphasis>
 
1686
- * @id tilt_analysis-manual
 
1687
- * @toc
 
1688
- */
 
1689
 
 
1690
-//@{
 
1691
 
 
1692
 void extract_channels(EST_Wave &single, const EST_Wave &multi,  EST_IList &ch_list);
 
1693
 
 
1694
-/**@name Synopsis
 
1695
-  */
 
1696
-//@{
 
1697
-
 
1698
-//@synopsis
 
1699
-
 
1700
-/**
 
1701
-tilt_analysis produces a Tilt or RFC analysis of a F0 contour, given a set
 
1702
-label file containing a set of approximate intonational event boundaries.
 
1703
-
 
1704
-A detailed description of the Tilt intonation model can be found in the
 
1705
-<link linkend="tilt-overview">Tilt model overview</link> section.
 
1706
-
 
1707
-*/
 
1708
-
 
1709
-//@}
 
1710
-
 
1711
-/**@name OPTIONS
 
1712
-  */
 
1713
-//@{
 
1714
-
 
1715
-//@options
 
1716
-
 
1717
-//@}
 
1718
 
 
1719
 
 
1720
 
 
1721
@@ -207,97 +178,6 @@
 
1722
     ev.save(out_file);
 
1723
 }
 
1724
 
 
1725
-/** @name Input Intonation Files
 
1726
-
 
1727
-A label file containing approximate intonational event boundaries must
 
1728
-be given as input. A typical file in xlabel format is shown below:
 
1729
-</para>
 
1730
-<para>
 
1731
-<screen>
 
1732
-    0.290  146 sil
 
1733
-    0.480  146 c
 
1734
-    0.620  146 a
 
1735
-    0.760  146 c
 
1736
-    0.960  146 a
 
1737
-    1.480  146 c
 
1738
-    1.680  146 a
 
1739
-    1.790  146 sil
 
1740
-</screen>
 
1741
-</para>
 
1742
-<para>
 
1743
-The set of intonational events can be given on the command line with
 
1744
-the -event_names option. The default set is "a rb arb m mrb" and so
 
1745
-the above example would not need the -event_names option. The label
 
1746
-"c" (connection) is to separate events, in effect giving each event a
 
1747
-start time as well as a end time. The silence labels are important
 
1748
-also: they specify where phrases should start and end.
 
1749
-*/
 
1750
-
 
1751
-//@{
 
1752
-//@}
 
1753
-
 
1754
-/** @name Input F0  Files
 
1755
-
 
1756
-tilt_analysis can operate on all the F0 file types supported by the
 
1757
-EST library. Tilt analysis can only operate on smooth and continuous
 
1758
-F0 contours.(i.e. F0 values must be defined during unvoiced
 
1759
-regons). If the input contour is not in this format, use the -smooth
 
1760
-option. The -w1 and -w2 options can be used to control the amount of
 
1761
-smoothing. The smoothed version of the input contour can be examined
 
1762
-by saving it using the -sf0 option.
 
1763
-
 
1764
-*/
 
1765
-
 
1766
-//@{
 
1767
-//@}
 
1768
-
 
1769
-/** @name Output Intonation Files
 
1770
-
 
1771
-The output will be a label file containing the tilt parameters for the
 
1772
-events in feature format. An example, in xlabel format, is shown below:
 
1773
-</para>
 
1774
-<para>
 
1775
-<screen>
 
1776
-intonation_style tilt
 
1777
-#
 
1778
-0.29 26     phrase_start ; ev.f0 115.234 ; time 0.29 ; 
 
1779
-0.53 26     a ; int_event 1 ; ev.f0 118.171 ; time 0.53 ; tilt.amp 21.8602 ; 
 
1780
-              tilt.dur 0.26 ; tilt.tilt -0.163727 ; 
 
1781
-0.77 26     a ; int_event 1 ; ev.f0 112.694 ; time 0.77 ; tilt.amp 27.0315 ; 
 
1782
-              tilt.dur 0.32 ; tilt.tilt -0.446791 ; 
 
1783
-1.53 26     a ; int_event 1 ; ev.f0 100.83 ; time 1.53 ; tilt.amp 7.507 ; 
 
1784
-              tilt.dur 0.22 ; tilt.tilt -0.296317 ; 
 
1785
-1.79 26     phrase_end ; ev.f0 92.9785 ; time 1.79 ; 
 
1786
-</screen>
 
1787
-</para>
 
1788
-<para>
 
1789
-The -rfc option will make a file containing the RFC parameters instead:
 
1790
-</para>
 
1791
-<para>
 
1792
-<screen>
 
1793
-intonation_style rfc
 
1794
-#
 
1795
-0.29 26     phrase_start ; ev.f0 115.234 ; time 0.29 ; 
 
1796
-0.53 26     a ; ev.f0 118.171 ; rfc.rise_amp 8.19178 ; rfc.rise_dur 0.12 ; 
 
1797
-               rfc.fall_amp -13.6684 ; rfc.fall_dur 0.14 ; time 0.53 ;
 
1798
- 0.77 26     a ; ev.f0 112.694 ; rfc.rise_amp 6.50673 ; rfc.rise_dur 0.1 ;
 
1799
-                rfc.fall_amp -20.5248 ; rfc.fall_dur 0.22 ; time 0.77 ; 
 
1800
-1.53 26     a ; ev.f0 100.83 ; rfc.rise_amp 1.55832 ; rfc.rise_dur 0.11 ; 
 
1801
-                rfc.fall_amp -6.09238 ; rfc.fall_dur 0.11 ; time 1.53 ; 
 
1802
-1.79 26     phrase_end ; ev.f0 92.9785 ; time 1.79 ; 
 
1803
-</screen>
 
1804
-</para>
 
1805
-<para>
 
1806
-The feature in the header, "intonation_style tilt" or
 
1807
-"intonation_style rfc" is needed for the tilt_synthesis program to
 
1808
-work.
 
1809
-
 
1810
-*/
 
1811
-
 
1812
-//@{
 
1813
-//@}
 
1814
-
 
1815
-//@}
 
1816
 
 
1817
 
 
1818
 void override_rfc_params(EST_Features &rfc, EST_Option &al)
 
1819
--- a/main/tilt_synthesis_main.cc
 
1820
+++ b/main/tilt_synthesis_main.cc
 
1821
@@ -43,41 +43,9 @@
 
1822
 #include "ling_class/EST_relation_aux.h"
 
1823
 #include "EST_string_aux.h"
 
1824
 
 
1825
-/** @name <command>tilt_synthesis</command> <emphasis>Generate F0 contours from Tilt descriptions</emphasis>
 
1826
- * @id tilt_synthesis-manual
 
1827
-  * @toc
 
1828
- */
 
1829
-
 
1830
-//@{
 
1831
 
 
1832
 void extract_channels(EST_Wave &single, const EST_Wave &multi,  EST_IList &ch_list);
 
1833
 
 
1834
-/**@name Synopsis
 
1835
-  */
 
1836
-//@{
 
1837
-
 
1838
-//@synopsis
 
1839
-
 
1840
-/**
 
1841
-tilt_synthesis generates a F0 contour, given a label file containing
 
1842
-parameterised Tilt or RFC events.
 
1843
-
 
1844
-A detailed description of the Tilt intonation model can be found in the
 
1845
-<link linkend="tilt-overview">Tilt model overview</link> section.
 
1846
-
 
1847
-
 
1848
-*/
 
1849
-
 
1850
-//@}
 
1851
-
 
1852
-/**@name OPTIONS
 
1853
-  */
 
1854
-//@{
 
1855
-
 
1856
-//@options
 
1857
-
 
1858
-//@}
 
1859
-
 
1860
 
 
1861
 int main (int argc, char *argv[])
 
1862
 {
 
1863
@@ -143,53 +111,7 @@
 
1864
     return 0;
 
1865
 }
 
1866
 
 
1867
-/** @name Input Intonation Files
 
1868
-
 
1869
-The input should be a label file containing the tilt parameters for the
 
1870
-events in feature format. An example, in xlabel format, is shown below:
 
1871
-</para>
 
1872
-<para>
 
1873
-<screen>
 
1874
-intonation_style tilt
 
1875
-#
 
1876
-0.29 26     phrase_start ; ev.f0 115.234 ; position 0.29 ; 
 
1877
-0.53 26     a ; int_event 1 ; ev.f0 118.171 ; position 0.53 ; tilt.amp 21.8602 ; 
 
1878
-              tilt.dur 0.26 ; tilt.tilt -0.163727 ; 
 
1879
-0.77 26     a ; int_event 1 ; ev.f0 112.694 ; position 0.77 ; tilt.amp 27.0315 ; 
 
1880
-              tilt.dur 0.32 ; tilt.tilt -0.446791 ; 
 
1881
-1.53 26     a ; int_event 1 ; ev.f0 100.83 ; position 1.53 ; tilt.amp 7.507 ; 
 
1882
-              tilt.dur 0.22 ; tilt.tilt -0.296317 ; 
 
1883
-1.79 26     phrase_end ; ev.f0 92.9785 ; position 1.79 ; 
 
1884
-</screen>
 
1885
-</para>
 
1886
-<para>
 
1887
-tilt_synthesis can also generate F0 contours from RFC parameters:
 
1888
-</para>
 
1889
-<para>
 
1890
-<screen>
 
1891
-intonation_style rfc
 
1892
-#
 
1893
-0.29 26     phrase_start ; ev.f0 115.234 ; position 0.29 ; 
 
1894
-0.53 26     a ; ev.f0 118.171 ; rfc.rise_amp 8.19178 ; rfc.rise_dur 0.12 ; 
 
1895
-               rfc.fall_amp -13.6684 ; rfc.fall_dur 0.14 ; position 0.53 ;
 
1896
- 0.77 26     a ; ev.f0 112.694 ; rfc.rise_amp 6.50673 ; rfc.rise_dur 0.1 ;
 
1897
-                rfc.fall_amp -20.5248 ; rfc.fall_dur 0.22 ; position 0.77 ; 
 
1898
-1.53 26     a ; ev.f0 100.83 ; rfc.rise_amp 1.55832 ; rfc.rise_dur 0.11 ; 
 
1899
-                rfc.fall_amp -6.09238 ; rfc.fall_dur 0.11 ; position 1.53 ; 
 
1900
-1.79 26     phrase_end ; ev.f0 92.9785 ; position 1.79 ; 
 
1901
-</screen>
 
1902
-</para>
 
1903
-<para>
 
1904
-The feature in the header, "intonation_style tilt" or
 
1905
-"intonation_style rfc" is needed for the tilt_synthesis program to know which
 
1906
-type of synthesis to perform.
 
1907
-
 
1908
-*/
 
1909
-
 
1910
-//@{
 
1911
-//@}
 
1912
 
 
1913
-//@}
 
1914
 
 
1915
 
 
1916
 void override_lib_ops(EST_Option &a_list, EST_Option &al)
 
1917
--- a/main/viterbi_main.cc
 
1918
+++ b/main/viterbi_main.cc
 
1919
@@ -105,72 +105,6 @@
 
1920
 int num_obs = 1;
 
1921
 
 
1922
 
 
1923
-
 
1924
-
 
1925
-/** @name  <command>viterbi</command> <emphasis>Combine n-gram model and likelihoods to estimate posterior probabilities</emphasis>
 
1926
-  * @id viterbi-manual
 
1927
-  * @toc
 
1928
- */
 
1929
-
 
1930
-//@{
 
1931
-
 
1932
-/**@name Synopsis
 
1933
-  */
 
1934
-//@{
 
1935
-
 
1936
-//@synopsis
 
1937
-
 
1938
-/**
 
1939
-viterbi is a simple time-synchronous Viterbi decoder. It finds the
 
1940
-most likely sequence of items drawn from a fixed vocabulary, given
 
1941
-frame-by-frame observation probabilities for each item in that
 
1942
-vocabulary, and a ngram grammar. Possible uses include:
 
1943
-
 
1944
-<itemizedlist>
 
1945
-<listitem><para>Simple speech recogniser back end</para></listitem>
 
1946
-</itemizedlist>
 
1947
-
 
1948
-viterbi can optionally use two sets of frame-by-frame observation
 
1949
-probabilities in a weighted-sum fashion. Also, the ngram language model
 
1950
-is not restricted to the conventional sliding window type in which the
 
1951
-previous n-1 items are the ngram context. Items in the ngram context
 
1952
-at each frame may be given. In this case, the user must provide a file
 
1953
-containing the ngram context: one (n-1) tuple per line. To include
 
1954
-items from the partial Viterbi path so far (i.e. found at recognition
 
1955
-time, not given) the special notation <-N> is used where N indicates
 
1956
-the distance back to the item required. For example <-1> would
 
1957
-indicate the item on the partial Viterbi path at the last frame. See
 
1958
-\Ref{Examples}.
 
1959
-
 
1960
-<formalpara>
 
1961
-<para><title>Pruning</title></para>
 
1962
-
 
1963
-<para>
 
1964
-Three types of pruning are available to reduce the size of the search
 
1965
-space and therefore speed up the search:
 
1966
-
 
1967
-<itemizedlist>
 
1968
-<listitem><para>Observation pruning</para></listitem>
 
1969
-<listitem><para>Top-N pruning at each frame</para></listitem>
 
1970
-<listitem><para>Fixed width beam pruning</para></listitem>
 
1971
-</itemizedlist>
 
1972
-
 
1973
-</para>
 
1974
-</formalpara>
 
1975
-
 
1976
-*/
 
1977
-
 
1978
-//@}
 
1979
-
 
1980
-/**@name Options
 
1981
-  */
 
1982
-//@{
 
1983
-
 
1984
-//@options
 
1985
-
 
1986
-
 
1987
-//@}
 
1988
-
 
1989
 int main(int argc, char **argv)
 
1990
 {
 
1991
     EST_StrList files;
 
1992
@@ -824,26 +758,3 @@
 
1993
 }
 
1994
 
 
1995
 
 
1996
-/**@name Examples
 
1997
-
 
1998
-Example 'given' file (items f and g are in the vocabulary), the ngram
 
1999
-is a 4-gram.
 
2000
-
 
2001
-<para>
 
2002
-<screen>
 
2003
-<-2> g g
 
2004
-<-1> g f
 
2005
-<-1> f g
 
2006
-<-2> g g
 
2007
-<-3> g g
 
2008
-<-1> g f
 
2009
-</screen>
 
2010
-</para>
 
2011
-
 
2012
-*/
 
2013
-//@{
 
2014
-//@}
 
2015
-
 
2016
-
 
2017
-
 
2018
-//@}
 
2019
--- a/main/wagon_main.cc
 
2020
+++ b/main/wagon_main.cc
 
2021
@@ -55,54 +55,6 @@
 
2022
 
 
2023
 static int wagon_main(int argc, char **argv);
 
2024
 
 
2025
-/** @name <command>wagon</command> <emphasis>CART building program</emphasis>
 
2026
-    @id wagon_manual
 
2027
-  * @toc
 
2028
- */
 
2029
-
 
2030
-//@{
 
2031
-
 
2032
-
 
2033
-/**@name Synopsis
 
2034
-  */
 
2035
-//@{
 
2036
-
 
2037
-//@synopsis
 
2038
-
 
2039
-/**
 
2040
-wagon is used to build CART tress from feature data, its basic
 
2041
-features include:
 
2042
-
 
2043
-<itemizedlist>
 
2044
-<listitem><para>both decisions trees and decision lists are supported</para></listitem>
 
2045
-<listitem><para>predictees can be discrete or continuous</para></listitem>
 
2046
-<listitem><para>input features may be discrete or continuous</para></listitem>
 
2047
-<listitem><para>many options for controlling tree building</para>
 
2048
-<itemizedlist>
 
2049
-<listitem><para>fixed stop value</para></listitem>
 
2050
-<listitem><para>balancing</para></listitem>
 
2051
-<listitem><para>held-out data and pruning</para></listitem>
 
2052
-<listitem><para>stepwise use of input features</para></listitem>
 
2053
-<listitem><para>choice of optimization criteria correct/entropy (for 
 
2054
-classification and rmse/correlation (for regression)</para></listitem>
 
2055
-</itemizedlist>
 
2056
-</listitem>
 
2057
-</itemizedlist>
 
2058
-
 
2059
-A detailed description of building CART models can be found in the
 
2060
-<link linkend="cart-overview">CART model overview</link> section.
 
2061
-
 
2062
-*/
 
2063
-
 
2064
-//@}
 
2065
-
 
2066
-/**@name OPTIONS
 
2067
-  */
 
2068
-//@{
 
2069
-
 
2070
-//@options
 
2071
-
 
2072
-//@}
 
2073
 
 
2074
 int main(int argc, char **argv)
 
2075
 {
 
2076
@@ -394,76 +346,3 @@
 
2077
     return 0;
 
2078
 }
 
2079
 
 
2080
-/** @name Building Trees
 
2081
-
 
2082
-To build a decision tree (or list) Wagon requires data and a description
 
2083
-of it.  A data file consists a set of samples, one per line each
 
2084
-consisting of the same set of features.   Features may be categorial
 
2085
-or continuous.  By default the first feature is the predictee and the
 
2086
-others are used as predictors.  A typical data file will look like
 
2087
-this
 
2088
-</para>
 
2089
-<para>
 
2090
-<screen>
 
2091
-0.399 pau sh  0   0     0 1 1 0 0 0 0 0 0 
 
2092
-0.082 sh  iy  pau onset 0 1 0 0 1 1 0 0 1
 
2093
-0.074 iy  hh  sh  coda  1 0 1 0 1 1 0 0 1
 
2094
-0.048 hh  ae  iy  onset 0 1 0 1 1 1 0 1 1
 
2095
-0.062 ae  d   hh  coda  1 0 0 1 1 1 0 1 1
 
2096
-0.020 d   y   ae  coda  2 0 1 1 1 1 0 1 1
 
2097
-0.082 y   ax  d   onset 0 1 0 1 1 1 1 1 1
 
2098
-0.082 ax  r   y   coda  1 0 0 1 1 1 1 1 1
 
2099
-0.036 r   d   ax  coda  2 0 1 1 1 1 1 1 1
 
2100
-...
 
2101
-</screen>
 
2102
-</para>
 
2103
-<para>
 
2104
-The data may come from any source, such as the festival script 
 
2105
-dumpfeats which allows the creation of such files easily from utterance
 
2106
-files.  
 
2107
-</para><para>
 
2108
-In addition to a data file a description file is also require that 
 
2109
-gives a name and a type to each of the features in the datafile.
 
2110
-For the above example it would look like
 
2111
-</para><para>
 
2112
-<screen>
 
2113
-((segment_duration float)
 
2114
- ( name  aa ae ah ao aw ax ay b ch d dh dx eh el em en er ey f g 
 
2115
-    hh ih iy jh k l m n nx ng ow oy p r s sh t th uh uw v w y z zh pau )
 
2116
- ( n.name 0 aa ae ah ao aw ax ay b ch d dh dx eh el em en er ey f g 
 
2117
-    hh ih iy jh k l m n nx ng ow oy p r s sh t th uh uw v w y z zh pau )
 
2118
- ( p.name 0 aa ae ah ao aw ax ay b ch d dh dx eh el em en er ey f g 
 
2119
-    hh ih iy jh k l m n nx ng ow oy p r s sh t th uh uw v w y z zh pau )
 
2120
- (position_type 0 onset coda)
 
2121
- (pos_in_syl float)
 
2122
- (syl_initial 0 1)
 
2123
- (syl_final   0 1)
 
2124
- (R:Sylstructure.parent.R:Syllable.p.syl_break float)
 
2125
- (R:Sylstructure.parent.syl_break float)
 
2126
- (R:Sylstructure.parent.R:Syllable.n.syl_break float)
 
2127
- (R:Sylstructure.parent.R:Syllable.p.stress 0 1)
 
2128
- (R:Sylstructure.parent.stress 0 1)
 
2129
- (R:Sylstructure.parent.R:Syllable.n.stress 0 1)
 
2130
-)
 
2131
-</screen>
 
2132
-</para><para>
 
2133
-The feature names are arbitrary, but as they appear in the generated
 
2134
-trees is most useful if the trees are to be used in prediction of
 
2135
-an utterance that the names are features and/or pathnames.  
 
2136
-</para><para>
 
2137
-Wagon can be used to build a tree with such files with the command
 
2138
-<screen>
 
2139
-wagon -data feats.data -desc fest.desc -stop 10 -output feats.tree
 
2140
-</screen>
 
2141
-A test data set may also be given which must match the given data description.
 
2142
-If specified the built tree will be tested on the test set and results
 
2143
-on that will be presented on completion, without a test set the
 
2144
-results are given with respect to the training data.  However in
 
2145
-stepwise case the test set is used in the multi-level training process
 
2146
-thus it cannot be considered as true test data and more reasonable 
 
2147
-results should found on applying the generate tree to truly
 
2148
-held out data (via the program wagon_test).
 
2149
-
 
2150
-*/
 
2151
-
 
2152
-//@}
 
2153
--- a/main/wagon_test_main.cc
 
2154
+++ b/main/wagon_test_main.cc
 
2155
@@ -59,26 +59,6 @@
 
2156
 static void test_tree_float(EST_TokenStream &data, FILE *output, 
 
2157
                            LISP tree, LISP description);
 
2158
 
 
2159
-/** @name <command>wagon_test</command> <emphasis>Test CART models</emphasis>
 
2160
-    @id wagon-test-manual
 
2161
-  * @toc
 
2162
- */
 
2163
-
 
2164
-//@{
 
2165
-
 
2166
-
 
2167
-/**@name Synopsis
 
2168
-  */
 
2169
-//@{
 
2170
-
 
2171
-//@synopsis
 
2172
-
 
2173
-/**
 
2174
-Wagon_test is used to test CART models on feature data.
 
2175
-
 
2176
-A detailed description of the CART model can be found in the
 
2177
-<link linkend="cart-overview">CART model overview</link> section.
 
2178
-*/
 
2179
 
 
2180
 int main(int argc, char **argv)
 
2181
 {
 
2182
@@ -409,41 +389,3 @@
 
2183
 
 
2184
 }
 
2185
 
 
2186
-/** @name Testing trees
 
2187
-<para>
 
2188
-Decision trees generated by wagon (or otherwise) can be applied
 
2189
-to and tested against data sets using this program.  This program
 
2190
-requires a data set which is in the same format as wagon (and
 
2191
-other programs) requires.  It also needs a dataset description
 
2192
-file naming the fields and given their type (see 
 
2193
-<link linkend="wagon-manual">the wagon manual</link> for a description
 
2194
-for the actual format.
 
2195
-<screen>
 
2196
-wagon_test -data feats.data -desc feats.desc -tree feats.tree
 
2197
-</screen>
 
2198
-This will simply uses the tree against each sample in the data
 
2199
-file and compare the predicted value with the actual value and
 
2200
-produce a summary of the result.  For categorial predictees a
 
2201
-percentage correct and confusion matrix is generated.  For continuous
 
2202
-values the root mean squared error (RMSE) and correlation between the
 
2203
-predicted values and the actual values is given.  
 
2204
-</para><para>
 
2205
-By default the predictee is the first field but may also be specified
 
2206
-on the command line.  The dataset may contain features which are not
 
2207
-used by the tree.
 
2208
-</para><para>
 
2209
-This program can also be used to generate output values for sampled
 
2210
-data.  In this case the sample data must still contain a "value" for
 
2211
-the predictee even if it is dummy.  The option
 
2212
-<command>-predict</command> will output the new sample vector with
 
2213
-the predicted value in place, and the option
 
2214
-<command>-predict_val</command> option will just output the value.
 
2215
-</para><para>
 
2216
-This program is specifically designed for testing purposes although it
 
2217
-can also just be used for prediction. It is probably more efficient
 
2218
-to use the Lisp function <command>wagon</command> or underlying
 
2219
-C++ function <command>wagon_predict()</command>.
 
2220
-
 
2221
-*/
 
2222
-
 
2223
-//@}
 
2224
--- a/main/wfst_build_main.cc
 
2225
+++ b/main/wfst_build_main.cc
 
2226
@@ -60,61 +60,6 @@
 
2227
 static int wfst_build_main(int argc, char **argv);
 
2228
 
 
2229
 
 
2230
-
 
2231
-/** @name <command>wfst_build</command> <emphasis>Build a weighted finite-state transducer</emphasis>
 
2232
-    @id wfst-build-manual
 
2233
-  * @toc
 
2234
- */
 
2235
-
 
2236
-//@{
 
2237
-
 
2238
-
 
2239
-/**@name Synopsis
 
2240
-  */
 
2241
-//@{
 
2242
-
 
2243
-//@synopsis
 
2244
-
 
2245
-/**
 
2246
-
 
2247
-Build and.or process weighted finite state transducers (WFSTs) form
 
2248
-various input formats.  This program accepts descriptions
 
2249
-in the following formats and converts them to WFSTs
 
2250
-<itemizedlist>
 
2251
-<listitem><para>regular expressions</para></listitem>
 
2252
-<listitem><para>regular grammars</para></listitem>
 
2253
-<listitem><para>Koskenniemi/Kay/Kaplan context restriction rules</para></listitem>
 
2254
-</itemizedlist>
 
2255
-In addition various operations can be performed on two WFSTs
 
2256
-<itemizedlist>
 
2257
-<listitem><para>compose: form new WFST feeding output of first WFSTs into
 
2258
-second WFSTs.</para></listitem>
 
2259
-<listitem><para>union: form new WFST accepting the language both WFSTs
 
2260
-</para></listitem>
 
2261
-<listitem><para>intersect: form new WFST accepting only the language common
 
2262
-to both WFSTs
 
2263
-</para></listitem>
 
2264
-<listitem><para>concat: form new WFST accepting the language from the
 
2265
-concatenation of all strings in the first WFST to all strings in the
 
2266
-second.
 
2267
-</para></listitem>
 
2268
-</itemizedlist>
 
2269
-The newly formed WFSTs can be optionally determinized and minimzed.
 
2270
-
 
2271
-The option asis allows a single WFSTs to be loaded and determinized
 
2272
-and/or minimized
 
2273
-
 
2274
- */
 
2275
-
 
2276
-//@}
 
2277
-
 
2278
-/**@name OPTIONS
 
2279
-  */
 
2280
-//@{
 
2281
-
 
2282
-//@options
 
2283
-
 
2284
-//@}
 
2285
 int main(int argc, char **argv)
 
2286
 {
 
2287
 
 
2288
--- a/main/wfst_run_main.cc
 
2289
+++ b/main/wfst_run_main.cc
 
2290
@@ -47,37 +47,6 @@
 
2291
 
 
2292
 static int wfst_run_main(int argc, char **argv);
 
2293
 
 
2294
-/** @name <command>wfst_run</command> <emphasis>Run a weighted finite-state transducer</emphasis>
 
2295
-    @id wfst-run-manual
 
2296
-  * @toc
 
2297
- */
 
2298
-
 
2299
-//@{
 
2300
-
 
2301
-
 
2302
-/**@name Synopsis
 
2303
-  */
 
2304
-//@{
 
2305
-
 
2306
-//@synopsis
 
2307
-
 
2308
-/**
 
2309
-This program runs a WFST on some given data.  It works in either
 
2310
-recognize mode where both inputs and output are specified, but also
 
2311
-in transduction mode where an input is transduced to the output.
 
2312
-
 
2313
- */
 
2314
-
 
2315
-//@}
 
2316
-
 
2317
-/**@name OPTIONS
 
2318
-  */
 
2319
-//@{
 
2320
-
 
2321
-//@options
 
2322
-
 
2323
-//@}
 
2324
-
 
2325
 
 
2326
 int main(int argc, char **argv)
 
2327
 {
 
2328
--- a/main/wfst_train_main.cc
 
2329
+++ b/main/wfst_train_main.cc
 
2330
@@ -50,37 +50,6 @@
 
2331
 
 
2332
 static int wfst_train_main(int argc, char **argv);
 
2333
 
 
2334
-/** @name <command>wfst_train</command> <emphasis>Train a weighted finite-state transducer</emphasis>
 
2335
-    @id wfst-train-manual
 
2336
-  * @toc
 
2337
- */
 
2338
-
 
2339
-//@{
 
2340
-
 
2341
-
 
2342
-/**@name Synopsis
 
2343
-  */
 
2344
-//@{
 
2345
-
 
2346
-//@synopsis
 
2347
-
 
2348
-/**
 
2349
-This takes an existing WFST and data and splits states in an entropy
 
2350
-reduce way to produced a new WFST that better models the given data.
 
2351
-
 
2352
- */
 
2353
-
 
2354
-//@}
 
2355
-
 
2356
-/**@name OPTIONS
 
2357
-  */
 
2358
-//@{
 
2359
-
 
2360
-//@options
 
2361
-
 
2362
-//@}
 
2363
-
 
2364
-
 
2365
 int main(int argc, char **argv)
 
2366
 {
 
2367
 
 
2368
--- a/main/xml_parser_main.cc
 
2369
+++ b/main/xml_parser_main.cc
 
2370
@@ -95,41 +95,6 @@
 
2371
                void *data);
 
2372
 };
 
2373
 
 
2374
-/** @name <command>xml_parser</command>
 
2375
-    @id xml_parser_manual
 
2376
-  * @toc
 
2377
- */
 
2378
-
 
2379
-//@{
 
2380
-
 
2381
-
 
2382
-/**@name Synopsis
 
2383
-  */
 
2384
-//@{
 
2385
-
 
2386
-//@synopsis
 
2387
-
 
2388
-/**
 
2389
-
 
2390
-   <command>xml_parser</command> is a simple program giving access to
 
2391
-   the <productname>RXP</productname> &xml; parser. It parses an input
 
2392
-   file and prints the results out in a simple indented format. It's
 
2393
-   main use is as a development tool, to check that files intended for
 
2394
-   input to an &xml; application, for instance &festival;, parse as
 
2395
-   you expect.
 
2396
-
 
2397
- */
 
2398
-
 
2399
-//@}
 
2400
-
 
2401
-/**@name OPTIONS
 
2402
-  */
 
2403
-//@{
 
2404
-
 
2405
-//@options
 
2406
-
 
2407
-//@}
 
2408
-
 
2409
 
 
2410
 
 
2411
 int main(int argc, char *argv[])