File: HtkFileDataSet.html

package info (click to toggle)
torch 2-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 5,488 kB
  • ctags: 3,217
  • sloc: cpp: 14,272; makefile: 201
file content (261 lines) | stat: -rw-r--r-- 11,999 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

<HTML>
<HEAD>
   <TITLE>class  HtkFileDataSet</TITLE>
   <META NAME="GENERATOR" CONTENT="DOC++ 3.4.8">
</HEAD>
<BODY BGCOLOR="#ffffff">

<H2>class  <A HREF="#DOC.DOCU">HtkFileDataSet</A></H2></H2><BLOCKQUOTE>Creates a <TT>StdDataSet</TT> from a disk file in HTK format.</BLOCKQUOTE>
<HR>

<H2>Inheritance:</H2>
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=155>
<param name=classes value="CObject,MObject.html,CDataSet,MDataSet.html,CEuclideanDataSet,MEuclideanDataSet.html,CStdDataSet,MStdDataSet.html,CHtkFileDataSet,MHtkFileDataSet.html">
<param name=before value="M,M,M,M,M">
<param name=after value="Md_SPSPSP,Md_SPSP,Md_SP,Md_,M">
<param name=indent value="0,1,2,3,4">
<param name=arrowdir value="down">
</APPLET>
<HR>

<DL>
<P><DL>
<DT><H3>Public Fields</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>int <B><A HREF="#DOC.119.1">n_files</A></B>
<DD><I>the number of files to load</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="IOHtk.html">IOHtk</A>** <B><A HREF="#DOC.119.2">htk</A></B>
<DD><I>for each file, an object IOHtk is created</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>int <B><A HREF="#DOC.119.3">window_size</A></B>
<DD><I>the size of the input window</I>
</DL></P>

<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.119.4">HtkFileDataSet</A></B>(char* <!1><A HREF="Measurer.html#DOC.30.2">file</A>, int window_size_ = 1, int max_load=-1)
<DD><I>Load <TT>file</TT> in memory.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   void <B><A HREF="#DOC.119.5">write</A></B>(char* dir_to_save=NULL)
<DD><I>save the data set on htk binary format in specifing directory</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   void <B><A HREF="#DOC.119.6">prepareData</A></B>(bool* input_to_del=NULL)
<DD><I>Set pointers on datas stored on <TT>IOHtk</TT> object and remove unused columns </I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   void <B><A HREF="#DOC.119.7">normalizeUsingDataSet</A></B>(<!1><A HREF="StdDataSet.html">StdDataSet</A>* data_norm)
<DD><I>Normalize the <TT>DataSet</TT> using the normalization values of another <TT>DataSet</TT>.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   void <B><A HREF="#DOC.119.8">normalize</A></B>()
<DD><I>Normalize the database</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   int <B><A HREF="#DOC.119.9">removeUnlikelyFrames</A></B>(<!1><A HREF="Distribution.html">Distribution</A>* likely_distr, <!1><A HREF="Distribution.html">Distribution</A>* unlikely_distr, bool* mask = NULL)
<DD><I>Remove the frames considering as unlinkely and return the number of removed frames and if mask is not NULL remove unused data</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   void <B><A HREF="#DOC.119.10">createMaskFromParam</A></B>(bool* mask)
<DD><I>Create a mask to remove log energy parameters</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   void <B><A HREF="#DOC.119.11">loadFILE</A></B>(FILE* <!1><A HREF="Measurer.html#DOC.30.2">file</A>)
<DD><I>Load the normalization parameters</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   void <B><A HREF="#DOC.119.12">saveFILE</A></B>(FILE* <!1><A HREF="Measurer.html#DOC.30.2">file</A>)
<DD><I>Save the normalization parameters</I>
</DL></P>

</DL>
<HR><H3>Inherited from <A HREF="StdDataSet.html">StdDataSet</A>:</H3>
<DL>
<P><DL>
<DT><H3>Public Fields</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>real** <B>all_inputs</B>
<DT>
<IMG ALT="o" SRC=icon2.gif>real** <B>all_targets</B>
</DL></P>

<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>void <B>setInputs</B>(real** data_, int n_dim, int n_examples_)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>setTargets</B>(real** y_, int n_targets_)
</DL></P>

