marytts.modules

Class PronunciationModel

java.lang.Object

marytts.modules.InternalModule

marytts.modules.PronunciationModel

All Implemented Interfaces:

MaryModule

Direct Known Subclasses:

Postlex, Postlex, PronunciationModel

public class PronunciationModel
extends InternalModule

This module serves as a post-lexical pronunciation model. Its appropriate place in the module chain is after intonisation. The target features are taken and fed into decision trees that predict the new pronunciation. A new mary xml is output, with the difference being that the old pronunciation is replaced by the newly predicted one, and a finer grained xml structure.

Author:

ben

Field Summary

Fields inherited from class marytts.modules.InternalModule

logger, state

Fields inherited from interface marytts.modules.MaryModule

MODULE_OFFLINE, MODULE_RUNNING

Constructor Summary

Constructors

Constructor and Description
PronunciationModel() Constructor, stating that the input is of type INTONATION, the output of type ALLOPHONES.
PronunciationModel(Locale locale)

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	postlexicalRules(Element token, AllophoneSet allophoneSet) Optionally, a language-specific subclass can implement any postlexical rules on the document.
MaryData	process(MaryData d) This computes a new pronunciation for the elements of some MaryData, that is phonemised.
void	startup() Allow the module to start up, performing whatever is necessary to become operational.
protected void	updatePhAttributesFromPhElements(Element token)

Methods inherited from class marytts.modules.InternalModule

getInputType, getLocale, getOutputType, getState, inputType, name, outputType, powerOnSelfTest, shutdown

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PronunciationModel

public PronunciationModel()

Constructor, stating that the input is of type INTONATION, the output of type ALLOPHONES.

PronunciationModel

public PronunciationModel(Locale locale)

Method Detail

startup

public void startup()
             throws Exception

Description copied from interface: MaryModule

Allow the module to start up, performing whatever is necessary to become operational. After successful completion, getState() should return MODULE_RUNNING.

Specified by:

startup in interface MaryModule

Overrides:

startup in class InternalModule

Throws:

Exception - Exception

postlexicalRules

protected boolean postlexicalRules(Element token,
                       AllophoneSet allophoneSet)

Optionally, a language-specific subclass can implement any postlexical rules on the document.

Parameters:

token - a <t> element with a syllable and <ph> substructure.

allophoneSet - allophoneSet

Returns:

true if something was changed, false otherwise

process

public MaryData process(MaryData d)
                 throws Exception

This computes a new pronunciation for the elements of some MaryData, that is phonemised.

Specified by:

process in interface MaryModule

Overrides:

process in class InternalModule

Parameters:

d - d

Returns:

A MaryData object of type outputType() encapsulating the processing result.

This method just returns its input. Subclasses should override this.

Throws:

Exception - Exception

updatePhAttributesFromPhElements

protected void updatePhAttributesFromPhElements(Element token)