marytts.tools.voiceimport

Class PhoneLabelFeatureAligner

java.lang.Object

marytts.tools.voiceimport.VoiceImportComponent

marytts.tools.voiceimport.PhoneLabelFeatureAligner

Direct Known Subclasses:

HalfPhoneLabelFeatureAligner

public class PhoneLabelFeatureAligner
extends VoiceImportComponent

Compare unit label and unit feature files. If they don't align, flag a problem; let the user decide how to fix it -- either by editing the unit label file or by editing a rawmaryxml file and recomputing the features file.

Author:

schroed

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PhoneLabelFeatureAligner.EditFrameShower

Field Summary

Fields

Modifier and Type	Field and Description
protected AllophonesExtractor	allophoneExtractor
protected boolean	correctedPauses
protected DatabaseLayout	db
protected String	featsDir
protected String	featsExt
protected PhoneUnitFeatureComputer	featureComputer
protected String	labDir
protected PhoneUnitLabelComputer	labelComputer
protected String	labExt
protected String	pauseSymbol
protected int	percent
protected Map<String,String>	problems
protected static int	REMOVE
protected static int	REMOVEALL
protected static int	SKIP
protected static int	SKIPALL
protected TranscriptionAligner	transcriptionAligner
protected static int	TRYAGAIN

Fields inherited from class marytts.tools.voiceimport.VoiceImportComponent

bnl, logger, props, props2Help

Constructor Summary

Constructors

Constructor and Description
PhoneLabelFeatureAligner()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	compute() Align labels and features.
protected int	correctPauses() Try to automatically correct misalignment caused by pauses: If there is a pause in the label file and not in the feature file, it is removed in the label file.
protected int	correctPausesYesNo(int numProblems) Let the user select if he wants to run the the automatic correction of pauses.
protected void	customInitialisation()
protected void	defineReplacementInfo(String text)
protected void	defineReplacements(String text)
protected void	defineReplacementWindow()
protected void	deleteProblemsYesNo(Map<String,String> someProblems, String basename) Let the user select if he wants to run the the automatic correction of pauses.
SortedMap<String,String>	getDefaultProps(DatabaseLayout theDb) Get the map of properties2values containing the default values
String	getName() Get the name of this component
int	getProgress() Provide the progress of computation, in percent, or -1 if that feature is not implemented.
protected void	initialiseComp() Initialise a voice import component: component specific initialisation; to be overwritten by subclasses
protected int	letUserCorrect(String basename, String errorMessage)
static void	main(String[] args)
protected void	setupHelp()
protected String	verifyAlignment(String basename) Verify if the feature and label files for basename align OK.

Methods inherited from class marytts.tools.voiceimport.VoiceImportComponent

getHelpText, getHelpTextForProp, getProp, initialise, setProp

Methods inherited from class java.lang.Object

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

Field Detail

featureComputer

protected PhoneUnitFeatureComputer featureComputer

allophoneExtractor

protected AllophonesExtractor allophoneExtractor

labelComputer

protected PhoneUnitLabelComputer labelComputer

transcriptionAligner

protected TranscriptionAligner transcriptionAligner

pauseSymbol

protected String pauseSymbol

db

protected DatabaseLayout db

percent

protected int percent

problems

protected Map<String,String> problems

correctedPauses

protected boolean correctedPauses

featsExt

protected String featsExt

labExt

protected String labExt

labDir

protected String labDir

featsDir

protected String featsDir

TRYAGAIN

protected static final int TRYAGAIN

See Also:

Constant Field Values

SKIP

protected static final int SKIP

See Also:

Constant Field Values

SKIPALL

protected static final int SKIPALL

See Also:

Constant Field Values

REMOVE

protected static final int REMOVE

See Also:

Constant Field Values

REMOVEALL

protected static final int REMOVEALL

See Also:

Constant Field Values

Constructor Detail

PhoneLabelFeatureAligner

public PhoneLabelFeatureAligner()

Method Detail

getName

public String getName()

Description copied from class: VoiceImportComponent

Get the name of this component

Specified by:

getName in class VoiceImportComponent

Returns:

the name

customInitialisation

protected void customInitialisation()

initialiseComp

protected final void initialiseComp()
                             throws Exception

Description copied from class: VoiceImportComponent

Initialise a voice import component: component specific initialisation; to be overwritten by subclasses

Overrides:

initialiseComp in class VoiceImportComponent

Throws:

Exception - Exception

getDefaultProps

public SortedMap<String,String> getDefaultProps(DatabaseLayout theDb)

Description copied from class: VoiceImportComponent

Get the map of properties2values containing the default values

Specified by:

getDefaultProps in class VoiceImportComponent

Parameters:

theDb - db

Returns:

map of props2values

setupHelp

protected void setupHelp()

Specified by:

setupHelp in class VoiceImportComponent

compute

public boolean compute()
                throws Exception

Align labels and features. For each .phonelab file in the phone label directory, verify whether the chain of units given is identical to the chain of units in the corresponding unit feature file. For those files that are not perfectly aligned, give the user the opportunity to correct alignment.

Specified by:

compute in class VoiceImportComponent

Returns:

a boolean indicating whether or not the database is fully aligned.

Throws:

Exception - Exception

correctPausesYesNo

protected int correctPausesYesNo(int numProblems)
                          throws IOException

Let the user select if he wants to run the the automatic correction of pauses.

Parameters:

numProblems - the number of problems

Returns:

the number of problems remaining

Throws:

IOException - IOException

deleteProblemsYesNo

protected void deleteProblemsYesNo(Map<String,String> someProblems,
                       String basename)
                            throws IOException

Let the user select if he wants to run the the automatic correction of pauses.

Parameters:

someProblems - someProblems

basename - basename

Throws:

IOException - IOException

defineReplacementWindow

protected void defineReplacementWindow()

defineReplacementInfo

protected void defineReplacementInfo(String text)

correctPauses

protected int correctPauses()
                     throws IOException

Try to automatically correct misalignment caused by pauses: If there is a pause in the label file and not in the feature file, it is removed in the label file. If there is a pause in the feature file and not in the label file, a pause of length zero is inserted in the label file

Returns:

the number of problems remaining

Throws:

IOException - IOException

defineReplacements

protected void defineReplacements(String text)
                           throws Exception

Throws:

Exception

verifyAlignment

protected String verifyAlignment(String basename)
                          throws IOException

Verify if the feature and label files for basename align OK. This method should be called after firstVerifyAlignment for subsequent alignment tries.

Parameters:

basename - basename

Returns:

null if the alignment was OK, or a String containing an error message.

Throws:

IOException - IOException

letUserCorrect

protected int letUserCorrect(String basename,
                 String errorMessage)
                      throws Exception

Throws:

Exception

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

getProgress

public int getProgress()

Provide the progress of computation, in percent, or -1 if that feature is not implemented.

Specified by:

getProgress in class VoiceImportComponent

Returns:

-1 if not implemented, or an integer between 0 and 100.