Descripción de clases

Transcripción

1 Apéndice A Descripción de clases Este apéndice se incluye la documentación de las clases del proyecto generada automáticamente con Doxygen v1.3.8 a partir del código fuente. Doxygen es un sistema de documentación para C++, C, Java, Objective-C, IDL (para Corba y Microsoft) y para algunas extensiones de PHP, C# y D. Doxygen puede generar documentación online (en HTML) y manuales de referencia (en L A TEX) desde un conjunto de archivos de código fuente documentados. También puede generar la salida en RTF (MS-Word), PostScript, PDF con hipervínculos, HTML comprimido, y páginas man para Unix. La documentación se extrae directamente de los archivos de código fuente, lo que hace mucho más fácil mantener una documentación consistente con el código fuente. Se puede configurar Doxigen para extraer la estructura del código de archivos fuente no documentados. Esto es muy útil para encontrar rápidamente lo que se necesita en distribuciones con mucho código. También se pueden ver las relaciones existentes entre los distintos elementos de un proyecto mediante la inclusión de gráficos de dependencia, diagramas de herencia y diagramas de colaboración generados de forma automática. Doxygen se desarrolla bajo Linux, pero de forma que sea portable a otros muchos sistemas operativos. Se ejecuta en muchos sistemas basados en Unix y se dispone de ejecutables para Windows y Mac OS X. 131

2 132 A.1. APÉNDICE A. DESCRIPCIÓN DE CLASES Referencia de la Clase CSoundCapture #include <SoundCapture.h> Métodos públicos void Record () Comienza la captura de audio. void CaptureBlock () void Stop () Detiene la captura de audio. int GetLength () real GetCaptured () Métodos públicos estáticos CSoundCapture GetSoundCapture () Devuelve la instancia única de la clase. void ReleaseSoundCapture () Destruye la instancia única de la clase. Atributos públicos DWORD m CapturePosition Uso provisional. DWORD m ReadPosition Uso provisional.

3 A.1. REFERENCIA DE LA CLASE CSOUNDCAPTURE 133 Métodos privados CSoundCapture () CSoundCapture () HRESULT Initialize () Inicialización del sistema de grabación. void StoreCapturedData () Atributos privados IDirectSoundCapture8 m pdsc Dispositio de captura de audio de Direct Sound. IDirectSoundCaptureBuffer8 m pdscbuffer Buffer del dispositivo de captura de audio. int m inotificaciones Número de notificaciones para el buffer de captura. HANDLE m phnotificationevent Handle de notificación para el buffer. DSBPOSITIONNOTIFY m pdsbposnotify WAVEFORMATEX m wfx Estructura de descripción de la onda de audio. DSCBUFFERDESC m dscbd Estructura de descripción del buffer de captura. DWORD m dwnextoffset Variable para controlar el punto de lectura sobre el buffer. BYTE m pbstoreddata unsigned int m uistoreddatalength

4 134 APÉNDICE A. DESCRIPCIÓN DE CLASES Atributos privados estáticos CSoundCapture m pinstance = NULL Instancia única de la clase. A.1.1. Documentación del constructor y destructor A CSoundCapture::CSoundCapture () [private] Constructor. El constructor es privado porque la clase sigue el patrón singleton. La instancia se crea la primera vez que se llama al método GetSoundCapture()(p. 135) y se devuelve la misma instancia en cada llamada posterior al mismo método. A CSoundCapture:: CSoundCapture () [private] Destructor. El destructor es privado para seguir el patrón singleton. La instancia se destruye con el método ReleaseSoundCapture()(p. 135). A.1.2. Documentación de las funciones miembro A void CSoundCapture::CaptureBlock () Captura un bloque de 1000 muestras a través del dispositivo configurado. A real CSoundCapture::GetCaptured () Obtener el bloque capturado. El puntero al array de la señal. A int CSoundCapture::GetLength () Longitud del bloque almacenado.

5 A.1. REFERENCIA DE LA CLASE CSOUNDCAPTURE 135 La longitud del bloque capturado en bytes. A CSoundCapture CSoundCapture::GetSoundCapture () [static] Devuelve la instancia única de la clase. Si es la primera vez que se llama al método crea la instancia y la devuelve. A HRESULT CSoundCapture::Initialize () [private] Inicialización del sistema de grabación. Ver la documentción de DirectX para referencias a HRESULT. A void CSoundCapture::Record () Comienza la captura de audio. A void CSoundCapture::ReleaseSoundCapture () [static] Destruye la instancia única de la clase. A void CSoundCapture::Stop () Detiene la captura de audio. A void CSoundCapture::StoreCapturedData () [private] Almacena los datos obtenidos del buffer de lectura en el array de análisis A.1.3. A Documentación de los datos miembro DWORD CSoundCapture::m CapturePosition Uso provisional.

6 136 APÉNDICE A. DESCRIPCIÓN DE CLASES A DSCBUFFERDESC CSoundCapture::m dscbd [private] Estructura de descripción del buffer de captura. A DWORD CSoundCapture::m dwnextoffset [private] Variable para controlar el punto de lectura sobre el buffer. A int CSoundCapture::m inotificaciones [private] Número de notificaciones para el buffer de captura. A BYTE CSoundCapture::m pbstoreddata [private] Bloque de memoria donde se almacenan los datos capturados hasta el momento. A DSBPOSITIONNOTIFY CSoundCapture::m pdsbposnotify [private] Datos de las notificaciones de posición del buffer de lectura. A IDirectSoundCapture8 CSoundCapture::m pdsc [private] Dispositio de captura de audio de Direct Sound. A IDirectSoundCaptureBuffer8 CSoundCapture::m pdscbuffer [private] Buffer del dispositivo de captura de audio. A HANDLE CSoundCapture::m phnotificationevent [private] Handle de notificación para el buffer.

