marytts.unitselection.data

Class FeatureFileReader

java.lang.Object

marytts.unitselection.data.FeatureFileReader

Direct Known Subclasses:

HalfPhoneFeatureFileReader, VocalizationFeatureFileReader

public class FeatureFileReader
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected FeatureDefinition	featureDefinition
protected FeatureVector[]	featureVectors
protected MaryHeader	hdr

Constructor Summary

Constructors

Constructor and Description
FeatureFileReader() Empty constructor; need to call load() separately when using this.
FeatureFileReader(String fileName)

Method Summary

Modifier and Type	Method and Description
FeatureVector[]	featureVectorMapping(FeatureDefinition newFeatureDefinition) feature vector mapping according to new feature definition Note: The new feature definition should be a subset of original feature definition
FeatureVector[]	getCopyOfFeatureVectors() Return a shallow copy of the array of feature vectors.
FeatureDefinition	getFeatureDefinition()
static FeatureFileReader	getFeatureFileReader(String fileName) Get a feature file reader representing the given feature file.
FeatureVector	getFeatureVector(int unitIndex) Get the unit feature vector for the given unit index number.
FeatureVector	getFeatureVector(Unit unit) Get the unit feature vector for the given unit.
FeatureVector[]	getFeatureVectors() Return the internal array of feature vectors.
int	getNumberOfUnits()
void	load(String fileName)
protected void	loadFromByteBuffer(String fileName)
protected void	loadFromStream(String fileName)

Methods inherited from class java.lang.Object

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

Field Detail

hdr

protected MaryHeader hdr

featureDefinition

protected FeatureDefinition featureDefinition

featureVectors

protected FeatureVector[] featureVectors

Constructor Detail

FeatureFileReader

public FeatureFileReader()

Empty constructor; need to call load() separately when using this.

See Also:

load(String fileName)

FeatureFileReader

public FeatureFileReader(String fileName)
                  throws IOException,
                         MaryConfigurationException

Throws:

IOException

MaryConfigurationException

Method Detail

getFeatureFileReader

public static FeatureFileReader getFeatureFileReader(String fileName)
                                              throws IOException,
                                                     MaryConfigurationException

Get a feature file reader representing the given feature file.

Parameters:

fileName - the filename of a valid feature file.

Returns:

a feature file object representing the given file.

Throws:

IOException - if there was a problem reading the file

MaryConfigurationException - if the file is not a valid feature file.

load

public void load(String fileName)
          throws IOException,
                 MaryConfigurationException

Throws:

IOException

MaryConfigurationException

loadFromStream

protected void loadFromStream(String fileName)
                       throws IOException,
                              MaryConfigurationException

Throws:

IOException

MaryConfigurationException

loadFromByteBuffer

protected void loadFromByteBuffer(String fileName)
                           throws IOException,
                                  MaryConfigurationException

Throws:

IOException

MaryConfigurationException

getFeatureVector

public FeatureVector getFeatureVector(int unitIndex)

Get the unit feature vector for the given unit index number.

Parameters:

unitIndex - the absolute index number of a unit in the database

Returns:

the corresponding feature vector

getCopyOfFeatureVectors

public FeatureVector[] getCopyOfFeatureVectors()

Return a shallow copy of the array of feature vectors.

Returns:

a new array containing the internal feature vectors

getFeatureVectors

public FeatureVector[] getFeatureVectors()

Return the internal array of feature vectors.

Returns:

the internal array of feature vectors.

featureVectorMapping

public FeatureVector[] featureVectorMapping(FeatureDefinition newFeatureDefinition)

feature vector mapping according to new feature definition Note: The new feature definition should be a subset of original feature definition

Parameters:

newFeatureDefinition - newFeatureDefinition

Returns:

newFV

getFeatureVector

public FeatureVector getFeatureVector(Unit unit)

Get the unit feature vector for the given unit.

Parameters:

unit - a unit in the database

Returns:

the corresponding feature vector

getFeatureDefinition

public FeatureDefinition getFeatureDefinition()

getNumberOfUnits

public int getNumberOfUnits()