HMMData (MaryTTS 5.2 API)

java.lang.Object
- marytts.htsengine.HMMData

```
public class HMMData
extends Object
```
Configuration files and global variables for HTS engine. Java port and extension of HTS engine API version 1.04 Extension: mixed excitation

Author:

Marcela Charfuelan

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HMMData.FeatureType

static class HMMData.PdfFileFormat

Nested Classes
Modifier and Type	Class and Description
`static class`	`HMMData.FeatureType`
`static class`	`HMMData.PdfFileFormat`

Field Summary

Fields
Modifier and Type Field and Description

static int HTS_NUMMTYPE
Number of model and identificator for the models

Fields
Modifier and Type	Field and Description
`static int`	`HTS_NUMMTYPE` Number of model and identificator for the models

Constructor Summary

Constructors
Constructor and Description

HMMData()

Constructors
Constructor and Description
`HMMData()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`getAlgnph()`
`boolean`	`getAlgnst()`
`double`	`getAlpha()`
`double`	`getBeta()`
`CartTreeSet`	`getCartTreeSet()`
`double`	`getDurationScale()`
`double`	`getF0Mean()`
`double`	`getF0Std()`
`FeatureDefinition`	`getFeatureDefinition()`
`Set<HMMData.FeatureType>`	`getFeatureSet()` return the set of FeatureTypes that are available in this HMMData object
`int`	`getFperiod()`
`double`	`getGamma()`
`boolean`	`getGvMethodGradient()`
`GVModelSet`	`getGVModelSet()`
`double`	`getGvWeightLf0()`
`double`	`getGvWeightMag()`
`double`	`getGvWeightMgc()`
`double`	`getGvWeightStr()`
`double`	`getLength()`
`int`	`getMaxLf0GvIter()`
`int`	`getMaxMagGvIter()`
`int`	`getMaxMgcGvIter()`
`int`	`getMaxStrGvIter()`
`double[][]`	`getMixFilters()`
`int`	`getNumFilters()`
`int`	`getOrderFilters()`
`InputStream`	`getPdfDurStream()`
`InputStream`	`getPdfLf0GVStream()`
`InputStream`	`getPdfLf0Stream()`
`InputStream`	`getPdfMagGVStream()`
`InputStream`	`getPdfMagStream()`
`InputStream`	`getPdfMgcGVStream()`
`InputStream`	`getPdfMgcStream()`
`InputStream`	`getPdfStrGVStream()`
`InputStream`	`getPdfStrStream()`
`int`	`getRate()`
`double`	`getRho()`
`int`	`getStage()`
`InputStream`	`getSwitchGVStream()`
`InputStream`	`getTreeDurStream()`
`InputStream`	`getTreeLf0Stream()`
`InputStream`	`getTreeMagStream()`
`InputStream`	`getTreeMgcStream()`
`InputStream`	`getTreeStrStream()`
`boolean`	`getUseAcousticModels()`
`boolean`	`getUseContextDependentGV()`
`boolean`	`getUseFourierMag()`
`boolean`	`getUseGV()`
`boolean`	`getUseLogGain()`
`boolean`	`getUseMixExc()`
`double`	`getUV()`
`void`	`initHMMData(PropertiesAccessor p, String voiceName)`
`void`	`initHMMData(String voiceName)`
`void`	`initHMMData(String voiceName, String marybase, String configFile)` Reads from configuration file all the data files in this class this method is used when running HTSengine stand alone.
`void`	`initHMMDataForHMMModel(String voiceName)` Reads from configuration file tree and pdf data for duration and f0 this method is used by HMMModel
`void`	`loadCartTreeSet()`
`void`	`loadGVModelSet()`
`void`	`readMixedExcitationFilters(InputStream mixFiltersStream)` Initialisation for mixed excitation : it loads the filter taps, they are read from MixFilterFile specified in the configuration file.
`void`	`setAlpha(double dval)`
`void`	`setBeta(double dval)`
`void`	`setDurationScale(double dval)`
`void`	`setF0Mean(double dval)`
`void`	`setF0Std(double dval)`
`void`	`setFperiod(int ival)`
`void`	`setGvMethod(String sval)`
`void`	`setGvWeightLf0(double dval)`
`void`	`setGvWeightMgc(double dval)`
`void`	`setGvWeightStr(double dval)`
`void`	`setLength(double dval)`
`void`	`setMaxLf0GvIter(int val)`
`void`	`setMaxMgcGvIter(int val)`
`void`	`setMaxStrGvIter(int val)`
`void`	`setNumFilters(int val)`
`void`	`setOrderFilters(int val)`
`void`	`setPdfMagStream(InputStream mag)`
`void`	`setPdfStrStream(InputStream str)`
`void`	`setRate(int ival)`
`void`	`setStage(int ival)`
`void`	`setUseAcousticModels(boolean bval)`
`void`	`setUseContextDepenendentGV(boolean bval)`
`void`	`setUseFourierMag(boolean bval)`
`void`	`setUseGV(boolean bval)`
`void`	`setUseLogGain(boolean bval)`
`void`	`setUseMixExc(boolean bval)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- HTS_NUMMTYPE
```
public static final int HTS_NUMMTYPE
```
  Number of model and identificator for the models
  
  See Also:
  Constant Field Values