7 A.1. REFERENCIA DE LA CLASE CSOUNDCAPTURE 137 A CSoundCapture CSoundCapture::m pinstance = NULL [static, private] Instancia única de la clase. La clase sigue el patrón singleton. Esto quiere decir que durante la ejecución de la apliacación sólo existirá una instancia de esta clase, CSoundCapture::m pinstance(p. 137). A DWORD CSoundCapture::m ReadPosition Uso provisional. A unsigned int CSoundCapture::m uistoreddatalength [private] Longitud (en bytes) del bloque almacenado en m pbstoreddata. A WAVEFORMATEX CSoundCapture::m wfx [private] Estructura de descripción de la onda de audio. La documentación para esta clase fué generada a partir de los siguientes archivos: /PFC/Solution/Application/SoundCapture.h /PFC/Solution/Application/SoundCapture.cpp

8 138 A.2. APÉNDICE A. DESCRIPCIÓN DE CLASES Referencia de la Clase CSoundCaptureLink #include <SoundCaptureLink.h> Métodos públicos void Record () Comienza la captura de audio. void CaptureBlock () void Stop () Detiene la captura de audio. int GetLength () real GetCaptured () Métodos públicos estáticos CSoundCaptureLink GetSoundCaptureLink () Devuelve la instancia única de la clase. void ReleaseSoundCaptureLink () Destruye la instancia única de la clase. Métodos privados CSoundCaptureLink () CSoundCaptureLink () Atributos privados estáticos CSoundCapture m psoundcapture = NULL Instancia de la clase CSoundCapture(p. 132) a la que enlaza. CSoundCaptureLink m pinstance = NULL

9 A.2. REFERENCIA DE LA CLASE CSOUNDCAPTURELINK 139 Instancia única de esta clase. A.2.1. Documentación del constructor y destructor A CSoundCaptureLink::CSoundCaptureLink () [private] A CSoundCaptureLink:: CSoundCaptureLink () [private] A.2.2. Documentación de las funciones miembro A void CSoundCaptureLink::CaptureBlock () Captura un bloque de 1000 muestras a través del dispositivo configurado. A real CSoundCaptureLink::GetCaptured () Obtener el bloque capturado. El puntero al array de la señal. A int CSoundCaptureLink::GetLength () Longitud del bloque almacenado. La longitud del bloque capturado en bytes. A CSoundCaptureLink CSoundCaptureLink::GetSoundCaptureLink () [static] Devuelve la instancia única de la clase. Si es la primera vez que se llama al método crea la instancia y la devuelve. A void CSoundCaptureLink::Record () Comienza la captura de audio.

10 140 APÉNDICE A. DESCRIPCIÓN DE CLASES A void CSoundCaptureLink::ReleaseSoundCaptureLink () [static] Destruye la instancia única de la clase. A void CSoundCaptureLink::Stop () Detiene la captura de audio. A.2.3. A Documentación de los datos miembro CSoundCaptureLink CSoundCaptureLink::m pinstance = NULL [static, private] Instancia única de esta clase. A CSoundCapture CSoundCaptureLink::m psoundcapture = NULL [static, private] Instancia de la clase CSoundCapture(p. 132) a la que enlaza. La documentación para esta clase fué generada a partir de los siguientes archivos: /PFC/Solution/Application/SoundCaptureLink.h /PFC/Solution/Application/SoundCaptureLink.cpp

11 A.3. REFERENCIA DE LA CLASE CSIGNAL 141 A.3. Referencia de la Clase CSignal #include <Signal.H> Métodos públicos void SetAnalisis (real sig, int numm, int frec) Definición de los datos del análisis. void Analiza () Realiza el análisis de la señal. int GetNumFrames () Número de frames de la señal. real GetCaract (int f) void SetNumCeps (int nc) Determinar el número de coeficientes cepstrales que se quiere obtener. real GetSign () Señal en análisis. int GetNumMuestras () Número de muestras de la señal en análisis. void SetLongVentMin () Determina la longitud de la ventana como la mínima. Métodos públicos estáticos CSignal GetExtractor () Obtención de la instancia de la clase.

12 142 APÉNDICE A. DESCRIPCIÓN DE CLASES Métodos privados void SetLongVent () Determinar ancho de la ventana. void Fourier (int t) Transformada de Fourier. void Mfcc (int t) Cálculo de los coeficientes cepstrales. void Derivadas () Calcula las derivadas de los coeficientes y la energía. void Normaliza () Realiza la normalización de la señal de audio. void Banda () Escala la señal a todo el ancho de banda. real W Hamming (int n) Ventana de Hamming. real W Hanning (int n) Ventana de Hanning. real W Rectangular (int n) Ventana Rectangular. CSignal () Constructor. CSignal () Destructor.

13 A.3. REFERENCIA DE LA CLASE CSIGNAL 143 Atributos privados real m prsignal Señal acustica a analizar. int m inummuestras Numero de muestras en la señal. int m ifrecuencia Frecuencia de muestreo de la señal. int m ilongvent Longitud de la ventana de análisis. int m iorden Logaritmo en base 2 de la longitud de la ventana. int m isupvent Longitud de superposición de las ventanas. real m pprtransformada Array para la transformada en cada frame. int m inumframes real m prenergia Array para almacenar los valores de la energía de la señal. real m pprcepstrales Arrays para almacenar los coeficientes cepstrales obtenidos. int m inumceps Número de coeficientes cepstrales que se desean obtener. real m prcarac

