marytts.unitselection.select

Class DiphoneFFRTargetCostFunction

java.lang.Object

marytts.unitselection.select.DiphoneFFRTargetCostFunction

All Implemented Interfaces:

TargetCostFunction

public class DiphoneFFRTargetCostFunction
extends Object
implements TargetCostFunction

Field Summary

Fields

Modifier and Type	Field and Description
protected FFRTargetCostFunction	tcfForHalfphones

Constructor Summary

Constructors

Constructor and Description
DiphoneFFRTargetCostFunction()

Method Summary

Methods

Modifier and Type	Method and Description
void	computeTargetFeatures(Target target) Compute the features for a given target, and store them in the target.
double	cost(Target target, Unit unit) Compute the goodness-of-fit of a given unit for a given target.
String	getFeature(Unit unit, String featureName) Get the string representation of the feature value associated with the given unit
FeatureDefinition	getFeatureDefinition() Provide access to the Feature Definition used.
FeatureVector	getFeatureVector(Unit unit) Get the target cost feature vector for the given unit.
FeatureVector[]	getFeatureVectors() Get all feature vectors.
void	load(FeatureFileReader ffr, InputStream weightsStream, FeatureProcessorManager featProc) Initialise the data needed to do a target cost computation.
void	load(String featureFileName, InputStream weightsStream, FeatureProcessorManager featProc) Initialise the data needed to do a target cost computation.

Methods inherited from class java.lang.Object

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

Field Detail

tcfForHalfphones

protected FFRTargetCostFunction tcfForHalfphones

Constructor Detail

DiphoneFFRTargetCostFunction

public DiphoneFFRTargetCostFunction()

Method Detail

load

public void load(String featureFileName,
        InputStream weightsStream,
        FeatureProcessorManager featProc)
          throws IOException,
                 MaryConfigurationException

Initialise the data needed to do a target cost computation.

Specified by:

load in interface TargetCostFunction

Parameters:

featureFileName - name of a file containing the unit features

weightsStream - an optional weights file -- if non-null, contains feature weights that override the ones present in the feature file.

featProc - a feature processor manager which can provide feature processors to compute the features for a target at run time

Throws:

IOException - IOException

MaryConfigurationException - if a configuration problem is detected while loading the data

load

public void load(FeatureFileReader ffr,
        InputStream weightsStream,
        FeatureProcessorManager featProc)
          throws IOException

Description copied from interface: TargetCostFunction

Initialise the data needed to do a target cost computation.

Specified by:

load in interface TargetCostFunction

Parameters:

ffr - a reader for the file containing the unit features

weightsStream - an optional weights file -- if non-null, contains feature weights that override the ones present in the feature file.

featProc - a feature processor manager which can provide feature processors to compute the features for a target at run time

Throws:

IOException - IOException

getFeatureDefinition

public FeatureDefinition getFeatureDefinition()

Provide access to the Feature Definition used.

Specified by:

getFeatureDefinition in interface TargetCostFunction

Returns:

the feature definition object.

getFeature

public String getFeature(Unit unit,
                String featureName)

Get the string representation of the feature value associated with the given unit

Specified by:

getFeature in interface TargetCostFunction

Parameters:

unit - the unit whose feature value is requested

featureName - name of the feature requested

Returns:

a string representation of the feature value

Throws:

IllegalArgumentException - if featureName is not a known feature

getFeatureVector

public FeatureVector getFeatureVector(Unit unit)

Description copied from interface: TargetCostFunction

Get the target cost feature vector for the given unit.

Specified by:

getFeatureVector in interface TargetCostFunction

Parameters:

unit - unit

Returns:

the feature vector

cost

public double cost(Target target,
          Unit unit)

Compute the goodness-of-fit of a given unit for a given target.

Specified by:

cost in interface TargetCostFunction

Parameters:

target - target

unit - unit

Returns:

a non-negative number; smaller values mean better fit, i.e. smaller cost.

computeTargetFeatures

public void computeTargetFeatures(Target target)

Compute the features for a given target, and store them in the target.

Specified by:

computeTargetFeatures in interface TargetCostFunction

Parameters:

target - the target for which to compute the features

See Also:

Target.getFeatureVector()

getFeatureVectors

public FeatureVector[] getFeatureVectors()

Description copied from interface: TargetCostFunction

Get all feature vectors. This is useful for more efficient access.

Specified by:

getFeatureVectors in interface TargetCostFunction

Returns:

the full array of feature vectors, or null if this method is not supported.