audio.processing.modulation

Class TriangularLFO

java.lang.Object

audio.processing.modulation.TriangularLFO

All Implemented Interfaces:

LFO

public class TriangularLFO
extends java.lang.Object
implements LFO

This class implements the LFO interface and creates a low frequency oscillator with a triangular oscillation pattern.

See Also:

LFO, SinusoidalLFO, VariableDelay, VariableDelayEffect

Method Summary

Methods

Modifier and Type	Method and Description
void	advance() Advances the waveform.
double	getDouble() Returns the value of theta * amplitude as a double
int	getInt() This method takes the value returned by the getDouble method and uses the Math.rint(double) to return the double value that is closest in value to getDouble() and is equal to a mathematical integer.
void	setAmplitude(double amplitude) Method simply sets the size of the amplitude and thus decides the amplitude (ie sets the maximum 'peak' value and minimum 'trough' value) of the triangular waveform
void	setPeriod(int period) Method simply sets the size of the oscillation period.

Methods inherited from class java.lang.Object

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

Method Detail

setAmplitude

public void setAmplitude(double amplitude)

Method simply sets the size of the amplitude and thus decides the amplitude (ie sets the maximum 'peak' value and minimum 'trough' value) of the triangular waveform

Specified by:

setAmplitude in interface LFO

Parameters:

amplitude - value to set the size of the amplitude of the waveform

setPeriod

public void setPeriod(int period)

Method simply sets the size of the oscillation period. If the sample rate of an audio file is 44100 then a period set to 44100 corresponds to 1 second per oscillation

Specified by:

setPeriod in interface LFO

Parameters:

period - value to set the size of the oscillation

advance

public void advance()

Advances the waveform. This is called for each sample in an array and actually creates the triangular waveform. This method checks if the absolute value of a of the double "value" is greater or smaller than 1.0 (the default value). Once the method determines whether the the waveform is rising or falling, then the current position on the waveform can be found.

Specified by:

advance in interface LFO

getDouble

public double getDouble()

Returns the value of theta * amplitude as a double

Specified by:

getDouble in interface LFO

Returns:

the value of theta (the 'x' axis value of theta) multiplied by the amplitude ('y' axis value)

getInt

public int getInt()

This method takes the value returned by the getDouble method and uses the Math.rint(double) to return the double value that is closest in value to getDouble() and is equal to a mathematical integer. This double is cast as an integer and returned.

Specified by:

getInt in interface LFO

Returns:

the closest integer to the value returned in getDouble()