14 144 APÉNDICE A. DESCRIPCIÓN DE CLASES Atributos privados estáticos CSignal m pinstance = NULL Puntero a la única instancia de la clase. A.3.1. Documentación del constructor y destructor A CSignal::CSignal () [private] Constructor. El constructor de instancias de la clase es privado porque esta sigue el patrón singleton. A CSignal:: CSignal () [private] Destructor. El destructor de instancias de la clase es privado porque esta sigue el patrón singleton. A.3.2. Documentación de las funciones miembro A void CSignal::Analiza () Realiza el análisis de la señal. Tras determinar los datos del análisis se llama a este método pa ordenar la realización del análisis. A void CSignal::Banda () [private] Escala la señal a todo el ancho de banda. A void CSignal::Derivadas () [private] Calcula las derivadas de los coeficientes y la energía. Para calcular las derivadas y la energía se debe haber llamado antes a los métodos Fourier()(p. 145) y Mfcc()(p. 146).

15 A.3. REFERENCIA DE LA CLASE CSIGNAL 145 A void CSignal::Fourier (int t) [private] Transformada de Fourier. Calcula la transformada de Fourier del frame t. t Intervalo en el que se tiene que calcular la transformada de Fourier. A real CSignal::GetCaract (int f) Obtención del vector de caracteríasticas. f Índice del frame para el que se quiere el vector de características. Puntero al primer elemento del vector de coeficientes. El número de elementos que se devuelve es igual al número de coeficientes cepstrales calculados mas el valor de la energía y sus dos primeras derivadas. A CSignal CSignal::GetExtractor () [static] Obtención de la instancia de la clase. La clase sigue el patrón singleton y mediante este método se obtiene la única instancia de ella. Devuelve el puntero a la instancia única de la clase. A int CSignal::GetNumFrames () [inline] Número de frames de la señal. Devuelve el número de frames en que se ha dividido la señal ara su análisis. A int CSignal::GetNumMuestras () [inline] Número de muestras de la señal en análisis.

16 146 APÉNDICE A. DESCRIPCIÓN DE CLASES Número de muestras de la señal. A real CSignal::GetSign () [inline] Señal en análisis. Puntero a la primera posición de los datos de la señal introducida. A void CSignal::Mfcc (int t) [private] Cálculo de los coeficientes cepstrales. Calcula los coeficientes cepstrales del frame t. t Intervalo en el que se tiene que calcular los coeficientes cepstrales. Es requisito haber llamado antes al método Fourier()(p. 145). A void CSignal::Normaliza () [private] Realiza la normalización de la señal de audio. A void CSignal::SetAnalisis (real sig, int numm, int frec) Definición de los datos del análisis. Como la clase sigue el patrón singleton, en cada uso de ella hay que difinir los datos y parámetros con que se trabaja. sig Array de la señal que se quire analizar. numm Número de muestras en sig. frec Frecuancia de muestreo d la señal introducida. Ver también: SetNumCeps()(p. 147)

17 A.3. REFERENCIA DE LA CLASE CSIGNAL 147 A void CSignal::SetLongVent () [private] Determinar ancho de la ventana. Determina la longitud de ventana que se debe coger para la frecuencia utilizada. A void CSignal::SetLongVentMin () Determina la longitud de la ventana como la mínima. A void CSignal::SetNumCeps (int nc) [inline] Determinar el número de coeficientes cepstrales que se quiere obtener. nc Número de coeficientes cepstrales que se deben calcular por cada frame. Ver también: SetAnalisis()(p. 146) A real CSignal::W Hamming (int n) [private] Ventana de Hamming. n Indice del valor de la ventana de Hamming que se quiere obtener. Devuelve el término enésimo de una ventana de Hamming de ancho igual al de los frames. A real CSignal::W Hanning (int n) [private] Ventana de Hanning. n Indice del valor de la ventana de Hanning que se quiere obtener. Devuelve el término enésimo de una ventana de Hanning de ancho igual al de los frames.

18 148 APÉNDICE A. DESCRIPCIÓN DE CLASES A real CSignal::W Rectangular (int n) [private] Ventana Rectangular. n Indice del valor de la ventana rectangular que se quiere obtener. Devuelve el término enésimo de una ventana rectangular de ancho igual al de los frames. A.3.3. Documentación de los datos miembro A int CSignal::m ifrecuencia [private] Frecuencia de muestreo de la señal. A int CSignal::m ilongvent [private] Longitud de la ventana de análisis. A int CSignal::m inumceps [private] Número de coeficientes cepstrales que se desean obtener. A int CSignal::m inumframes [private] Número de intervalos sobre los que se analiza la transformada de Fourier. A int CSignal::m inummuestras [private] Numero de muestras en la señal. A int CSignal::m iorden [private] Logaritmo en base 2 de la longitud de la ventana.

19 A.3. REFERENCIA DE LA CLASE CSIGNAL 149 A int CSignal::m isupvent [private] Longitud de superposición de las ventanas. A CSignal CSignal::m pinstance = NULL [static, private] Puntero a la única instancia de la clase. La clase sigue el patrón singleton. A real CSignal::m pprcepstrales [private] Arrays para almacenar los coeficientes cepstrales obtenidos. A real CSignal::m pprtransformada [private] Array para la transformada en cada frame. A real CSignal::m prcarac [private] Vectores de características que incluyen los coeficientes cepstrales y la energía con sus derivadas. A real CSignal::m prenergia [private] Array para almacenar los valores de la energía de la señal. A real CSignal::m prsignal [private] Señal acustica a analizar. La documentación para esta clase fué generada a partir de los siguientes archivos: /PFC/Solution/Application/Signal.H /PFC/Solution/Application/Signal.CPP

