SETTINGS HELP

Warning: the settings of the modules are connected: If you change a setting in one module, 
then maybe the next module will not work anymore! 

The settings are set up so that everything works, so normally you will not want to change anything.
Settings that you might want to change and that do not interact with other settings, are marked with a star (*).


GlobalProperties:
db.basenameFile      : file containing the list of files that are used to build the voice
*db.domain           : general or limited
*db.gender           : female or male
db.labDir            : directory containing the label files. Will be created if it does not exist.
db.labExtension      : extension of the label files, default: ".lab"
*db.locale     	     : de, en or en_US
*db.marybase      	 : directory containing the local Mary installation
db.maryxmlDir    	 : directory containing maryxml representations of the transcripts. Will be created
					   if it does not exist.
db.maryxmlExtension  : extension of the maryxml files, default: ".xml"
*db.rootDir          : directory in which all the files created during installation will be stored.
					   Will be created if it does not exist. 
*db.samplingrate     : the sampling rate of the wave files, default: "16000"
db.textDir           : directory containing the transcript files. Will be created if it does not exist.
db.textExtension     : extension of the transcript files, default: ".txt"
*db.voicename        : the name of the voice, one word, default: "cmu_us_bdl_arctic"
*db.wavDir           : directory containing the wave files. If it does not exist, an Error is thrown.
*db.wavExtension     : extension of the wave files, default: ".wav"


Properties for module praatPitchmarker:
*praatPitchmarker.command    : the command to start praat; default is "praat"
praatPitchmarker.corrPmDir   : directory containing the corrected pitchmarkfiles. Per default the same
							   as the directory containing the pitchmarks. Will be created if 
							   it does not exist.
praatPitchmarker.corrPmExt   : extension of the corrected pitchmark files, default: ".pm.corrected"
*praatPitchmarker.maxPitch   : maximum value for the pitch (in Hz). Default: female 500, male 300.
*praatPitchmarker.minPitch   : minimum value for the pitch (in Hz). Default: female 100, male 75.
praatPitchmarker.pmDir       : directory containing the pitchmarks. Will be created if it does not exist.
praatPitchmarker.pmExt       : extension of the pitchmark files, default: ".pm"
praatPitchmarker.pointPExt   : extension of the point process files, default: ".PointProcess"
praatPitchmarker.tempScript  : filename of the temporary script used by praat


Properties for module mcepMaker:
mcepMaker.corrPmDir : directory containing the corrected pitchmarkfiles. Per default the same
				      as the directory containing the pitchmarks.
mcepMaker.corrPmExt : extension of the corrected pitchmark files, default: ".pm.corrected"
mcepMaker.estDir    : directory containing the local installation of the Edinburgh Speech Tools
mcepMaker.mcepDir   : directory containing the mcep files
mcepMaker.mcepExt   : extension of the mcep files, default: ".mcep"
mcepMaker.pmDir     : directory containing the pitchmarks
mcepMaker.pmExt     : extension of the pitchmark files, default: ".pm"


Properties for module mary2FestvoxTranscripts:
*mary2FestvoxTranscripts.transcriptFile : file containing the transcripts in festvox format:
										 ( <filename1> "<text>" )
										 ( <filename2> "<text>" ) and so on


Properties for module sphinxLabelingPreparator:
*sphinxLabelingPreparator.maryServerHost : the host were the Mary server is running, default: "localhost"
*sphinxLabelingPreparator.maryServerPort : the port were the Mary server is listening, default: "59125"
*sphinxLabelingPreparator.estDir         : directory containing the local installation of the 
										  Edinburgh Speech Tools
*sphinxLabelingPreparator.sphinxTrainDir : directory containing the local installation of SphinxTrain
sphinxLabelingPreparator.stDir           : directory containing all files used for training
										   and labeling. Will be created if it does not exist.
*sphinxLabelingPreparator.transcriptFile : file containing the transcripts in festvox format:
										  ( <filename1> "<text>" )
										  ( <filename2> "<text>" ) and so on


Properties for module sphinxTrainer:
sphinxTrainer.stDir : directory containing all files used for training and labeling


Properties for module sphinxLabeler:
*sphinxLabeler.sphinx2Dir : directory containing the local installation of Sphinx2
sphinxLabeler.stDir       : directory containing all files used for training and labeling


Properties for module mrpaLabelConverter:
mrpaLabelConverter.mrpaLabDir : directory containing the mrpa label files


