triana.types.util

Class SpectralChannelFormat

java.lang.Object

triana.types.util.SpectralChannelFormat

All Implemented Interfaces:

ChannelFormat

public class SpectralChannelFormat
extends java.lang.Object
implements ChannelFormat

SpectralChannelFormat is a format for representing frequency-domain data or data that have been put through a Fourier transform. It contains methods to set and createTool relevant additional information, such as the frequency range of the data.

It implements the ChannelFormat interface

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	channelName The name for this channel
boolean	narrow Indicates whether the data represent a narrow bandwidth derived from a full-band spectrum in the given dimension dim..
int	numberOfPoints The number of points contained within this spectral representation.
int	samplingRate The sampling rate specified as a integer.
boolean	twoSided Variable indicating whether the data are stored as a two-sided transform, i.e. containing both the positive and negative frequency data.

Constructor Summary

Constructors

Constructor and Description
SpectralChannelFormat() Creates an SpectralChannelFormat Object with default values
SpectralChannelFormat(int srate, int numberOfPoints, boolean twoSided, boolean narrow) Creates an SpectralChannelFormat Object with a given sampling rate and sample size (in bits) It formats the audio to the default PCM, names the chanel Audio.
SpectralChannelFormat(int srate, int numberOfPoints, boolean twoSided, boolean narrow, java.lang.String chanName) Creates an SpectralChannelFormat Object with a given sampling rate and sample size (in bits) It formats the audio to the default PCM, names the chanel Audio.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getChannelName()
double	getFrequencyResolution() Returns the frequency resolution of the data associated with the independent variable indexed by the given value of dim, i.e. the step in frequency from one data point to the next.
double	getLowerFrequencyBound() Returns the (non-negative) value of the lowest frequency in the frequency band held in the object, for the given dimension dim.
int	getOriginalN() Returns the number of points in the data set whose transform could have led to the present data, or equivalently the number of points in the two-sided full-bandwidth spectrum from which the present spectrum could have been derived.
int	getPoints()
int	getSamplingRate()
double	getUpperFrequencyBound() Returns the (non-negative) value of the highest frequency in the frequency band held in the object, for the given dimension dim.
boolean	isNarrow() Returns true if the data represent a narrow bandwidth derived from a full-band spectrum in the given dimension dim..
boolean	isTwoSided() Returns true if the data are stored as a two-sided transform, i.e. containing both the positive and negative frequency data.
void	setFromString(java.lang.String str) Initialises this AudioChannelFormat object from the given string
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

samplingRate

public int samplingRate

The sampling rate specified as a integer. Default is 44100, CD quality

numberOfPoints

public int numberOfPoints

The number of points contained within this spectral representation. This is needed to calculate the spectral resolution

channelName

public java.lang.String channelName

The name for this channel

twoSided

public boolean twoSided

Variable indicating whether the data are stored as a two-sided transform, i.e. containing both the positive and negative frequency data.

narrow

public boolean narrow

Indicates whether the data represent a narrow bandwidth derived from a full-band spectrum in the given dimension dim..

Constructor Detail

SpectralChannelFormat

public SpectralChannelFormat()

Creates an SpectralChannelFormat Object with default values

SpectralChannelFormat

public SpectralChannelFormat(int srate,
                     int numberOfPoints,
                     boolean twoSided,
                     boolean narrow,
                     java.lang.String chanName)

Creates an SpectralChannelFormat Object with a given sampling rate and sample size (in bits) It formats the audio to the default PCM, names the chanel Audio.

SpectralChannelFormat

public SpectralChannelFormat(int srate,
                     int numberOfPoints,
                     boolean twoSided,
                     boolean narrow)

Creates an SpectralChannelFormat Object with a given sampling rate and sample size (in bits) It formats the audio to the default PCM, names the chanel Audio.

Method Detail

getFrequencyResolution

public double getFrequencyResolution()

Returns the frequency resolution of the data associated with the independent variable indexed by the given value of dim, i.e. the step in frequency from one data point to the next.

Returns:

double The frequency resolution

getChannelName

public java.lang.String getChannelName()

Specified by:

getChannelName in interface ChannelFormat

Returns:

the name for this channel

getSamplingRate

public int getSamplingRate()

Specified by:

getSamplingRate in interface ChannelFormat

Returns:

the sampling rate for this channel

isTwoSided

public boolean isTwoSided()

Returns true if the data are stored as a two-sided transform, i.e. containing both the positive and negative frequency data. If false, the data are one-sided, containing only positive frequencies. If the data set is multi-dimensional, then one-sided means that only positive frequencies for the first independent variable, dim = 0, are stored. Thus, there is no dim parameter for this method.

Returns:

boolean True if data are two-sided in frequency space

getOriginalN

public int getOriginalN()

Returns the number of points in the data set whose transform could have led to the present data, or equivalently the number of points in the two-sided full-bandwidth spectrum from which the present spectrum could have been derived. This depends on which independent variable one is examining (dim).

Returns:

int The number of points in the original data set

getPoints

public int getPoints()

Returns:

the number of points in this spectral representation.

isNarrow

public boolean isNarrow()

Returns true if the data represent a narrow bandwidth derived from a full-band spectrum in the given dimension dim..

Returns:

boolean True if data are narrow-band

getLowerFrequencyBound

public double getLowerFrequencyBound()

Returns the (non-negative) value of the lowest frequency in the frequency band held in the object, for the given dimension dim.

Returns:

double The lowest frequency represented in the given direction

getUpperFrequencyBound

public double getUpperFrequencyBound()

Returns the (non-negative) value of the highest frequency in the frequency band held in the object, for the given dimension dim.

Returns:

double The highest frequency represented in the given direction

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

Returns:

true if the given object has the same parameters as this object

toString

public java.lang.String toString()

Specified by:

toString in interface ChannelFormat

Overrides:

toString in class java.lang.Object

Returns:

a string representation for this AudioChannelFormat object

setFromString

public void setFromString(java.lang.String str)

Initialises this AudioChannelFormat object from the given string

Specified by:

setFromString in interface ChannelFormat