20 150 A.4. Referencia de la Clase HMM APÉNDICE A. DESCRIPCIÓN DE CLASES Clase que representa un Modelo Oculto de Markov. #include <HMM.h> Métodos públicos HMM (int n, int m, int tipo=0) Constructor. HMM () Constructor vacio. HMM () Destructor. real Probabilidad (vector< int > &sec) Probabilidad de una secuencia. void EntrenarGrupo (vector< vector< int > > &secuencias) Entrenamieno del modelo. void EntrenarSecuencia (vector< int > &sec) Entrenamiento del modelo. void Save (string &filename) Guarda el modelo en el archivo especificado. void Save (fstream &file) Guarda el modelo en el archivo especificado. void Load (string &filename) Carga el modelo desde el archivo especificado. void Load (fstream &file)

21 A.4. REFERENCIA DE LA CLASE HMM 151 Carga el modelo desde el archivo especificado. Métodos privados void CalcAlfa () Algoritmo de avance. void CalcBeta () Algoritmo de retroceso. void CalcGamma (real gamma, int max T, real xi=null) Cálculo de γ t (i). void CalcXi (real xi, int max T) Cálculo de ξ t (i, j). vector< int > Viterbi () Algoritmo de Viterbi. void Paso Baum Welch () Método de reestimación de Baum-Welch. void Inicializar () Inicializa las matrices carácterísticas del modelo. real Probabilidad () Devuelve la probabilidad de ocurrencia de la secuencia de observación. void Observacion (vector< int > &sec) Determina la secuencia de observación para estudiar con el modelo. Atributos privados int m ntipo

22 152 APÉNDICE A. DESCRIPCIÓN DE CLASES Tipo de modelo oculto de Markov. int m nnumestados Número de estados del modelo. int m nnumelementos Tamaño del conjunto de observación. real m prpi Probabilidad de comienzo de la secuencia para cada estado. real m pra Matriz de probabilidad de transición entre estados. real m prb Probabilidad de emisión de símbolos. vector< int > m Sec Secuencia de observación en estudio. real m pralfa Probabilidad de la secuencia de observación parcial. real m prbeta Variable de retroceso. A.4.1. Descripción detallada Clase que representa un Modelo Oculto de Markov. A.4.2. Documentación del constructor y destructor A HMM::HMM (int n, int m, int tipo = 0) Constructor.

23 A.4. REFERENCIA DE LA CLASE HMM 153 n Número de estados del modelo. m Número de elementos del espacio observables. tipo Tipo del modelo. Por defecto 0. A HMM::HMM () Constructor vacio. Igual a HMM( 3, 16, 0 ). A HMM:: HMM () Destructor. A.4.3. Documentación de las funciones miembro A void HMM::CalcAlfa () [private] Algoritmo de avance. Calcula α t (i) mediante el algoritmo de avance. Reserva el espacio necesario y almacena el puntero en m pralfa. A void HMM::CalcBeta () [private] Algoritmo de retroceso. Calcula β t (i) mediante el algoritmo de retroceso. Reserva el espacio necesario y almacena el puntero en m prbeta. A void HMM::CalcGamma (real gamma, int max T, real xi = NULL) [private] Cálculo de γ t (i). Devuelve los valores de gamma en una fila para cada estado i y para cada instante t por columnas. Si xi toma valor NULL llama a CalcXi()(p. 154).

24 154 APÉNDICE A. DESCRIPCIÓN DE CLASES gamma Posición de memoria donde escribir los valores de γ t (i). El espacio debe estar reservado antes de la llamada a la función y debe ser de tamaño m nnumestados max T. max T Número de elementos de la más larga de las secuencias de observación. xi Resultado del cálculo de ξ t (i, j). Si es NULL (valor por defecto) llama al método CalcXi()(p. 154). A void HMM::CalcXi (real xi, int max T) [private] Cálculo de ξ t (i, j). Devuelve los valores de xi en una matriz para cada elemeto j, una fila para cada estado i y con cada instante t por columnas; de modo que ξ t (i, j) = xi[(i m nnumestados + j) max T + t] Si no se han calculado ya los valores α t (i) y β t (i), llama a los métodos CalcAlfa()(p. 153) y CalcBeta()(p. 153). xi Posición de memoria donde escribir los valores de ξ t (i, j). El espacio debe estar reservado antes de la llamada a la función y debe ser de tamaño m nnumestados m nnumelementos max T. max T Número de elementos de la más larga de las secuencias de observación. A void HMM::EntrenarGrupo (vector< vector< int > > & secuencias) Entrenamieno del modelo. Entrena el modelo a partir de un conjunto de secuencias de observación secuencias Vector de vectores de enteros conteniendo las secuencias de observación. Ver también: EntrenarSecuencia()(p. 154) A void HMM::EntrenarSecuencia (vector< int > & sec) Entrenamiento del modelo.