Properties for module festvox2MaryTranscripts:
*festvox2MaryTranscripts.transcriptFile  : file containing the transcripts in festvox format:
										  ( <filename1> "<text>" )
										  ( <filename2> "<text>" ) and so on


Properties for module labelledFilesInspector:
labelledFilesInspector.corrPmDir    : directory containing the corrected pitchmarkfiles
labelledFilesInspector.corrPmExt    : extension of the corrected pitchmark files, default: ".pm.corrected"
labelledFilesInspector.exLabDir     : directory to were to save the label files. 
									  Will be created if it does not exist.
labelledFilesInspector.exPmDir      : directory to were to save the pitchmark files. 
									  Will be created if it does not exist.
labelledFilesInspector.exWavDir     : directory to were to save the wave files.
									  Will be created if it does not exist.
labelledFilesInspector.extractedDir : directory to were to save the modified files to.
									  Will be created if it does not exist.
labelledFilesInspector.pmExt        : extension of the pitchmark files, default: ".pm"


Properties for module phoneUnitLabelComputer:
phoneUnitLabelComputer.labelDir : directory containing the phone labels. Will be created if it does not exist.
phoneUnitLabelComputer.labelExt : extension of the phone label files, default: ".lab"


Properties for module phoneUnitFeatureComputer:
phoneUnitFeatureComputer.featureDir      : directory containing the phone features. 
										   Will be created if it does not exist.
phoneUnitFeatureComputer.featureExt      : extension of the phone feature files, default: ".pfeats"
*phoneUnitFeatureComputer.maryServerHost : the host were the Mary server is running, default: "localhost"
*phoneUnitFeatureComputer.maryServerPort : the port were the Mary server is listening, default: "59125"


Properties for module phoneLabelFeatureAligner:
phoneLabelFeatureAligner.featureDir : directory containing the phone features
phoneLabelFeatureAligner.featureExt : extension of the phone feature files, default: ".pfeats"
phoneLabelFeatureAligner.labelDir   : directory containing the phone labels. 
phoneLabelFeatureAligner.labelExt   : extension of the phone label files, default: ".lab"


Properties for module halfPhoneUnitLabelComputer:
halfPhoneUnitLabelComputer.labelDir : directory containing the halfphone labels. 
									  Will be created if it does not exist.
halfPhoneUnitLabelComputer.labelExt : extension of the halfphone label files, default: ".hplab"


Properties for module halfPhoneUnitFeatureComputer:
halfPhoneUnitFeatureComputer.featureDir      : directory containing the halfphone features. 
										       Will be created if it does not exist.
halfPhoneUnitFeatureComputer.featureExt      : extension of the phone feature files, default: ".hpfeats"
*halfPhoneUnitFeatureComputer.maryServerHost : the host were the Mary server is running, default: "localhost"
*halfPhoneUnitFeatureComputer.maryServerPort : the port were the Mary server is listening, default: "59125"


Properties for module halfPhoneLabelFeatureAligner:
halfPhoneLabelFeatureAligner.featureDir : directory containing the halfphone features. 
halfPhoneLabelFeatureAligner.featureExt : extension of the phone feature files, default: ".hpfeats"
halfPhoneLabelFeatureAligner.labelDir   : directory containing the halfphone labels
halfPhoneLabelFeatureAligner.labelExt   : extension of the halfphone label files, default: ".hplab"


Properties for module waveTimelineMaker:
waveTimelineMaker.corrPmDir    : directory containing the corrected pitchmarks
waveTimelineMaker.corrPmExt    : extension of the corrected pitchmark files, default: ".pm.corrected"
waveTimelineMaker.waveTimeline : file containing all wave files. Will be created by this module.


Properties for module basenameTimelineMaker:
basenameTimelineMaker.pmDir        : directory containing the pitchmarks
basenameTimelineMaker.pmExtentsion : extension of the pitchmark files, default: ".pm"
basenameTimelineMaker.timelineFile : file containing the list of files and their times.
									 Will be created by this module.


Properties for module mcepTimelineMaker:
mcepTimelineMaker.mcepDir      : directory containing the mcep files
mcepTimelineMaker.mcepExt      : extension of the mcep files, default: ".mcep"
mcepTimelineMaker.mcepTimeline : file containing all mcep files. Will be created by this module.


