marytts.tools.voiceimport

Class VoiceImportComponent

java.lang.Object

marytts.tools.voiceimport.VoiceImportComponent

Direct Known Subclasses:

AbstractTimelineMaker, AcousticFeatureFileWriter, AllophonesExtractor, AutocorrelationPitchmarker, BasenameTimelineMaker, CARTBuilder, DurationCARTTrainer, DurationSoPTrainer, DurationTreeTrainer, EHMMLabeler, EndpointDetector, F0CARTTrainer, F0PolynomialFeatureFileWriter, F0PolynomialInspector, F0PolynomialTreeTrainer, F0SoPTrainer, FeatureSelection, Festvox2MaryTranscripts, HMMParameterExtractor, HMMVoiceConfigure, HMMVoiceDataPreparation, HMMVoiceFeatureSelection, HMMVoiceMakeData, HMMVoiceMakeVoice, HNMFeatureFileWriter, HnmTimelineMaker, HTKLabeler, JoinCostFileMaker, JoinCostPrecomputer, JoinModeller, LabelledFilesInspector, LabelPauseDeleter, LPCTimelineMaker, Mary2FestvoxTranscripts, MCEPMaker, MCepTimelineMaker, MLSAFeatureFileComputer, MLSAFeatureFileWriter, MRPALabelConverter, OctaveVoiceQualityProcessor, PauseDurationTrainer, PauseFeatureComputer, PhoneFeatureFileWriter, PhoneLabelFeatureAligner, PhoneUnitFeatureComputer, PhoneUnitfileWriter, PhoneUnitLabelComputer, PraatPitchmarker, QualityControl, SanityChecker, SCostUnitFileWriter, SnackF0ContourExtractor, SnackPitchmarker, SnackVoiceQualityProcessor, SphinxLabeler, SphinxLabelingPreparator, SphinxTrainer, SPTKMFCCExtractor, TranscriptionAligner, UnknownWordsFrequencyComputer, VocalizationF0PolyFeatureFileWriter, VocalizationF0PolynomialInspector, VocalizationFeatureFileWriter, VocalizationIntonationWriter, VocalizationTimelineMaker, VocalizationUnitfileWriter, VoiceCompiler, WaveTimelineMaker

public abstract class VoiceImportComponent
extends Object

A component in the process of importing a voice into MARY format.

Author:

Marc Schröder, Anna Hunecke

Field Summary

Fields

Modifier and Type	Field and Description
protected BasenameList	bnl
protected DatabaseLayout	db
protected org.apache.log4j.Logger	logger
protected SortedMap<String,String>	props
protected SortedMap<String,String>	props2Help

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VoiceImportComponent()

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	compute() Do the computations required by this component.
abstract SortedMap<String,String>	getDefaultProps(DatabaseLayout db) Get the map of properties2values containing the default values
String	getHelpText()
String	getHelpTextForProp(String propname)
abstract String	getName() Get the name of this component
abstract int	getProgress() Provide the progress of computation, in percent, or -1 if that feature is not implemented.
String	getProp(String prop) Get the value for a property
void	initialise(DatabaseLayout db, BasenameList bnl, SortedMap<String,String> props) Initialise a voice import component: update values of local properties; setup help text for properties; call to component specific intialisation
protected void	initialiseComp() Initialise a voice import component: component specific initialisation; to be overwritten by subclasses
void	setProp(String prop, String value) Set a property to a value
protected abstract void	setupHelp()

Methods inherited from class java.lang.Object

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

Field Detail

props

protected SortedMap<String,String> props

props2Help

protected SortedMap<String,String> props2Help

bnl

protected BasenameList bnl

db

protected DatabaseLayout db

logger

protected org.apache.log4j.Logger logger

Constructor Detail

VoiceImportComponent

protected VoiceImportComponent()

Method Detail

setupHelp

protected abstract void setupHelp()

initialise

public final void initialise(DatabaseLayout db,
              BasenameList bnl,
              SortedMap<String,String> props)
                      throws Exception

Initialise a voice import component: update values of local properties; setup help text for properties; call to component specific intialisation

Parameters:

db - the database layout

bnl - the list of basenames

props - the map from properties to values

Throws:

Exception - Exception

initialiseComp

protected void initialiseComp()
                       throws Exception

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

Throws:

Exception - Exception

getDefaultProps

public abstract SortedMap<String,String> getDefaultProps(DatabaseLayout db)

Get the map of properties2values containing the default values

Parameters:

db - db

Returns:

map of props2values

getProp

public String getProp(String prop)

Get the value for a property

Parameters:

prop - the property name

Returns:

the value

setProp

public void setProp(String prop,
           String value)

Set a property to a value

Parameters:

prop - the property

value - the value

getName

public abstract String getName()

Get the name of this component

Returns:

the name

compute

public abstract boolean compute()
                         throws Exception

Do the computations required by this component.

Returns:

true on success, false on failure

Throws:

Exception - Exception

getProgress

public abstract int getProgress()

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

Returns:

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

getHelpText

public String getHelpText()

getHelpTextForProp

public String getHelpTextForProp(String propname)