25 A.4. REFERENCIA DE LA CLASE HMM 155 Entrena el modelo a partir de una única secuencia de observación Este método es sólo útil para pruebas y experientos porque no realiza un entrenamiento adecuado de un modelo. sec Vector de enteros que contiene la secuencia de observación. Ver también: EntrenarSecuencia()(p. 154) A void HMM::Inicializar () [private] Inicializa las matrices carácterísticas del modelo. Con la implementación de los distintos tipos de modelos ocultos de Markov variará la inicialización de las matrices características. A void HMM::Load (fstream & file) Carga el modelo desde el archivo especificado. file Origen de datos del archivo del que se quiere cargar el modelo. A void HMM::Load (string & filename) Carga el modelo desde el archivo especificado. filename Nombre del archivo con la ruta completa. A void HMM::Observacion (vector< int > & sec) [private] Determina la secuencia de observación para estudiar con el modelo. A void HMM::Paso Baum Welch () [private] Método de reestimación de Baum-Welch. Esta función realiza un paso del método de reestimación de Baum-Welch.

26 156 APÉNDICE A. DESCRIPCIÓN DE CLASES A real HMM::Probabilidad (vector< int > & sec) Probabilidad de una secuencia. Devuelve la probabilidad de ocurrencia de la secuencia de observación dada. sec Vector de enteros que contiene la secuencia de observación. La probabilidad de dicha secuencia. A real HMM::Probabilidad () [private] Devuelve la probabilidad de ocurrencia de la secuencia de observación. La probabilidad de ocurrecia de la secuencia en /a m Sec. A void HMM::Save (fstream & file) Guarda el modelo en el archivo especificado. file Stream del archivo donde se quiere guardar el modelo. A void HMM::Save (string & filename) Guarda el modelo en el archivo especificado. filename Nombre del archivo con la ruta completa. A vector< int > HMM::Viterbi () [private] Algoritmo de Viterbi. Devuelve en un vector de enteros la secuencia de estados óptima para la observación dada.

27 A.4. REFERENCIA DE LA CLASE HMM 157 A.4.4. Documentación de los datos miembro A int HMM::m nnumelementos [private] Tamaño del conjunto de observación. Número de elementos del conjunto de símbolos observables. A int HMM::m nnumestados [private] Número de estados del modelo. Serán 3 por defecto. A int HMM::m ntipo [private] Tipo de modelo oculto de Markov. La diferenciación entre distintos modelos no está implementada. A real HMM::m pra [private] Matriz de probabilidad de transición entre estados. a ij = Probabilidad de pasar al estado i desde el estado j. Según el tipo de modelo algunas transiciones estarán prohibidas por defecto. Por ejemplo en el caso de cadenas sin retroceso de estados o sin saltos. A real HMM::m pralfa [private] Probabilidad de la secuencia de observación parcial. α t (i). Probabilidad de la secuencia de observación en estudio supuesta hasta el instante t y de que en dicho instante el estado sea i. A real HMM::m prb [private] Probabilidad de emisión de símbolos. b j (k) = Probabilidad de que se emita el símbolo v k estando en el estado j.

28 158 APÉNDICE A. DESCRIPCIÓN DE CLASES A real HMM::m prbeta [private] Variable de retroceso. β t (i). Probabilidad de la secuencia de observación desde t+1 a T dado el estado i en el instante t. A real HMM::m prpi [private] Probabilidad de comienzo de la secuencia para cada estado. Por defecto será nulo para todos los estados excepto para el primero. Sólo se estimarán nuevo valores si se especifica en el tipo de cadena. La longitud del vector será igual al número de elementos del sistema. A vector<int> HMM::m Sec [private] Secuencia de observación en estudio. La documentación para esta clase fué generada a partir de los siguientes archivos: /PFC/Solution/Application/HMM.h /PFC/Solution/Application/HMM.cpp

29 A.5. REFERENCIA DE LA CLASE CPHONREC 159 A.5. Referencia de la Clase CPhonRec Fonema. #include <PhonRec.h> Métodos públicos CPhonRec (string &sphon, string &slabel) Constructor. CPhonRec (string &filename) Constructor. CPhonRec (fstream &file) Constructor. CPhonRec () Destructor. string GetPhonName () Obtener el nombre del fonema. string GetPhonLabel () Obtener la etiqueta del fonema. void AddUtterance (vector< int > &vutterance) Añadir pronunciación. real LogEvaluateUtterance (vector< int > &vutterance) Evaluar pronunciación. real EvaluateUtterance (vector< int > &vutterance) Evaluar pronunciación. void TrainUtterances ()

30 160 APÉNDICE A. DESCRIPCIÓN DE CLASES Entrenamiento del modelo de markov del elemento. void SetAverage (real raverage) void Save (string &filename) Guarda el término en el archivo especificado. void Save (fstream &file) Guarda elemento y sus datos en el archivo especificado. void Load (string &filename) Carga el fonema desde el archivo especificado. void Load (fstream &file) Carga el fonema y sus datos desde el archivo especificado. Atributos privados HMM m HMM Modelo Oculto de Markov asociado a la pronunciación. string m sphon Nombre del fonema. string m slabel Etiqueta para el elemento. real m rprobaverage vector< vector< int > > m vviutterances A.5.1. Descripción detallada Fonema. Esta clase representa un fonema de un idioma concreto en el sistema de reconocimiento de voz. El fonema se caracteriza por las secuencias correspondientes al análisis de la señal de

31 A.5. REFERENCIA DE LA CLASE CPHONREC 161 audio de las distintas pronunciaciones introducidas. Tras el entrenamiento correspondiente estas características se plasman en el Modelo Oculto de Markov (HMM(p. 150)) asociado. A.5.2. A Documentación del constructor y destructor CPhonRec::CPhonRec (string & sphon, string & slabel) Constructor. sphon Nombre del fonema. slabel Etiqueta del fonema. A CPhonRec::CPhonRec (string & filename) Constructor. filename Nombre del archivo. A CPhonRec::CPhonRec (fstream & file) Constructor. file Origen de datos del archivo desde el que se quiere cargar el elemento. A CPhonRec:: CPhonRec () Destructor. A.5.3. A Documentación de las funciones miembro void CPhonRec::AddUtterance (vector< int > & vutterance) Añade una secuencia de observación referente a una pronunciación del fonema en estudio. Añadir pronunciación.