Properties for module phoneUnitfileWriter:
phoneUnitfileWriter.corrPmDir : directory containing the corrected pitchmarks
phoneUnitfileWriter.corrPmExt : extension of the corrected pitchmark files, default: ".pm.corrected"
phoneUnitfileWriter.labelDir  : directory containing the phone labels
phoneUnitfileWriter.labelExt  : extension of the phone label files, default: ".lab"
phoneUnitfileWriter.unitFile  : file containing all phone units. Will be created by this module.


Properties for module phoneFeatureFileWriter:
phoneFeatureFileWriter.featureDir  : directory containing the phone features
phoneFeatureFileWriter.featureExt  : extension of the phone feature files, default: ".pfeats"
phoneFeatureFileWriter.featureFile : file containing all phone units and their target cost features.
									 Will be created by this module.
phoneFeatureFileWriter.unitFile    : file containing all phone units
phoneFeatureFileWriter.weightsFile : file containing the list of phone target cost features, their values and weights


Properties for module durationCARTTrainer:
durationCARTTrainer.durDescFile       : file containing the descriptions for the features used for
										building the duration CART. Will be created by this module.
durationCARTTrainer.durDir            : directory containing files needed temporarily by the module.
										Will be created if it does not exist.
durationCARTTrainer.durFeatsFile      : file containing the features used for building the duration CART.
										Will be created by this module.
durationCARTTrainer.durTreeFile       : file containing the duration CART. Will be created by this module.
*durationCARTTrainer.estDir           : directory containing the local installation of the 
										Edinburgh Speech Tools
durationCARTTrainer.featureDir        : directory containing the phonefeatures
durationCARTTrainer.featureFile       : file containing all phone units and their target cost features
durationCARTTrainer.labelDir          : directory containing the phone labels
*durationCARTTrainer.stepwiseTraining : "false" or "true" ???????????????????????????????????????????????????????????
durationCARTTrainer.unitFile          : file containing all phone units
durationCARTTrainer.waveTimeline      : file containing all wave files


Properties for module f0CARTTrainer:
*f0CARTTrainer.estDir           : directory containing the local installation of the 
								  Edinburgh Speech Tools
f0CARTTrainer.f0DescFile        : file containing the descriptions for the features used for
								  building the f0 CARTs. Will be created by this module.
f0CARTTrainer.f0Dir             : directory containing files needed temporarily by the module.
								  Will be created if it does not exist.
f0CARTTrainer.f0LeftFeatFile    : file containing the features used for building the left f0 CART.
								  Will be created by this module.
f0CARTTrainer.f0LeftTreeFile    : file containing the left f0 CART. Will be created by this module.
f0CARTTrainer.f0MidFeatFile     : file containing the features used for building the middle f0 CART.
								  Will be created by this module.
f0CARTTrainer.f0MidTreeFile     : file containing the middle f0 CART. Will be created by this module.
f0CARTTrainer.f0RightFeatFile   : file containing the features used for building the right f0 CART.
								  Will be created by this module.
f0CARTTrainer.f0RightTreeFile   : file containing the right f0 CART. Will be created by this module.
f0CARTTrainer.featureDir        : directory containing the phonefeatures
f0CARTTrainer.featureExt        : extension of the phone feature files, default ".pfeats"
f0CARTTrainer.featureFile       : file containing all phone units and their target cost features
f0CARTTrainer.labelDir          : directory containing the phone label files
f0CARTTrainer.labelExt          : extension of the phone label files, default: ".lab"
*f0CARTTrainer.stepwiseTraining : "false" or "true" ???????????????????????????????????????????????????????????
f0CARTTrainer.unitFile          : file containing all phone units
f0CARTTrainer.waveTimeline      : file containing all wave files


Properties for module halfPhoneUnitfileWriter:
halfPhoneUnitfileWriter.corrPmDir : directory containing the corrected pitchmarks
halfPhoneUnitfileWriter.corrPmExt : extension of the corrected pitchmark files, default ".pm.corrected"
halfPhoneUnitfileWriter.labelDir  : directory containing the halfphone label files
halfPhoneUnitfileWriter.labelExt  : extension of the halfphone label files, default: ".hplab"
halfPhoneUnitfileWriter.unitFile  : file containing all halfphone units. Will be created by this module.


Properties for module halfPhoneFeatureFileWriter:
halfPhoneFeatureFileWriter.featureDir  : directory containing the halfphone feature files
halfPhoneFeatureFileWriter.featureExt  : extension of the halfphone features files, default ".hpfeats"
halfPhoneFeatureFileWriter.featureFile : file containing all halfphone units and their target cost features.
										 Will be created by this module.