</DL>
<HR><H3>Inherited from <A HREF="EuclideanDataSet.html">EuclideanDataSet</A>:</H3>
<DL>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>real <B>dotProduct</B>(int i, <!1><A HREF="List.html">List</A>* <!1><A HREF="QCMachine.html#DOC.40.7">y</A>)
<DT>
<IMG ALT="o" SRC=icon2.gif>real <B>realDotProduct</B>(int i, int j)
<DT>
<IMG ALT="o" SRC=icon2.gif>virtual   real <B>realRealDotProduct</B>(int i, int j)
<DT>
<IMG ALT="o" SRC=icon2.gif>virtual   real <B>realDotProduct</B>(int i, <!1><A HREF="List.html">List</A>* <!1><A HREF="QCMachine.html#DOC.40.7">y</A>)
<DT>
<IMG ALT="o" SRC=icon2.gif>virtual   real <B>dotProduct</B>(<!1><A HREF="List.html">List</A>* x, <!1><A HREF="List.html">List</A>* <!1><A HREF="QCMachine.html#DOC.40.7">y</A>)
</DL></P>

<P><DL>
<DT><H3>Public Members</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif> <B>Dot product functions</B>
<DT>
<IMG ALT="o" SRC=icon2.gif> <B>Dot products between two examples.</B>
</DL></P>

</DL>
<HR><H3>Inherited from <A HREF="DataSet.html">DataSet</A>:</H3>
<DL>
<P><DL>
<DT><H3>Public Fields</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>int* <B>selected_examples</B>
<DT>
<IMG ALT="o" SRC=icon2.gif>int <B>current_example</B>
<DT>
<IMG ALT="o" SRC=icon2.gif>int <B>n_targets</B>
<DT>
<IMG ALT="o" SRC=icon2.gif>void* <B>targets</B>
<DT>
<IMG ALT="o" SRC=icon2.gif>int <B>n_inputs</B>
<DT>
<IMG ALT="o" SRC=icon2.gif><!1><A HREF="List.html">List</A>* <B>inputs</B>
<DT>
<IMG ALT="o" SRC=icon2.gif>int <B>n_examples</B>
<DT>
<IMG ALT="o" SRC=icon2.gif>int <B>n_real_examples</B>
</DL></P>

<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>void <B>setExample</B>(int t)
<DT>
<IMG ALT="o" SRC=icon2.gif>virtual   void <B>setRealExample</B>(int t)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>pushSubset</B>(int* subset_, int n_examples_)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>popSubset</B>()
</DL></P>

</DL>
<HR><H3>Inherited from <A HREF="Object.html">Object</A>:</H3>
<DL>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>virtual   void <B>init</B>()
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>addOption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, int size, void* <!1><A HREF="Vec.html#DOC.81.3">ptr</A>, const char* <!1><A HREF="CmdLine.html#DOC.7.3">help</A>="", bool is_allowed_after_init=false)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>addIOption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, int* <!1><A HREF="Vec.html#DOC.81.3">ptr</A>, int init_value, const char* <!1><A HREF="CmdLine.html#DOC.7.3">help</A>="", bool is_allowed_after_init=false)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>addROption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, real* <!1><A HREF="Vec.html#DOC.81.3">ptr</A>, real init_value, const char* <!1><A HREF="CmdLine.html#DOC.7.3">help</A>="", bool is_allowed_after_init=false)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>addBOption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, bool* <!1><A HREF="Vec.html#DOC.81.3">ptr</A>, bool init_value, const char* <!1><A HREF="CmdLine.html#DOC.7.3">help</A>="", bool is_allowed_after_init=false)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>setOption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, void* <!1><A HREF="Vec.html#DOC.81.3">ptr</A>)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>setIOption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, int option)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>setROption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, real option)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>setBOption</B>(const char* <!1><A HREF="SeqExample.html#DOC.107.9">name</A>, bool option)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>load</B>(const char* filename)
<DT>
<IMG ALT="o" SRC=icon2.gif>void <B>save</B>(const char* filename)
</DL></P>

</DL>

