F0SoPTrainer (MaryTTS 5.2 API)

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

```
public class F0SoPTrainer
extends VoiceImportComponent
```
Example of how to use SoP modules in a voice configuration file: #Modules to use for predicting acoustic target features for this voice: #this are the names that will be used to identify diferent models of the same type, sop, cart or hmm voice.cmu-slt-hsmm.acousticModels = duration F0 midF0 rightF0 voice.cmu-slt-hsmm.duration.model = sop voice.cmu-slt-hsmm.duration.data = MARY_BASE/lib/voices/cmu-slt-hsmm/dur.sop voice.cmu-slt-hsmm.duration.attribute = d voice.cmu-slt-hsmm.leftF0.model = sop voice.cmu-slt-hsmm.leftF0.data = MARY_BASE/lib/voices/cmu-slt-hsmm/f0.left.sop voice.cmu-slt-hsmm.leftF0.attribute = f0 voice.cmu-slt-hsmm.leftF0.attribute.format = (0,%.0f) voice.cmu-slt-hsmm.midF0.model = sop voice.cmu-slt-hsmm.midF0.data = MARY_BASE/lib/voices/cmu-slt-hsmm/f0.mid.sop voice.cmu-slt-hsmm.midF0.attribute = f0 voice.cmu-slt-hsmm.midF0.attribute.format = (50,%.0f) voice.cmu-slt-hsmm.rightF0.model = sop voice.cmu-slt-hsmm.rightF0.data = MARY_BASE/lib/voices/cmu-slt-hsmm/f0.right.sop voice.cmu-slt-hsmm.rightF0.attribute = f0 voice.cmu-slt-hsmm.rightF0.attribute.format = (100,%.0f)

Author:

marcela

Field Summary

Fields
Modifier and Type	Field and Description
`protected DatabaseLayout`	`db`
`protected File`	`f0Dir`
`String`	`F0LeftSoPFILE`
`String`	`F0MidSoPFILE`
`String`	`F0RightSoPFILE`
`String`	`FEATUREDIR`
`protected String`	`featureExt`
`String`	`FEATUREFILE`
`protected boolean`	`interceptTerm`
`String`	`LABELDIR`
`protected String`	`labelExt`
`protected String`	`leftF0FeaturesFileName`
`protected File`	`leftSoPFile`
`protected boolean`	`logF0`
`protected String`	`midF0FeaturesFileName`
`protected File`	`midSoPFile`
`protected int`	`percent`
`protected String`	`rightF0FeaturesFileName`
`protected File`	`rightSoPFile`
`protected int`	`solutionSize`
`protected boolean`	`success`
`String`	`UNITFILE`
`String`	`WAVETIMELINE`

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

Constructor Summary

Constructors
Constructor and Description

F0SoPTrainer()

Constructors
Constructor and Description
`F0SoPTrainer()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`compute()` Do the computations required by this component.
`SortedMap<String,String>`	`getDefaultProps(DatabaseLayout dbl)` 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
`static void`	`main(String[] args)`
`String[]`	`selectLinguisticFactors(String featureNames, String label)`
`protected void`	`setSuccess(boolean val)`
`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
  - f0Dir
```
protected File f0Dir
```
  - leftF0FeaturesFileName
```
protected String leftF0FeaturesFileName
```
  - midF0FeaturesFileName
```
protected String midF0FeaturesFileName
```
  - rightF0FeaturesFileName
```
protected String rightF0FeaturesFileName
```
  - leftSoPFile
```
protected File leftSoPFile
```
  - midSoPFile
```
protected File midSoPFile
```
  - rightSoPFile
```
protected File rightSoPFile
```
  - featureExt
```
protected String featureExt
```
  - labelExt
```
protected String labelExt
```
  - db
```
protected DatabaseLayout db
```
  - percent
```
protected int percent
```
  - success
```
protected boolean success
```
  - interceptTerm
```
protected boolean interceptTerm
```
  - logF0
```
protected boolean logF0
```
  - solutionSize
```
protected int solutionSize
```
  - FEATUREFILE
```
public final String FEATUREFILE
```
    See Also:
    Constant Field Values
  - UNITFILE
```
public final String UNITFILE
```
    See Also:
    Constant Field Values
  - WAVETIMELINE
```
public final String WAVETIMELINE
```
    See Also:
    Constant Field Values
  - LABELDIR
```
public final String LABELDIR
```
    See Also:
    Constant Field Values
  - FEATUREDIR
```
public final String FEATUREDIR
```
    See Also:
    Constant Field Values
  - F0LeftSoPFILE
```
public final String F0LeftSoPFILE
```
    See Also:
    Constant Field Values
  - F0MidSoPFILE
```
public final String F0MidSoPFILE
```
    See Also:
    Constant Field Values
  - F0RightSoPFILE
```
public final String F0RightSoPFILE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - F0SoPTrainer
```
public F0SoPTrainer()
```
- 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
  - initialiseComp
```
protected 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
  - getDefaultProps
```
public SortedMap<String,String> getDefaultProps(DatabaseLayout dbl)
```
    Description copied from class: VoiceImportComponent
    
    Get the map of properties2values containing the default values
    
    Specified by:
    
    getDefaultProps in class VoiceImportComponent
    
    Parameters:
    dbl - db
    
    Returns:
    map of props2values
  - setupHelp
```
protected void setupHelp()
```
    Specified by:
    
    setupHelp in class VoiceImportComponent
  - compute
```
public boolean compute()
                throws Exception
```
    Description copied from class: VoiceImportComponent
    
    Do the computations required by this component.
    
    Specified by:
    
    compute in class VoiceImportComponent
    
    Returns:
    true on success, false on failure
    
    Throws:
    
    Exception - Exception
  - selectLinguisticFactors
```
public String[] selectLinguisticFactors(String featureNames,
                               String label)
                                 throws IOException
```
    Throws:
    
    IOException
  - setSuccess
```
protected void setSuccess(boolean val)
```
  - 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.
  - main
```
public static void main(String[] args)
                 throws Exception
```
    Throws:
    
    Exception

Class F0SoPTrainer

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

f0Dir

leftF0FeaturesFileName

midF0FeaturesFileName

rightF0FeaturesFileName

leftSoPFile

midSoPFile

rightSoPFile

featureExt

labelExt

db

percent

success

interceptTerm

logF0

solutionSize

FEATUREFILE

UNITFILE

WAVETIMELINE

LABELDIR

FEATUREDIR

F0LeftSoPFILE

F0MidSoPFILE

F0RightSoPFILE

Constructor Detail

F0SoPTrainer

Method Detail

getName

initialiseComp

getDefaultProps

setupHelp

compute

selectLinguisticFactors

setSuccess

getProgress

main