.\" Copyright (c) 1987 Entropic Speech, Inc.; All rights reserved.\" @(#)fea_vq.5t	1.2 7/15/87 ESI.TH FEA_VQ 5\-ESPS 2/17/87.ds ]W "\fI\s+4\ze\h'0.05'e\s-4\v'-0.4m'\fP\(*p\v'0.4m'\ Entropic Speech, Inc..SH NAMEESPS VQ Feature File Subtype \- (.vq).SH SYNOPSIS.nf.ft B#include <sps/sps.h>#include <sps/fea.h>#include <sps/vq.h>.fi.SH DESCRIPTION.PPThe FEA_VQ file is a subtype of the FEA file.  If \fIhd\fR is a pointer to the header of such a file, then \fIhd\->hd.fea\->fea_type\fR== FEA_VQ.  Such files are created by calling .I init_vqfea_hd(3\-ESPSu) after .I new_header(3\-ESPSu).  .PPThe header of a FEA_VQ file contains definitions for the record fieldsas given by the following table:.PP.TScenter, box, tab(;);c | c | c | c | c | c l | l | l | l | l | l.Name;Size;Rank;Dimen;Type;Enums=conv_ratio;1;0;NULL;double;NULLfinal_dist;1;0;NULL;double;NULLtrain_length;1;0;NULL;long;NULLdesign_size;1;0;NULL;long;NULLcurrent_size;1;0;NULL;long;NULLdimen;1;0;NULL;long;NULLnum_iter;1;0;NULL;long;NULLnum_empty;1;0;NULL;long;NULLcbk_struct;1;0;NULL;coded;\fIcbk_structs\fRdist_type;1;0;NULL;coded;\fIdist_types\fRcbk_type;1;0;NULL;coded;\fIvq_cbk_types\fRcodebook;row*cols;2;{\fIrow,cols\fR};float;NULLclustersize;rows;1;NULL;long;NULLclusterdist;rows;1;NULL;float;NULL.TE.PPIn the above table, \fIcbk_structs, dist_types,\fR and\fIvq_cbk_types\fR are arrays of of the possible values the field can take.These are defined in the FEA_VQ library support module.   \fIRow\fR and\fIcols\fR are the number of rows and columns in the codebook.See \fIFEA\fR(5\-ESPS) for additional information on the meaning of thetable columns..PPIn addition to the record field definitions, the header for a FEA_VQfile consists of the following generic header items:.PP.TScenter, box, tab(;);c | c | cl | l | l.Name;Size;Type=design_size;1;longcodeword_dimen;1;long.TE.PPIn most cases, programs that deal with FEA_VQ files will use the supportroutines provided in the ESPS library and will not have to make directuse of the information in the above tables.   The library routine.I init_vqfea_hd(3\-ESPSu) creates these fields..PPPrograms that deal with FEA_VQ files do so in terms of structures oftype (struct vqcbk) \- pointers to structures of this type are returned by .I allo_vqfea_rec(3\-ESPSu), and the FEA_VQ read and write routines (\fIget_vqfea_rec\fRand \fIput_vqfea_rec\fP) have parameters of type (struct vqcbk).  Here is the definition of the vqcbk struct (given in \fI<sps/vq.h>\fR):.bp.PP.TSl1 l1 l1 l.struct vqcbk {  double	*conv_ratio;	/\(** fractional distortion convergence threshold \(**/  double	*final_dist;	/\(** average distortion of current codebook \(**/  float	**codebook;	/\(** codeword matrix; codeword[j] points to jth codeword \(**/  float	*clusterdist;	/\(** distortion of cluster corresponding to each codeword \(**/  long	*clustersize;	/\(** size of the cluster corresponding to each codeword \(**/  long	*train_length;	/\(** length of training sequence used \(**/  long	*design_size;	/\(** design goal for number of codewords \(**/  long	*current_size;	/\(** current number of codewords in codebook \(**/  long	*dimen;	/\(** dimension of codewords \(**/  long	*num_iter;	/\(** total number of cluster iterations \(**/  long	*num_empty;	/\(** total number of times empty cell found \(**/  short	*cbk_type;	/\(** codebook type, e.g, RC_VQCBK;		see definitions above \(**/  short	*dist_type;	/\(** distortion type, e.g, MSE; see		definitions above \(**/  short	*cbk_struct;	/\(** codebook structure, e.g., FULL_SEARCH;		see definitions above \(**/  struct fea_data	*fea_rec;	/\(** pointer to corresponding FEA record \(**/};.TE.PPFor a discussion of the meaning of each of the fields in this structure, see the manual page for .I vqdesign(3\-ESPSsp).  .SH SEE ALSO.PPinit_vqfea_hd(3\-ESPSu), allo_vqfea_rec(3\-ESPSu), get_vqfea_rec(3\-ESPSu),put_vqfea_rec(3\-ESPSu), vqdesign(3\-ESPSsp), vqencode(3\-ESPSsp), f_mat_alloc(3\-ESPSu), FEA(5\-ESPS), ESPS(5\-ESPS).SH RECORD ELEMENT FILE STRUCTURE.PPIn order to use this (or any other) FEA file type with a generic ESPSprogram (one that operates on any file type) it is necessary to know theway that record elements are positioned in the file.   For a FEA filethat information is obtained by running the program\fIfea_elems\fR(1\-ESPS) on the file in question..SH FILES.PP.nf/usr/include/sps/fea.h/usr/include/sps/vq.h.SH AUTHORManual page by John Shore and Alan Parker