marytts.unitselection.select

Class JoinCostFeatures

java.lang.Object

marytts.unitselection.select.JoinCostFeatures

All Implemented Interfaces:

JoinCostFunction

public class JoinCostFeatures
extends Object
implements JoinCostFunction

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JoinCostFeatures.JoinCostReporter

Field Summary

Fields

Modifier and Type	Field and Description
protected double[]	cumulWeightedSignalCosts
protected boolean	debugShowCostGraph
protected JoinCostFeatures.JoinCostReporter	jcr
protected int	nCostComputations
protected PrecompiledJoinCostReader	precompiledCosts
protected float	wPhonetic
protected float	wSignal

Constructor Summary

Constructors

Constructor and Description
JoinCostFeatures() Empty constructor; when using this, call load() separately to initialise this class.
JoinCostFeatures(String fileName) Constructor which read a Mary Join Cost file.

Method Summary

Methods

Modifier and Type	Method and Description
double	cost(int u1, int u2) Deliver the join cost between two units described by their index.
protected double	cost(Target t1, Target t2) Deprecated.
double	cost(Target t1, Unit u1, Target t2, Unit u2) A combined cost computation, as a weighted sum of the signal-based cost (computed from the units) and the phonetics-based cost (computed from the targets).
float[]	getLeftJCF(int u) Gets the array of left join cost features for a particular unit index.
int	getNumberOfFeatures() Get the number of feature weights and weighting functions.
int	getNumberOfUnits() Get the number of units.
float[]	getRightJCF(int u) Gets the array of right join cost features for a particular unit index.
void	init(String configPrefix) Initialise this join cost function by reading the appropriate settings from the MaryProperties using the given configPrefix.
void	load(String joinFileName, InputStream weightStream, String precompiledCostFileName, float wSignal) Load weights and values from the given file
static Object[]	readJoinCostWeightsFile(String fileName) Read the join cost weight specifications from the given file.
static Object[]	readJoinCostWeightsStream(InputStream weightStream) Read the join cost weight specifications from the given file.

Methods inherited from class java.lang.Object

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

Field Detail

wSignal

protected float wSignal

wPhonetic

protected float wPhonetic

debugShowCostGraph

protected boolean debugShowCostGraph

cumulWeightedSignalCosts

protected double[] cumulWeightedSignalCosts

nCostComputations

protected int nCostComputations

precompiledCosts

protected PrecompiledJoinCostReader precompiledCosts

jcr

protected JoinCostFeatures.JoinCostReporter jcr

Constructor Detail

JoinCostFeatures

public JoinCostFeatures()

Empty constructor; when using this, call load() separately to initialise this class.

See Also:

load(String joinFileName, InputStream weightStream, String precompiledCostFileName, float wSignal)

JoinCostFeatures

public JoinCostFeatures(String fileName)
                 throws IOException,
                        MaryConfigurationException

Constructor which read a Mary Join Cost file.

Parameters:

fileName - fileName

Throws:

IOException - IOException

MaryConfigurationException - MaryConfigurationException

Method Detail

init

public void init(String configPrefix)
          throws MaryConfigurationException

Initialise this join cost function by reading the appropriate settings from the MaryProperties using the given configPrefix.

Specified by:

init in interface JoinCostFunction

Parameters:

configPrefix - the prefix for the (voice-specific) config entries to use when looking up files to load.

Throws:

MaryConfigurationException - MaryConfigurationException

load

public void load(String joinFileName,
        InputStream weightStream,
        String precompiledCostFileName,
        float wSignal)
          throws IOException,
                 MaryConfigurationException

Load weights and values from the given file

Specified by:

load in interface JoinCostFunction

Parameters:

joinFileName - the file from which to read default weights and join cost features

weightStream - an optional file from which to read weights, taking precedence over

precompiledCostFileName - an optional file containing precompiled join costs

wSignal - Relative weight of the signal-based join costs relative to the phonetic join costs computed from the target

Throws:

IOException - IOException

MaryConfigurationException - MaryConfigurationException

readJoinCostWeightsFile

public static Object[] readJoinCostWeightsFile(String fileName)
                                        throws IOException,
                                               FileNotFoundException

Read the join cost weight specifications from the given file. The weights will be normalized such that they sum to one.

Parameters:

fileName - the text file containing the join weights

Returns:

readJoinCostWeightsStream(new FileInputStream(fileName))

Throws:

IOException - IOException

FileNotFoundException - FileNotFoundException

readJoinCostWeightsStream

public static Object[] readJoinCostWeightsStream(InputStream weightStream)
                                          throws IOException,
                                                 FileNotFoundException

Read the join cost weight specifications from the given file. The weights will be normalized such that they sum to one.

Parameters:

weightStream - the text file containing the join weights

Returns:

Object[] { fw, wfun }

Throws:

IOException - IOException

FileNotFoundException - FileNotFoundException

getNumberOfFeatures

public int getNumberOfFeatures()

Get the number of feature weights and weighting functions.

Returns:

(featureWeight.length)

getNumberOfUnits

public int getNumberOfUnits()

Get the number of units.

Returns:

(leftJCF.length)

getLeftJCF

public float[] getLeftJCF(int u)

Gets the array of left join cost features for a particular unit index.

Parameters:

u - The index of the considered unit.

Returns:

The array of left join cost features for the given unit.

getRightJCF

public float[] getRightJCF(int u)

Gets the array of right join cost features for a particular unit index.

Parameters:

u - The index of the considered unit.

Returns:

The array of right join cost features for the given unit.

cost

public double cost(int u1,
          int u2)

Deliver the join cost between two units described by their index.

Parameters:

u1 - the left unit

u2 - the right unit

Returns:

the cost of joining the right Join Cost features of the left unit with the left Join Cost Features of the right unit.

cost

public double cost(Target t1,
          Unit u1,
          Target t2,
          Unit u2)

A combined cost computation, as a weighted sum of the signal-based cost (computed from the units) and the phonetics-based cost (computed from the targets).

Specified by:

cost in interface JoinCostFunction

Parameters:

t1 - The left target.

u1 - The left unit.

t2 - The right target.

u2 - The right unit.

Returns:

the cost of joining the left unit with the right unit, as a non-negative value.

cost

protected double cost(Target t1,
          Target t2)

Deprecated.

A phonetic join cost, computed solely from the target.

Parameters:

t1 - the left target

t2 - the right target

Returns:

a non-negative join cost, usually between 0 (best) and 1 (worst).