32 162 APÉNDICE A. DESCRIPCIÓN DE CLASES vutterance Secuencia de observación. A real CPhonRec::EvaluateUtterance (vector< int > & vutterance) Evaluar pronunciación. Evalua la probabilidad de que la secuencia dada corresponda con el fonema que representa esta instancia. vutterance Secuencia de observación. Probabilidad de ocurrencia de la secuencia de entrada. A string CPhonRec::GetPhonLabel () Obtener la etiqueta del fonema. Instancia string con la etiqueta del fonema. A string CPhonRec::GetPhonName () Obtener el nombre del fonema. Instancia string con el nombre del fonema. A void CPhonRec::Load (fstream & file) Carga el fonema y sus datos desde el archivo especificado. file Origen de datos del archivo.

33 A.5. REFERENCIA DE LA CLASE CPHONREC 163 A void CPhonRec::Load (string & filename) Carga el fonema desde el archivo especificado. filename Nombre del archivo con la ruta completa. A real CPhonRec::LogEvaluateUtterance (vector< int > & vutterance) Evaluar pronunciación. Evalua la probabilidad de que la secuencia dada corresponda con el fonema que representa esta instancia. vutterance Secuencia de observación. Logaritmo de la probabilidad de ocurrencia de la secuencia de entrada. A void CPhonRec::Save (fstream & file) Guarda elemento y sus datos en el archivo especificado. file Origen de datos del archivo. A void CPhonRec::Save (string & filename) Guarda el término en el archivo especificado. filename Nombre del archivo con la ruta completa. A void CPhonRec::SetAverage (real raverage) A void CPhonRec::TrainUtterances () Entrenamiento del modelo de markov del elemento.

34 164 A.5.4. Documentación de los datos miembro APÉNDICE A. DESCRIPCIÓN DE CLASES A HMM CPhonRec::m HMM [private] Modelo Oculto de Markov asociado a la pronunciación. A real CPhonRec::m rprobaverage [private] Valor medio del logaritmo de la probabilidad para el modelo de este fonema. A string CPhonRec::m slabel [private] Etiqueta para el elemento. A string CPhonRec::m sphon [private] Nombre del fonema. A vector< vector<int> > CPhonRec::m vviutterances [private] Secuencias correspondientes a las distintas pronunciaciones asociadas al fonema. La documentación para esta clase fué generada a partir de los siguientes archivos: /PFC/Solution/Application/PhonRec.h /PFC/Solution/Application/PhonRec.cpp

35 A.6. REFERENCIA DE LA CLASE CLANGREC 165 A.6. Referencia de la Clase CLangRec Grupo de fonemas pertenecientes a un idioma. #include <LangRec.h> Métodos públicos CLangRec () Constructor vacio. CLangRec (const string &filename) Constructor cargando el contenido desde disco. CLangRec (fstream &file) Constructor cargando el contenido desde disco. CLangRec () Destructor. CPhonRec AddPhon (string &sphon, string &slabel) Añade un fonema a la configuración de un idioma. CPhonRec AddPhon (string &filename) Añade un elemento nuevo cargando sus datos desde disco. CPhonRec AddPhon (fstream &file) Añade un elemento nuevo cargando sus datos desde disco. int GetNumPhons () Obtener el número de fonemas del idioma. CPhonRec GetPhon (int index) Obtener fonema. CPhonRec GetPhonByLabel (const string &slabel)

36 166 APÉNDICE A. DESCRIPCIÓN DE CLASES Obtener fonema. void Save (const string &filename) Guarda el diccionario en el archivo especificado. void Save (fstream &file) Guarda el diccionario en el archivo especificado. void Load (const string &filename) Carga el diccionario desde el archivo especificado. void Load (fstream &file) Carga el diccionario desde el archivo especificado. Atributos privados string m sname Nombre del idioma. vector< CPhonRec > m vpphons Vector de fonemas incluidos. A.6.1. Descripción detallada Grupo de fonemas pertenecientes a un idioma. Esta clase almacena un conjunto de fonemas correspondientes a un idioma para el sistema de reconocimiento de voz. Cada elemento (clase CPhonRec(p. 159)) está represenado por un nombre, una etiqueta y lo más importante su Modelo Oculto de Markov característico (clase HMM(p. 150)).

37 A.6. REFERENCIA DE LA CLASE CLANGREC 167 A.6.2. Documentación del constructor y destructor A CLangRec::CLangRec () Constructor vacio. A CLangRec::CLangRec (const string & filename) Constructor cargando el contenido desde disco. filename Nombre del archivo con la ruta completa. A CLangRec::CLangRec (fstream & file) Constructor cargando el contenido desde disco. file Origen de datos del archivo desde el que se quiere cargar. A CLangRec:: CLangRec () Destructor. A.6.3. A Documentación de las funciones miembro CPhonRec CLangRec::AddPhon (fstream & file) Añade un elemento nuevo cargando sus datos desde disco. file Origen de datos del archivo del que se quiere cargar el fonema. El puntero a la instancia de la clase CPhonRec(p. 159) que se ha añadido.

