marytts.util.data.text

Class PraatInterval

java.lang.Object

marytts.util.data.text.PraatInterval

public class PraatInterval
extends Object

Basic data unit of an IntervalTier in a Praat TextGrid. Every interval has a start and an end time, as well as a label.

Author:

steiner

Constructor Summary

Constructors

Constructor and Description
PraatInterval(double duration) constructor for underspecified interval from duration, with empty label; start and end times are filled in later, when interval is one of many
PraatInterval(double xmin, double xmax) constructor from start and end times, with empty label
PraatInterval(double xmin, double xmax, String text) constructor from start and end times and label
PraatInterval(double duration, String text) constructor for underspecified interval from duration and label; start and end times are filled in later, when interval is one of many

Method Summary

Methods

Modifier and Type	Method and Description
double	getDuration() getter for duration of interval
String	getText() getter for label String of interval; should not be null
double	getXmax() getter for end time of interval
double	getXmin() getter for start time of interval
boolean	isComplete() determine if interval is fully specified
void	setDuration(double duration) set duration of interval
void	setText(String text) set label String of interval
void	setXmax(double xmax) set end time of interval
void	setXmin(double xmin) set start time of interval
String	toString() string representation of interval, used for TextGrid output
void	updateDuration() recalculate and set duration based on current start and end times

Methods inherited from class java.lang.Object

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

Constructor Detail

PraatInterval

public PraatInterval(double xmin,
             double xmax)

constructor from start and end times, with empty label

Parameters:

xmin - start time of interval

xmax - end time of interval

PraatInterval

public PraatInterval(double xmin,
             double xmax,
             String text)

constructor from start and end times and label

Parameters:

xmin - start time of interval

xmax - end time of interval

text - label of interval

PraatInterval

public PraatInterval(double duration)

constructor for underspecified interval from duration, with empty label; start and end times are filled in later, when interval is one of many

Parameters:

duration - of interval

PraatInterval

public PraatInterval(double duration,
             String text)

constructor for underspecified interval from duration and label; start and end times are filled in later, when interval is one of many

Parameters:

duration - of interval

text - label of interval

Method Detail

getXmin

public double getXmin()

getter for start time of interval

Returns:

start time as double

getXmax

public double getXmax()

getter for end time of interval

Returns:

end time as double

getText

public String getText()

getter for label String of interval; should not be null

Returns:

label as String

getDuration

public double getDuration()

getter for duration of interval

Returns:

duration of interval as double

setXmin

public void setXmin(double xmin)

set start time of interval

Parameters:

xmin - new start time

setXmax

public void setXmax(double xmax)

set end time of interval

Parameters:

xmax - new end time

setText

public void setText(String text)

set label String of interval

Parameters:

text - new label

setDuration

public void setDuration(double duration)
                 throws IllegalArgumentException

set duration of interval

Parameters:

duration - duration

Throws:

IllegalArgumentException - if duration is negative

updateDuration

public void updateDuration()

recalculate and set duration based on current start and end times

isComplete

public boolean isComplete()

determine if interval is fully specified

Returns:

true if both start and end time are set; false otherwise

toString

public String toString()

string representation of interval, used for TextGrid output

Overrides:

toString in class Object