Constructor Detail
- HMMData
```
public HMMData()
```

Method Detail

getRate
```
public int getRate()
```

getFperiod
```
public int getFperiod()
```

getRho
```
public double getRho()
```

getAlpha
```
public double getAlpha()
```

getBeta
```
public double getBeta()
```

getStage
```
public int getStage()
```

getGamma
```
public double getGamma()
```

getUseLogGain
```
public boolean getUseLogGain()
```

getUV
```
public double getUV()
```

getAlgnst
```
public boolean getAlgnst()
```

getAlgnph
```
public boolean getAlgnph()
```

getF0Std
```
public double getF0Std()
```

getF0Mean
```
public double getF0Mean()
```

getLength
```
public double getLength()
```

getDurationScale
```
public double getDurationScale()
```

getTreeDurStream
```
public InputStream getTreeDurStream()
```

getTreeLf0Stream
```
public InputStream getTreeLf0Stream()
```

getTreeMgcStream
```
public InputStream getTreeMgcStream()
```

getTreeStrStream
```
public InputStream getTreeStrStream()
```

getTreeMagStream
```
public InputStream getTreeMagStream()
```

getFeatureDefinition

public FeatureDefinition getFeatureDefinition()

getPdfDurStream
```
public InputStream getPdfDurStream()
```

getPdfLf0Stream
```
public InputStream getPdfLf0Stream()
```

getPdfMgcStream
```
public InputStream getPdfMgcStream()
```

getPdfStrStream
```
public InputStream getPdfStrStream()
```

getPdfMagStream
```
public InputStream getPdfMagStream()
```

getUseAcousticModels
```
public boolean getUseAcousticModels()
```

setUseAcousticModels

public void setUseAcousticModels(boolean bval)

getUseMixExc
```
public boolean getUseMixExc()
```

getUseFourierMag
```
public boolean getUseFourierMag()
```

getUseGV
```
public boolean getUseGV()
```

getUseContextDependentGV

public boolean getUseContextDependentGV()

getGvMethodGradient
```
public boolean getGvMethodGradient()
```

getMaxMgcGvIter
```
public int getMaxMgcGvIter()
```

getMaxLf0GvIter
```
public int getMaxLf0GvIter()
```

getMaxStrGvIter
```
public int getMaxStrGvIter()
```

getMaxMagGvIter
```
public int getMaxMagGvIter()
```

getGvWeightMgc
```
public double getGvWeightMgc()
```

getGvWeightLf0
```
public double getGvWeightLf0()
```

getGvWeightStr
```
public double getGvWeightStr()
```

getGvWeightMag
```
public double getGvWeightMag()
```

getPdfLf0GVStream

public InputStream getPdfLf0GVStream()

getPdfMgcGVStream

public InputStream getPdfMgcGVStream()

getPdfStrGVStream

public InputStream getPdfStrGVStream()

getPdfMagGVStream

public InputStream getPdfMagGVStream()

getSwitchGVStream

public InputStream getSwitchGVStream()

getNumFilters
```
public int getNumFilters()
```

getOrderFilters
```
public int getOrderFilters()
```

getMixFilters
```
public double[][] getMixFilters()
```

setRate
```
public void setRate(int ival)
```

setFperiod
```
public void setFperiod(int ival)
```

setAlpha
```
public void setAlpha(double dval)
```

setBeta
```
public void setBeta(double dval)
```

setStage
```
public void setStage(int ival)
```

setUseLogGain

public void setUseLogGain(boolean bval)

setF0Std
```
public void setF0Std(double dval)
```

setF0Mean
```
public void setF0Mean(double dval)
```

setLength
```
public void setLength(double dval)
```

setDurationScale

public void setDurationScale(double dval)