38 168 APÉNDICE A. DESCRIPCIÓN DE CLASES A CPhonRec CLangRec::AddPhon (string & filename) Añade un elemento nuevo cargando sus datos desde disco. filename Nombre del archivo del que se quiere cargar el fonema. El puntero a la instancia de la clase CPhonRec(p. 159) que se ha añadido. A CPhonRec CLangRec::AddPhon (string & sphon, string & slabel) Añade un fonema a la configuración de un idioma. sphon Nombre del fonema. slabel Etiqueta del fonema. El puntero a la instancia de la clase CPhonRec(p. 159) que se ha añadido. A int CLangRec::GetNumPhons () Obtener el número de fonemas del idioma. Entero con el número de elementos. A CPhonRec CLangRec::GetPhon (int index) Obtener fonema. index Índice del elemento en la lista de fonemas. Puntero a la instancia CPhonRec(p. 159) del elemento de índice index. Devuelve NULL si el índice está fuera de rango.

39 A.6. REFERENCIA DE LA CLASE CLANGREC 169 A CPhonRec CLangRec::GetPhonByLabel (const string & slabel) Obtener fonema. slabel Etiqueta del fonema que se quiere obtener. Puntero a la instancia CPhonRec(p. 159) del elemento de etiqueta slabel. Devuelve NULL si no está contenido en el grupo de fonemas de este idioma. A void CLangRec::Load (fstream & file) Carga el diccionario desde el archivo especificado. file Origen de datos del archivo. A void CLangRec::Load (const string & filename) Carga el diccionario desde el archivo especificado. filename Nombre del archivo con la ruta completa. A void CLangRec::Save (fstream & file) Guarda el diccionario en el archivo especificado. file Origen de datos del archivo. A void CLangRec::Save (const string & filename) Guarda el diccionario en el archivo especificado. filename Nombre del archivo con la ruta completa.

40 170 A.6.4. Documentación de los datos miembro APÉNDICE A. DESCRIPCIÓN DE CLASES A string CLangRec::m sname [private] Nombre del idioma. A vector<cphonrec > CLangRec::m vpphons [private] Vector de fonemas incluidos. La documentación para esta clase fué generada a partir de los siguientes archivos: /PFC/Solution/Application/LangRec.h /PFC/Solution/Application/LangRec.cpp

41 A.7. REFERENCIA DE LA CLASE CWORDREC 171 A.7. Referencia de la Clase CWordRec #include <WordRec.h> Métodos públicos CWordRec (string &sword, CLangRec plangrec) Constructor. CWordRec () Destructor. string GetWord () Devuelve el elemento en una instancia string. real EvaluateUtterance (vector< int > &vutterance) Evaluar pronunciación. Métodos privados void PhoneticTrascription () Trascripción fonética de la palabra en español. void ConstructProbMatrix (vector< int > &vutterance) Construye la matriz de probabilidades acumuladas. real LogProbability (int fon, int i, int f, vector< int > &vutterance) Probabilidad de ocurrencia de una secuencia. Atributos privados string m sword Palabra.

42 172 APÉNDICE A. DESCRIPCIÓN DE CLASES vector< CPhonRec > m vphons Lista de fonemas que forman la pronunciación de la palabra. CLangRec m plangrec Grupo de fonemas del español. real m prprobability int m piindex A.7.1. A Documentación del constructor y destructor CWordRec::CWordRec (string & sword, CLangRec plangrec) Constructor. sword Nombre del elemento. plangrec Puntero a la intsnacia de la clase de definición de idioma. A CWordRec:: CWordRec () Destructor. A.7.2. A Documentación de las funciones miembro void CWordRec::ConstructProbMatrix (vector< int > & vutterance) [private] Construye la matriz de probabilidades acumuladas. Este método privado se apoya en el algoritmo de Viterbi para obtener la probabilidad de que una palabra está pronunciada en una secuencia. La matriz posee la probabilidad de que un determinado fonema se termine de pronunciar en un determinado frame. Con la distribución de los anteriores que hace máxima esta distribución. En otra matriz se almacena para cada paso la distribución de dichos fonemas.

43 A.7. REFERENCIA DE LA CLASE CWORDREC 173 A real CWordRec::EvaluateUtterance (vector< int > & vutterance) Evaluar pronunciación. Evalua la probabilidad de que la secuencia dada corresponda con la palabra que representa esta instancia. vutterance Secuencia de observación. A string CWordRec::GetWord () Devuelve el elemento en una instancia string. A real CWordRec::LogProbability (int fon, int i, int f, vector< int > & vutterance) [private] Probabilidad de ocurrencia de una secuencia. Este método devuelve la probabilidad de ocurrencia de una subsecuencia para un fonema concreto de la palabra que se está estudiando. fon Índice del fonema en la palabra. i Primer elemento de la subsecuencia dentro de la secuencia vutterance. f Último elemento de la subsecuencia dentro de la secuencia vutterance. vutterance Secuncia de la que se extrae la subsecuencia. El logaritmo de la probabilidad de ocurrencia de la subsecuencia. A void CWordRec::PhoneticTrascription () [private] Trascripción fonética de la palabra en español. Realiza la trascirpción fonética de la palabra según las reglas del español. Crea así la lista de fonemas (CPhonRec(p. 159)) correspondientes a la pronunciación de aquella.