halfPhoneFeatureFileWriter.unitFile    : file containing all halfphone units
halfPhoneFeatureFileWriter.weightsFile : file containing the list of halfphone target cost features, 
										 their values and weights


Properties for module joinCostFileMaker:
joinCostFileMaker.joinCostFile : file containing all halfphone units and their join cost features.
								 Will be created by this module.
joinCostFileMaker.mcepDir      : directory containing the mcep files
joinCostFileMaker.mcepExt      : extension of the mcep files, default ".mcep"
joinCostFileMaker.mcepTimeline : file containing all mcep files
joinCostFileMaker.unitFile     : file containing all halfphone units
joinCostFileMaker.weightsFile  : file containing the list of join cost weights and their weights 


Properties for module joinCostPrecomputer:
joinCostPrecomputer.joinCostFeaturesFile : file containing all halfphone units and their join cost features
joinCostPrecomputer.joinCostFile         : file containing the join costs for every halfphone unit pair.
										   Will be created by this module.
joinCostPrecomputer.unitFeaturesFile     : file containing all halfphone units and their target cost features
joinCostPrecomputer.unitFile             : file containing all halfphone units


Properties for module acousticFeatureFileWriter:
acousticFeatureFileWriter.acFeatureFile : file containing all halfphone units and their target cost features
										  plus the acoustic target cost features. Will be created by this module.
acousticFeatureFileWriter.featureFile   : file containing all halfphone units and their target cost features
acousticFeatureFileWriter.unitFile      : file containing all halfphone units
acousticFeatureFileWriter.waveTimeLine  : file containing all wave files


Properties for module cartBuilder:
cartBuilder.acFeatureFile        : file containing all halfphone units and their target cost features
								   plus the acoustic target cost features
cartBuilder.cartFile             : file containing the preselection CART. Will be created by this module.
*cartBuilder.estDir              : directory containing the local installation of the 
								   Edinburgh Speech Tools
cartBuilder.featureSeqFile       : file containing the feature sequence for the basic tree
*cartBuilder.maxLeafSize         : the maximum number of units in a leaf of the basic tree
cartBuilder.mcepTimeline         : file containing the mcep files
*cartBuilder.readFeatureSequence : if "true", basic tree is read from feature sequence file,
								   if "false", basic tree is read from top level tree file. 
cartBuilder.topLevelTreeFile     : file containing the basic tree
cartBuilder.unitFile             : file containing all halfphone units
cartBuilder.wagonCartFile        : file containing a CART built by wagon
cartBuilder.wagonDescFile        : file containing the descriptions for the features used for
								   building the preselection CART. Will be created by this module.
cartBuilder.wagonDir             : directory containing files needed temporarily by the module.
								   Will be created if it does not exist.
cartBuilder.wagonDisTabsFile     : file containing the acoustic distances for every unit pair that
								   is input to wagon. Will be created by this module.
cartBuilder.wagonFeatsFile       : file containing the features used for building the 
								   preselection CART. Will be created by this module.
 

Properties for module cartPruner:
cartPruner.cartFile        : file containing the preselection CART
cartPruner.logFile         : log file for this module
cartPruner.prunedCartFile  : file containing the pruned preselection CART. Will be created by this module.
cartPruner.unitFeatureFile : file containing all halfphone units and their target cost features
cartPruner.unitFile        : file containing all halfphone units
cartPruner.waveFile        : file containing all wave files


Properties for module voiceInstaller:
voiceInstaller.HalfPhoneFeatDef : file containing the list of halfphone target cost features, their values and weights
voiceInstaller.cartFile         : file containing the preselection CART
voiceInstaller.durTree          : file containing the duration CART
voiceInstaller.exampleText      : file containing example text (for limited domain voices only)
voiceInstaller.f0LeftTree       : file containing the left f0 CART
voiceInstaller.f0MidTree        : file containing the mid f0 CART
voiceInstaller.f0RightTree      : file containing the right f0 CART
voiceInstaller.halfPhoneFeatsAc : file containing all halfphone units and their target cost features
								  plus the acoustic target cost features
voiceInstaller.halfPhoneUnits   : file containing all halfphone units
voiceInstaller.joinCostFeatDef  : file containing the list of join cost weights and their weights 
voiceInstaller.joinCostFeats    : file containing all halfphone units and their join cost features
voiceInstaller.phoneFeatDef     : file containing the list of phone target cost features, their values and weights
voiceInstaller.waveTimeline     : file containing all wave files