<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE>Creates a <TT>StdDataSet</TT> from a disk file in HTK format.
As there are no targets in HTK datasets, we decided that they
point to the input vector (hence, can be used for Diabolo type of
problems for instance). Moreover, a window_size can be given such
that the real input vector <IMG BORDER=0 SRC=g000060.gif> in the concatenation of the
vectors from <IMG BORDER=0 SRC=g000061.gif> to <IMG BORDER=0 SRC=g000062.gif>, where <TT>window_size</TT> is equal
to <IMG BORDER=0 SRC=g000063.gif>.

<P>Finally, it can also be used to load multiple files at once.

<P></BLOCKQUOTE>
<DL>

<A NAME="n_files"></A>
<A NAME="DOC.119.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>int n_files</B></TT>
<DD>the number of files to load
<DL><DT><DD></DL><P>
<A NAME="htk"></A>
<A NAME="DOC.119.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="IOHtk.html">IOHtk</A>** htk</B></TT>
<DD>for each file, an object IOHtk is created
<DL><DT><DD></DL><P>
<A NAME="window_size"></A>
<A NAME="DOC.119.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>int window_size</B></TT>
<DD>the size of the input window
<DL><DT><DD></DL><P>
<A NAME="HtkFileDataSet"></A>
<A NAME="DOC.119.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> HtkFileDataSet(char* <!1><A HREF="Measurer.html#DOC.30.2">file</A>, int window_size_ = 1, int max_load=-1)</B></TT>
<DD>Load <TT>file</TT> in memory.
<UL>
<LI> <TT>window_size</TT> gives the number of frames per input.
<LI> if <TT>max_load</TT> &gt; 0, it loads only the first <TT>max_load</TT> examples.
</UL>
<DL><DT><DD></DL><P>
<A NAME="write"></A>
<A NAME="DOC.119.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   void write(char* dir_to_save=NULL)</B></TT>
<DD>save the data set on htk binary format in specifing directory
<DL><DT><DD></DL><P>
<A NAME="prepareData"></A>
<A NAME="DOC.119.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   void prepareData(bool* input_to_del=NULL)</B></TT>
<DD>Set pointers on datas stored on <TT>IOHtk</TT> object and remove unused
columns 
<DL><DT><DD></DL><P>
<A NAME="normalizeUsingDataSet"></A>
<A NAME="DOC.119.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   void normalizeUsingDataSet(<!1><A HREF="StdDataSet.html">StdDataSet</A>* data_norm)</B></TT>
<DD>Normalize the <TT>DataSet</TT> using the normalization values
of another <TT>DataSet</TT>. If the other <TT>DataSet</TT> isn't 
normalized, nothing happens...
<DL><DT><DD></DL><P>
<A NAME="normalize"></A>
<A NAME="DOC.119.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   void normalize()</B></TT>
<DD>Normalize the database
<DL><DT><DD></DL><P>
<A NAME="removeUnlikelyFrames"></A>
<A NAME="DOC.119.9"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   int removeUnlikelyFrames(<!1><A HREF="Distribution.html">Distribution</A>* likely_distr, <!1><A HREF="Distribution.html">Distribution</A>* unlikely_distr, bool* mask = NULL)</B></TT>
<DD>Remove the frames considering as unlinkely and return the number of
removed frames and if mask is not NULL remove unused data
<DL><DT><DD></DL><P>
<A NAME="createMaskFromParam"></A>
<A NAME="DOC.119.10"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   void createMaskFromParam(bool* mask)</B></TT>
<DD>Create a mask to remove log energy parameters
<DL><DT><DD></DL><P>
<A NAME="loadFILE"></A>
<A NAME="DOC.119.11"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   void loadFILE(FILE* <!1><A HREF="Measurer.html#DOC.30.2">file</A>)</B></TT>
<DD>Load the normalization parameters
<DL><DT><DD></DL><P>
<A NAME="saveFILE"></A>
<A NAME="DOC.119.12"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   void saveFILE(FILE* <!1><A HREF="Measurer.html#DOC.30.2">file</A>)</B></TT>
<DD>Save the normalization parameters
<DL><DT><DD></DL><P></DL>

<HR><DL><DT><B>This class has no child classes.</B></DL>

<DL><DT><DT><B>Author:</B><DD>Samy Bengio (bengio@idiap.ch)
<DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I> <I><A HREF="HIER.html">HTML hierarchy of classes</A> or <A HREF="HIERjava.html">Java</A></I></P><HR>
<BR>
This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
</BODY>
</HTML>