Phone (MaryTTS 5.2 API)

java.lang.Object
- marytts.unitselection.analysis.Phone

```
public class Phone
extends Object
```
Convenience class containing the selected units and targets of a phone segment, and a host of getters to access their prosodic attributes

Author:

steiner

Constructor Summary

Constructors
Constructor and Description

Phone(SelectedUnit leftUnit, SelectedUnit rightUnit, int sampleRate)
Main constructor

Constructors
Constructor and Description
`Phone(SelectedUnit leftUnit, SelectedUnit rightUnit, int sampleRate)` Main constructor

Method Summary

Methods
Modifier and Type	Method and Description
`double[]`	`getF0Factors()` Get the F0 factor for each Datagram in this phone's left and right units
`double[]`	`getFrameDurations()` Get the durations (in seconds) of each Datagram in this phone's units
`double[]`	`getFramewiseDurationFactors()` Get the duration factors for this phone, one per datagram.
`double`	`getLeftDurationFactor()` Get the factor to convert this phone's left unit's duration into this phone's left target duration
`double[]`	`getLeftF0Factors()` Get the factors to convert each of the F0 values in this phone's left half to the corresponding target value
`HalfPhoneTarget`	`getLeftTarget()` Get the left halfphone target of this phone
`double`	`getLeftTargetDuration()` Get this phone's left target's duration (in seconds)
`double[]`	`getLeftTargetF0Values()` Get the target F0 values for this phone's left half, with one value per Datagram in the phone's left unit
`SelectedUnit`	`getLeftUnit()` Get the left selected halfphone unit of this phone
`BaseUnitConcatenator.UnitData`	`getLeftUnitData()` Get this phone's left unit's UnitData
`double`	`getLeftUnitDuration()` Get this phone's left unit's duration (in seconds)
`double[]`	`getLeftUnitFrameDurations()` Get the durations (in seconds) of each Datagram in this phone's left unit
`double[]`	`getLeftUnitFrameF0s()` Recover the F0 values from this phone's left unit's Datagrams
`Datagram[]`	`getLeftUnitFrames()` Get this phone's left unit's Datagrams
`Element`	`getMaryXMLElement()` get the MaryXML Element corresponding to this Phone's Target
`int`	`getNumberOfFrames()` Get the number of Datagrams in this phone's left and right units
`int`	`getNumberOfLeftUnitFrames()` Get the number of Datagrams in this phone's left unit
`int`	`getNumberOfRightUnitFrames()` Get the number of Datagrams in this phone's right unit
`double`	`getPredictedDuration()` Get the predicted duration of this phone (which is the sum of the left and right target's duration)
`double`	`getPredictedF0()` Get the mean target F0 for this phone
`double`	`getRealizedDuration()` Get the realized duration (in seconds) of this phone (which is the sum of the durations of the left and right units)
`double`	`getRealizedF0()` Get the realized F0 by recovering the F0 from all Datagrams in this phone and computing the mean
`double[]`	`getRealizedFrameDurations()` Get the durations (in seconds) of each Datagram in this phone's left and right units
`double`	`getRightDurationFactor()` Get the factor to convert this phone's right unit's duration into this phone's right target duration
`double[]`	`getRightF0Factors()` Get the factors to convert each of the F0 values in this phone's right half to the corresponding target value
`HalfPhoneTarget`	`getRightTarget()` Get the right halfphone target of this phone
`double`	`getRightTargetDuration()` Get this phone's right target's duration (in seconds)
`double[]`	`getRightTargetF0Values()` Get the target F0 values for this phone's right half, with one value per Datagram in the phone's right unit
`SelectedUnit`	`getRightUnit()` Get the right selected halfphone unit of this phone
`BaseUnitConcatenator.UnitData`	`getRightUnitData()` Get this phone's right unit's UnitData
`double`	`getRightUnitDuration()` Get this phone's right unit's duration (in seconds)
`double[]`	`getRightUnitFrameDurations()` Get the durations (in seconds) of each Datagram in this phone's right unit
`double[]`	`getRightUnitFrameF0s()` Recover the F0 values from this phone's right unit's Datagrams
`Datagram[]`	`getRightUnitFrames()` Get this phone's right unit's Datagrams
`double[]`	`getTargetF0Values()` Get the target F0 values for this phone, with one value per Datagram in the phone's left and right units
`Datagram[]`	`getUnitDataFrames()` Get all Datagrams in this phone's units
`double[]`	`getUnitFrameF0s()` Recover the F0 values from each Datagram in this phone's left and right units
`boolean`	`isTransient()` Determine whether this is a transient phone (i.e.
`boolean`	`isVoiced()` Determine whether this is a voiced phone
`void`	`setLeftTargetF0Values(double[] f0TargetValues)` Set the target F0 values of this phone's left half, with one value per Datagram in the phone's left unit
`void`	`setRightTargetF0Values(double[] f0TargetValues)` Set the target F0 values of this phone's right half, with one value per Datagram in the phone's right unit
`String`	`toString()` for debugging, provide the names of the left and right targets as the string representation of this class

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Phone
```
public Phone(SelectedUnit leftUnit,
     SelectedUnit rightUnit,
     int sampleRate)
      throws IllegalArgumentException
```
    Main constructor
    
    Parameters:
    leftUnit - which can be null
    rightUnit - which can be null
    sampleRate - of the TimelineReader containing the SelectedUnits, needed to provide duration information
    
    Throws:
    
    IllegalArgumentException - if both the left and right units are null
- Method Detail
  - getLeftUnit
```
public SelectedUnit getLeftUnit()
```
    Get the left selected halfphone unit of this phone
    
    Returns:
    the left unit, or null if there is no left unit
  - getRightUnit
```
public SelectedUnit getRightUnit()
```
    Get the right selected halfphone unit of this phone
    
    Returns:
    the right unit, or null if there is no right unit
  - getLeftTarget
```
public HalfPhoneTarget getLeftTarget()
```
    Get the left halfphone target of this phone
    
    Returns:
    the left target, or null if there is no left target
  - getRightTarget
```
public HalfPhoneTarget getRightTarget()
```
    Get the right halfphone target of this phone
    
    Returns:
    the right target, or null if there is no right target
  - getLeftUnitFrames
```
public Datagram[] getLeftUnitFrames()
```
    Get this phone's left unit's Datagrams
    
    Returns:
    the left unit's Datagrams in an array, or null if there is no left unit
  - getRightUnitFrames
```
public Datagram[] getRightUnitFrames()
```
    Get this phone's right unit's Datagrams
    
    Returns:
    the right unit's Datagrams in an array, or null if there is no right unit
  - getUnitDataFrames
```
public Datagram[] getUnitDataFrames()
```
    Get all Datagrams in this phone's units
    
    Returns:
    the left and right unit's Datagrams in an array
  - getNumberOfLeftUnitFrames
```
public int getNumberOfLeftUnitFrames()
```
    Get the number of Datagrams in this phone's left unit
    
    Returns:
    the number of Datagrams in the left unit, or 0 if there is no left unit
  - getNumberOfRightUnitFrames
```
public int getNumberOfRightUnitFrames()
```
    Get the number of Datagrams in this phone's right unit
    
    Returns:
    the number of Datagrams in the right unit, or 0 if there is no right unit
  - getNumberOfFrames
```
public int getNumberOfFrames()
```
    Get the number of Datagrams in this phone's left and right units
    
    Returns:
    the number of Datagrams in this phone
  - getFrameDurations
```
public double[] getFrameDurations()
```
    Get the durations (in seconds) of each Datagram in this phone's units
    
    Returns:
    the left and right unit's Datagram durations (in seconds) in an array
  - getLeftTargetDuration
```
public double getLeftTargetDuration()
```
    Get this phone's left target's duration (in seconds)
    
    Returns:
    the left target's duration in seconds, or 0 if there is no left target
  - getRightTargetDuration
```
public double getRightTargetDuration()
```
    Get this phone's right target's duration (in seconds)
    
    Returns:
    the right target's duration in seconds, or 0 if there is no right target
  - getPredictedDuration
```
public double getPredictedDuration()
```
    Get the predicted duration of this phone (which is the sum of the left and right target's duration)
    
    Returns:
    the predicted phone duration in seconds
  - getLeftUnitData
```
public BaseUnitConcatenator.UnitData getLeftUnitData()
```
    Get this phone's left unit's UnitData
    
    Returns:
    the left unit's UnitData, or null if there is no left unit
  - getRightUnitData
```
public BaseUnitConcatenator.UnitData getRightUnitData()
```
    Get this phone's right unit's UnitData
    
    Returns:
    the right unit's UnitData, or null if there is no right unit
  - getLeftUnitDuration
```
public double getLeftUnitDuration()
```
    Get this phone's left unit's duration (in seconds)
    
    Returns:
    the left unit's duration in seconds, or 0 if there is no left unit
  - getRightUnitDuration
```
public double getRightUnitDuration()
```
    Get this phone's right unit's duration (in seconds)
    
    Returns:
    the right unit's duration in seconds, or 0 if there is no right unit
  - getRealizedDuration
```
public double getRealizedDuration()
```
    Get the realized duration (in seconds) of this phone (which is the sum of the durations of the left and right units)
    
    Returns:
    the phone's realized duration in seconds
  - getLeftDurationFactor
```
public double getLeftDurationFactor()
```
    Get the factor to convert this phone's left unit's duration into this phone's left target duration
    
    Returns:
    the left duration factor
  - getRightDurationFactor
```
public double getRightDurationFactor()
```
    Get the factor to convert this phone's right unit's duration into this phone's right target duration
    
    Returns:
    the right duration factor
  - getFramewiseDurationFactors
```
public double[] getFramewiseDurationFactors()
```
    Get the duration factors for this phone, one per datagram. Each factor corresponding to a datagram in the left unit is that required to convert the left unit's duration to the left target duration, and likewise for the right unit's datagrams.
    
    Returns:
    the left and right duration factors for this phone, in an array whose size matched the Datagrams in this phone's units
  - setLeftTargetF0Values
```
public void setLeftTargetF0Values(double[] f0TargetValues)
                           throws IllegalArgumentException
```
    Set the target F0 values of this phone's left half, with one value per Datagram in the phone's left unit
    
    Parameters:
    f0TargetValues - array of target F0 values to assign to the left halfphone
    
    Throws:
    
    IllegalArgumentException - if the length of f0TargetValues does not match the number of Datagrams in the phone's left unit
  - setRightTargetF0Values
```
public void setRightTargetF0Values(double[] f0TargetValues)
```
    Set the target F0 values of this phone's right half, with one value per Datagram in the phone's right unit
    
    Parameters:
    f0TargetValues - array of target F0 values to assign to the right halfphone
    
    Throws:
    
    IllegalArgumentException - if the length of f0TargetValues does not match the number of Datagrams in the phone's right unit
  - getLeftTargetF0Values
```
public double[] getLeftTargetF0Values()
                               throws NullPointerException
```
    Get the target F0 values for this phone's left half, with one value per Datagram in the phone's left unit
    
    Returns:
    the target F0 values for the left halfphone in an array
    
    Throws:
    
    NullPointerException - if the target F0 values for the left halfphone are null
  - getRightTargetF0Values
```
public double[] getRightTargetF0Values()
                                throws NullPointerException
```
    Get the target F0 values for this phone's right half, with one value per Datagram in the phone's right unit
    
    Returns:
    the target F0 values for the right halfphone in an array
    
    Throws:
    
    NullPointerException - if the target F0 values for the right halfphone are null
  - getTargetF0Values
```
public double[] getTargetF0Values()
```
    Get the target F0 values for this phone, with one value per Datagram in the phone's left and right units
    
    Returns:
    the target F0 values with one value per Datagram in an array
  - getPredictedF0
```
public double getPredictedF0()
```
    Get the mean target F0 for this phone
    
    Returns:
    the mean predicted F0 value
  - getLeftUnitFrameDurations
```
public double[] getLeftUnitFrameDurations()
```
    Get the durations (in seconds) of each Datagram in this phone's left unit
    
    Returns:
    the durations of each Datagram in the left unit in an array, or null if there is no left unit
  - getRightUnitFrameDurations
```
public double[] getRightUnitFrameDurations()
```
    Get the durations (in seconds) of each Datagram in this phone's right unit
    
    Returns:
    the durations of each Datagram in the right unit in an array, or null if there is no right unit
  - getRealizedFrameDurations
```
public double[] getRealizedFrameDurations()
```
    Get the durations (in seconds) of each Datagram in this phone's left and right units
    
    Returns:
    the durations of all Datagrams in this phone in an array
  - getLeftUnitFrameF0s
```
public double[] getLeftUnitFrameF0s()
```
    Recover the F0 values from this phone's left unit's Datagrams
    
    Returns:
    the left unit's F0 values in an array, with one value per Datagram, or null if there is no left unit or any of the left unit's Datagrams have zero duration
  - getRightUnitFrameF0s
```
public double[] getRightUnitFrameF0s()
```
    Recover the F0 values from this phone's right unit's Datagrams
    
    Returns:
    the right unit's F0 values in an array, with one value per Datagram, or null if there is no right unit or any of the right unit's Datagrams have zero duration
  - getUnitFrameF0s
```
public double[] getUnitFrameF0s()
```
    Recover the F0 values from each Datagram in this phone's left and right units
    
    Returns:
    the F0 values for each Datagram in this phone, or null if either the left or the right unit contain a Datagram with zero duration
  - getRealizedF0
```
public double getRealizedF0()
```
    Get the realized F0 by recovering the F0 from all Datagrams in this phone and computing the mean
    
    Returns:
    the mean F0 of all Datagrams in this phone's left and right units
  - getLeftF0Factors
```
public double[] getLeftF0Factors()
```
    Get the factors to convert each of the F0 values in this phone's left half to the corresponding target value
    
    Returns:
    the F0 factors for this phone's left half in an array with one value per Datagram, or null if the number of Datagrams does not match the number of left target F0 values
  - getRightF0Factors
```
public double[] getRightF0Factors()
```
    Get the factors to convert each of the F0 values in this phone's right half to the corresponding target value
    
    Returns:
    the F0 factors for this phone's right half in an array with one value per Datagram, or null if the number of Datagrams does not match the number of right target F0 values
  - getF0Factors
```
public double[] getF0Factors()
```
    Get the F0 factor for each Datagram in this phone's left and right units
    
    Returns:
    the F0 factors, in an array with one value per Datagram
  - isTransient
```
public boolean isTransient()
```
    Determine whether this is a transient phone (i.e. a plosive)
    
    Returns:
    true if this is a plosive, false otherwise
  - isVoiced
```
public boolean isVoiced()
```
    Determine whether this is a voiced phone
    
    Returns:
    true if this is voiced, false otherwise
  - getMaryXMLElement
```
public Element getMaryXMLElement()
```
    get the MaryXML Element corresponding to this Phone's Target
    If both leftTarget and rightTarget are not null, their respective MaryXML Elements should be equal.
    
    Returns:
    the MaryXML Element, or null if both halfphone targets are null
  - toString
```
public String toString()
```
    for debugging, provide the names of the left and right targets as the string representation of this class
    
    Overrides:
    
    toString in class Object

Class Phone

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Phone

Method Detail

getLeftUnit

getRightUnit

getLeftTarget

getRightTarget

getLeftUnitFrames

getRightUnitFrames

getUnitDataFrames

getNumberOfLeftUnitFrames

getNumberOfRightUnitFrames

getNumberOfFrames

getFrameDurations

getLeftTargetDuration

getRightTargetDuration

getPredictedDuration

getLeftUnitData

getRightUnitData

getLeftUnitDuration

getRightUnitDuration

getRealizedDuration

getLeftDurationFactor

getRightDurationFactor

getFramewiseDurationFactors

setLeftTargetF0Values

setRightTargetF0Values

getLeftTargetF0Values

getRightTargetF0Values

getTargetF0Values

getPredictedF0

getLeftUnitFrameDurations

getRightUnitFrameDurations

getRealizedFrameDurations

getLeftUnitFrameF0s

getRightUnitFrameF0s

getUnitFrameF0s

getRealizedF0

getLeftF0Factors

getRightF0Factors

getF0Factors

isTransient

isVoiced

getMaryXMLElement

toString