HTKLabeler (MaryTTS 5.2 API)

java.lang.Object
- marytts.tools.voiceimport.VoiceImportComponent
- - marytts.tools.voiceimport.HTKLabeler

```
public class HTKLabeler
extends VoiceImportComponent
```
Automatic Labelling using HTK labeller

Author:

Sathish Chandra Pammi, Fabio Tesser Fabio Tesser has fixed some HTK procedures and he has added the managing of virtual pauses (so called short pauses) after every word. These pauses if detected will notified and it should be check if necessary to force the punctuation on the original text phrase in order to have a more coherent prosody. Moreover in the initial phase, 1 mixture is used for each status; then the mixtures number is iteratively increased until a specific likelihood threshold is reached

Field Summary

Fields
Modifier and Type	Field and Description
`protected AllophoneSet`	`allophoneSet`
`String`	`AWK`
`protected Map<String,TreeMap<String,String>>`	`dictionary`
`String`	`HTDIR`
`String`	`HTKDIR`
`protected String`	`labExt`
`protected MaryClient`	`mary`
`protected String`	`maryInputType`
`protected String`	`maryOutputType`
`protected int`	`MAX_ITERATIONS`
`protected int`	`MAX_MIX_ITERATION`
`protected int`	`MAX_SP_ITERATION`
`protected int`	`MAX_VP_ITERATION`
`String`	`MAXITER`
`String`	`MAXSPITER`
`protected int`	`noIterCompleted`
`String`	`OUTLABDIR`
`protected int`	`percent`
`String`	`PROMPTALLOPHONESDIR`
`protected File`	`promtallophonesDir`
`protected String`	`xmlExt`

Fields inherited from class marytts.tools.voiceimport.VoiceImportComponent
bnl, logger, props, props2Help

Constructor Summary

Constructors
Constructor and Description

HTKLabeler()

Constructors
Constructor and Description
`HTKLabeler()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`compute()` Do the computations required by this component.
`SortedMap`	`getDefaultProps(DatabaseLayout db)` Get the map of properties2values containing the default values
`static String`	`getMaryXMLHeaderWithInitialBoundary(String locale)` Converting text to RAWMARYXML with Locale
`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.
`void`	`initialiseComp()` Initialise a voice import component: component specific initialisation; to be overwritten by subclasses
`String`	`replaceBackTrickyPhones(String lab)` Translation table for labels which are incompatible with HTK or shell filenames See common_routines.pl in HTS training.
`String`	`replaceTrickyPhones(String lab)` Translation table for labels which are incompatible with HTK or shell filenames See common_routines.pl in HTS training.
`protected void`	`setupHelp()`

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
  - xmlExt
```
protected String xmlExt
```
  - labExt
```
protected String labExt
```
  - mary
```
protected MaryClient mary
```
  - maryInputType
```
protected String maryInputType
```
  - maryOutputType
```
protected String maryOutputType
```
  - percent
```
protected int percent
```
  - promtallophonesDir
```
protected File promtallophonesDir
```
  - dictionary
```
protected Map<String,TreeMap<String,String>> dictionary
```
  - allophoneSet
```
protected AllophoneSet allophoneSet
```
  - MAX_ITERATIONS
```
protected int MAX_ITERATIONS
```
  - MAX_SP_ITERATION
```
protected int MAX_SP_ITERATION
```
  - MAX_VP_ITERATION
```
protected int MAX_VP_ITERATION
```
  - MAX_MIX_ITERATION
```
protected int MAX_MIX_ITERATION
```
  - noIterCompleted
```
protected int noIterCompleted
```
  - HTDIR
```
public final String HTDIR
```
    See Also:
    Constant Field Values
  - HTKDIR
```
public final String HTKDIR
```
    See Also:
    Constant Field Values
  - OUTLABDIR
```
public final String OUTLABDIR
```
    See Also:
    Constant Field Values
  - MAXITER
```
public final String MAXITER
```
    See Also:
    Constant Field Values
  - PROMPTALLOPHONESDIR
```
public String PROMPTALLOPHONESDIR
```
  - MAXSPITER
```
public String MAXSPITER
```
  - AWK
```
public final String AWK
```
    See Also:
    Constant Field Values
- Constructor Detail
  - HTKLabeler
```
public HTKLabeler()
```
- Method Detail
  - getName
```
public final String getName()
```
    Description copied from class: VoiceImportComponent
    
    Get the name of this component
    
    Specified by:
    
    getName in class VoiceImportComponent
    
    Returns:
    the name
  - getDefaultProps
```
public SortedMap getDefaultProps(DatabaseLayout db)
```
    Description copied from class: VoiceImportComponent
    
    Get the map of properties2values containing the default values
    
    Specified by:
    
    getDefaultProps in class VoiceImportComponent
    
    Parameters:
    db - db
    
    Returns:
    map of props2values
  - setupHelp
```
protected void setupHelp()
```
    Specified by:
    
    setupHelp in class VoiceImportComponent
  - initialiseComp
```
public void initialiseComp()
```
    Description copied from class: VoiceImportComponent
    
    Initialise a voice import component: component specific initialisation; to be overwritten by subclasses
    
    Overrides:
    
    initialiseComp in class VoiceImportComponent
  - compute
```
public boolean compute()
                throws Exception
```
    Do the computations required by this component.
    
    Specified by:
    
    compute in class VoiceImportComponent
    
    Returns:
    true on success, false on failure
    
    Throws:
    
    Exception - Exception
  - getMaryXMLHeaderWithInitialBoundary
```
public static String getMaryXMLHeaderWithInitialBoundary(String locale)
```
    Converting text to RAWMARYXML with Locale
    
    Parameters:
    locale - locale
    
    Returns:
    "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n" + "<maryxml version=\"0.4\"\n" + "xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n" + "xmlns=\"http://mary.dfki.de/2002/MaryXML\"\n" + "xml:lang=\"" + locale + "\">\n" + "<boundary duration=\"100\"/>\n"
  - 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.
  - replaceTrickyPhones
```
public String replaceTrickyPhones(String lab)
```
    Translation table for labels which are incompatible with HTK or shell filenames See common_routines.pl in HTS training.
    
    Parameters:
    lab - lab
    
    Returns:
    String
  - replaceBackTrickyPhones
```
public String replaceBackTrickyPhones(String lab)
```
    Translation table for labels which are incompatible with HTK or shell filenames See common_routines.pl in HTS training. In this function the phones as used internally in HTSEngine are changed back to the Mary TTS set, this function is necessary when correcting the actual durations of AcousticPhonemes.
    
    Parameters:
    lab - lab
    
    Returns:
    String

Class HTKLabeler

Field Summary

Fields inherited from class marytts.tools.voiceimport.VoiceImportComponent

Constructor Summary

Method Summary

Methods inherited from class marytts.tools.voiceimport.VoiceImportComponent

Methods inherited from class java.lang.Object

Field Detail

xmlExt

labExt

mary

maryInputType

maryOutputType

percent

promtallophonesDir

dictionary

allophoneSet

MAX_ITERATIONS

MAX_SP_ITERATION

MAX_VP_ITERATION

MAX_MIX_ITERATION

noIterCompleted

HTDIR

HTKDIR

OUTLABDIR

MAXITER

PROMPTALLOPHONESDIR

MAXSPITER

AWK

Constructor Detail

HTKLabeler

Method Detail

getName

getDefaultProps

setupHelp

initialiseComp

compute

getMaryXMLHeaderWithInitialBoundary

getProgress

replaceTrickyPhones

replaceBackTrickyPhones