44 174 A.7.3. Documentación de los datos miembro APÉNDICE A. DESCRIPCIÓN DE CLASES A int CWordRec::m piindex [private] A CLangRec CWordRec::m plangrec [private] Grupo de fonemas del español. A real CWordRec::m prprobability [private] A string CWordRec::m sword [private] Palabra. A vector<cphonrec > CWordRec::m vphons [private] Lista de fonemas que forman la pronunciación de la palabra. La documentación para esta clase fué generada a partir de los siguientes archivos: /PFC/Solution/Application/WordRec.h /PFC/Solution/Application/WordRec.cpp

45 A.8. REFERENCIA DE LA CLASE CDICTREC 175 A.8. Referencia de la Clase CDictRec Diccionario de términos identificables. #include <DictRec.h> Métodos públicos CDictRec (const string &name, CLangRec plangrec) Constructor dando la instancia de la clase de configuración del idioma. CDictRec (const string &name, const string &slangrecfile) Constructor indicando la coniguración del idioma. CDictRec (const string &filename) Constructor cargando el contenido desde disco. CDictRec (fstream &file) Constructor cargando el contenido desde disco. CDictRec () Destructor. CWordRec AddWord (string &sword) Añade una palabra nueva al diccionario de términos identificables. int GetNumWords () Obtener el número de términos en el diccionario. CWordRec GetWord (int index) Obtener una palabra del diccionario. CWordRec GetWord (const string &sword) Obtener una palabra del diccionario. CWordRec Identify (vector< int > &vsecuence)

46 176 APÉNDICE A. DESCRIPCIÓN DE CLASES Identificación de un término. void Save (const string &filename) Guarda el diccionario en el archivo especificado. void Save (fstream &file) Guarda el diccionario en el archivo especificado. void Load (const string &filename) Carga el diccionario desde el archivo especificado. void Load (fstream &file) Carga el diccionario desde el archivo especificado. Atributos privados string m sname Nombre del diccionario. string m slangrecfile CLangRec m plangrec Grupo de fonemas del idioma empleado. vector< CWordRec > m vpwords Vector de elementos identificables. A.8.1. Descripción detallada Diccionario de términos identificables. Esta clase almacena un conjunto de palabras identificables mediante el sistema de reconocimiento de voz.

47 A.8. REFERENCIA DE LA CLASE CDICTREC 177 A.8.2. A Documentación del constructor y destructor CDictRec::CDictRec (const string & name, CLangRec plangrec) Constructor dando la instancia de la clase de configuración del idioma. name Nombre que se quiere dar al diccionario. plangrec Puntero a la instancia de la clase de configuración del idioma. A CDictRec::CDictRec (const string & name, const string & slangrecfile) Constructor indicando la coniguración del idioma. name Nombre que se quiere dar al diccionario. slangrecfile Puntero a la clase de configuración del idioma. A CDictRec::CDictRec (const string & filename) Constructor cargando el contenido desde disco. filename Nombre del archivo con la ruta completa. A CDictRec::CDictRec (fstream & file) Constructor cargando el contenido desde disco. file Origen de datos del archivo desde el que se quiere cargar el diccionario. A CDictRec:: CDictRec () Destructor.

48 178 A.8.3. A Documentación de las funciones miembro APÉNDICE A. DESCRIPCIÓN DE CLASES CWordRec CDictRec::AddWord (string & sword) Añade una palabra nueva al diccionario de términos identificables. sword Palabra a añadir. El puntero a la instancia de la clase CWordRec(p. 171) que se ha añadido. A int CDictRec::GetNumWords () Obtener el número de términos en el diccionario. Entero con el número de elementos en el diccionario. A CWordRec CDictRec::GetWord (const string & sword) Obtener una palabra del diccionario. sword Palabra que se quiere encontrar. Puntero a la instancia CWordRec(p. 171) de la palabra sword. A CWordRec CDictRec::GetWord (int index) Obtener una palabra del diccionario. index Índice del elemento en la lista de términos. El puntero a la instancia de la clase CWordRec(p. 171) de índice index.

49 A.8. REFERENCIA DE LA CLASE CDICTREC 179 A CWordRec CDictRec::Identify (vector< int > & vsecuence) Identificación de un término. Identifica a que elemento del diccionario pertenece (con mayor probabilidad) la secuencia de observación dada. vsecuence Secuencia del elemento a identificar. Esta secuencia se obtiene del analisis de la señal de voz (clase CSignal(p. 141)) y posterior clasificación de los vectores de coeficientes cepstrales obenidos. Puntero a la instancia CWordRec(p. 171) de la palabra que se estima se ha identificado en la secuencia. A void CDictRec::Load (fstream & file) Carga el diccionario desde el archivo especificado. file Origen de datos del archivo. A void CDictRec::Load (const string & filename) Carga el diccionario desde el archivo especificado. filename Nombre del archivo con la ruta completa. A void CDictRec::Save (fstream & file) Guarda el diccionario en el archivo especificado. file Origen de datos del archivo.

50 180 APÉNDICE A. DESCRIPCIÓN DE CLASES A void CDictRec::Save (const string & filename) Guarda el diccionario en el archivo especificado. filename Nombre del archivo con la ruta completa. A.8.4. Documentación de los datos miembro A CLangRec CDictRec::m plangrec [private] Grupo de fonemas del idioma empleado. A string CDictRec::m slangrecfile [private] Nombre del archivo del que se cargan los fonemas del idioma empleado. A string CDictRec::m sname [private] Nombre del diccionario. A vector<cwordrec > CDictRec::m vpwords [private] Vector de elementos identificables. La documentación para esta clase fué generada a partir de los siguientes archivos: C:/Fran/Escuela/PFC/Solution/Application/DictRec.h C:/Fran/Escuela/PFC/Solution/Application/DictRec.cpp