getCartTreeSet
```
public CartTreeSet getCartTreeSet()
```

getGVModelSet
```
public GVModelSet getGVModelSet()
```

setPdfStrStream

public void setPdfStrStream(InputStream str)

setPdfMagStream

public void setPdfMagStream(InputStream mag)

setUseMixExc

public void setUseMixExc(boolean bval)

setUseFourierMag

public void setUseFourierMag(boolean bval)

setUseGV
```
public void setUseGV(boolean bval)
```

setUseContextDepenendentGV

public void setUseContextDepenendentGV(boolean bval)

setGvMethod
```
public void setGvMethod(String sval)
```

setMaxMgcGvIter
```
public void setMaxMgcGvIter(int val)
```

setMaxLf0GvIter
```
public void setMaxLf0GvIter(int val)
```

setMaxStrGvIter
```
public void setMaxStrGvIter(int val)
```

setGvWeightMgc

public void setGvWeightMgc(double dval)

setGvWeightLf0

public void setGvWeightLf0(double dval)

setGvWeightStr

public void setGvWeightStr(double dval)

setNumFilters
```
public void setNumFilters(int val)
```

setOrderFilters
```
public void setOrderFilters(int val)
```

loadCartTreeSet

public void loadCartTreeSet()
                     throws IOException,
                            MaryConfigurationException

Throws:: IOException; MaryConfigurationException

loadGVModelSet

public void loadGVModelSet()
                    throws IOException

Throws:: IOException

initHMMData

public void initHMMData(PropertiesAccessor p,
               String voiceName)
                 throws IOException,
                        MaryConfigurationException

Throws:: IOException; MaryConfigurationException

initHMMData
```
public void initHMMData(String voiceName,
               String marybase,
               String configFile)
                 throws Exception
```
Reads from configuration file all the data files in this class this method is used when running HTSengine stand alone.

Parameters:
voiceName - voiceName
marybase - marybase
configFile - configFile

Throws:

Exception - Exception

initHMMData

public void initHMMData(String voiceName)
                 throws IOException,
                        MaryConfigurationException

Throws:: IOException; MaryConfigurationException

initHMMDataForHMMModel
```
public void initHMMDataForHMMModel(String voiceName)
                            throws IOException,
                                   MaryConfigurationException
```
Reads from configuration file tree and pdf data for duration and f0 this method is used by HMMModel

Parameters:
voiceName - voiceName

Throws:

IOException - IOException

MaryConfigurationException - MaryConfigurationException

readMixedExcitationFilters
```
public void readMixedExcitationFilters(InputStream mixFiltersStream)
                                throws IOException
```
Initialisation for mixed excitation : it loads the filter taps, they are read from MixFilterFile specified in the configuration file.

Parameters:
mixFiltersStream - mixFiltersStream

Throws:

IOException - IOException

getFeatureSet
```
public Set<HMMData.FeatureType> getFeatureSet()
```
return the set of FeatureTypes that are available in this HMMData object

Returns:
featureTypes

Class HMMData

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HTS_NUMMTYPE

Constructor Detail

HMMData

Method Detail

getRate

getFperiod

getRho

getAlpha

getBeta

getStage

getGamma

getUseLogGain

getUV

getAlgnst

getAlgnph

getF0Std

getF0Mean

getLength

getDurationScale

getTreeDurStream

getTreeLf0Stream

getTreeMgcStream

getTreeStrStream

getTreeMagStream

getFeatureDefinition

getPdfDurStream

getPdfLf0Stream

getPdfMgcStream

getPdfStrStream

getPdfMagStream

getUseAcousticModels

setUseAcousticModels

getUseMixExc

getUseFourierMag

getUseGV

getUseContextDependentGV

getGvMethodGradient

getMaxMgcGvIter

getMaxLf0GvIter

getMaxStrGvIter

getMaxMagGvIter

getGvWeightMgc

getGvWeightLf0

getGvWeightStr

getGvWeightMag

getPdfLf0GVStream

getPdfMgcGVStream

getPdfStrGVStream

getPdfMagGVStream

getSwitchGVStream

getNumFilters

getOrderFilters

getMixFilters

setRate

setFperiod

setAlpha

setBeta

setStage

setUseLogGain

setF0Std

setF0Mean

setLength

setDurationScale

getCartTreeSet

getGVModelSet

setPdfStrStream

setPdfMagStream

setUseMixExc

setUseFourierMag

setUseGV

setUseContextDepenendentGV

setGvMethod

setMaxMgcGvIter