marytts.vocalizations

Class VocalizationUnitFileReader

java.lang.Object

marytts.vocalizations.VocalizationUnitFileReader

public class VocalizationUnitFileReader
extends Object

Loads a unit file in memory and provides accessors to the start times and durations.

Author:

sathish pammi

Constructor Summary

Constructors

Constructor and Description
VocalizationUnitFileReader() Empty constructor; need to call load() separately.
VocalizationUnitFileReader(String fileName) Create a unit file reader from the given unit file

Method Summary

Methods

Modifier and Type	Method and Description
VocalizationUnit	getNextUnit(VocalizationUnit u) Return the unit following the given unit in the original database.
int	getNumberOfUnits() Get the number of units in the file.
VocalizationUnit	getPreviousUnit(VocalizationUnit u) Return the unit preceding the given unit in the original database.
int	getSampleRate() Get the sample rate of the file.
VocalizationUnit	getUnit(int i) Return the unit number i.
VocalizationUnit[]	getUnit(int[] i) Return an array of units from their indexes.
boolean	isEdgeUnit(int i) Determine whether the unit number i is an "edge" unit, i.e.
void	load(String fileName) Load the given unit file
static void	main(String[] args)

Methods inherited from class java.lang.Object

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

Constructor Detail

VocalizationUnitFileReader

public VocalizationUnitFileReader()

Empty constructor; need to call load() separately.

See Also:

load(String)

VocalizationUnitFileReader

public VocalizationUnitFileReader(String fileName)
                           throws IOException,
                                  MaryConfigurationException

Create a unit file reader from the given unit file

Parameters:

fileName - the unit file to read

Throws:

IOException - if a problem occurs while reading

MaryConfigurationException - MaryConfigurationException

Method Detail

load

public void load(String fileName)
          throws IOException,
                 MaryConfigurationException

Load the given unit file

Parameters:

fileName - the unit file to read

Throws:

IOException - if a problem occurs while reading

MaryConfigurationException - MaryConfigurationException

getNumberOfUnits

public int getNumberOfUnits()

Get the number of units in the file.

Returns:

The number of units.

getSampleRate

public int getSampleRate()

Get the sample rate of the file.

Returns:

The sample rate, in Hz.

getUnit

public VocalizationUnit getUnit(int i)

Return the unit number i.

Parameters:

i - The index of the considered unit.

Returns:

The considered unit.

getUnit

public VocalizationUnit[] getUnit(int[] i)

Return an array of units from their indexes.

Parameters:

i - The indexes of the considered units.

Returns:

The array of considered units.

getNextUnit

public VocalizationUnit getNextUnit(VocalizationUnit u)

Return the unit following the given unit in the original database.

Parameters:

u - a unit

Returns:

the next unit in the database, or null if there is no such unit.

getPreviousUnit

public VocalizationUnit getPreviousUnit(VocalizationUnit u)

Return the unit preceding the given unit in the original database.

Parameters:

u - a unit

Returns:

the previous unit in the database, or null if there is no such unit.

isEdgeUnit

public boolean isEdgeUnit(int i)

Determine whether the unit number i is an "edge" unit, i.e. a unit marking the start or the end of an utterance.

Parameters:

i - The index of the considered unit.

Returns:

true if the unit is an edge unit in the unit file, false otherwise

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception