org.diirt.datasource.sim

Class Square2DWaveform

java.lang.Object

org.diirt.datasource.sim.Square2DWaveform

public class Square2DWaveform
extends Object

Function to simulate a 2D waveform containing a sine wave.

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
Square2DWaveform() Creates sine wave of 100 samples, with period of 1 second, wavelength of 100 samples along the x axis, updating at 10 Hz.
Square2DWaveform(Double periodInSeconds, Double wavelengthInSamples, Double updateRateInSeconds) Creates sine wave of 100 samples, with given period and given wavelength of 100 samples along the x axis, updating at given rate.
Square2DWaveform(Double periodInSeconds, Double wavelengthInSamples, Double nSamples, Double updateRateInSeconds) Creates sine wave of 100 samples, with given period and given wavelength of given number of samples along the x axis, updating at given rate.
Square2DWaveform(Double periodInSeconds, Double wavelengthInSamples, Double angle, Double xSamples, Double ySamples, Double updateRateInSeconds) Creates sine wave with given parameters.

Method Summary

Modifier and Type	Method and Description
TimeDuration	getTimeBetweenSamples() Returns the time between each sample.

Methods inherited from class java.lang.Object

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

Constructor Detail

Square2DWaveform

public Square2DWaveform()

Creates sine wave of 100 samples, with period of 1 second, wavelength of 100 samples along the x axis, updating at 10 Hz.

Square2DWaveform

public Square2DWaveform(Double periodInSeconds,
                        Double wavelengthInSamples,
                        Double updateRateInSeconds)

Creates sine wave of 100 samples, with given period and given wavelength of 100 samples along the x axis, updating at given rate.

Parameters:

periodInSeconds - the period measured in seconds

wavelengthInSamples - the wavelength measured in samples

updateRateInSeconds - the update rate in seconds

Square2DWaveform

public Square2DWaveform(Double periodInSeconds,
                        Double wavelengthInSamples,
                        Double nSamples,
                        Double updateRateInSeconds)

Creates sine wave of 100 samples, with given period and given wavelength of given number of samples along the x axis, updating at given rate.

Parameters:

periodInSeconds - the period measured in seconds

wavelengthInSamples - the wavelength measured in samples

nSamples - the number of samples

updateRateInSeconds - the update rate in seconds

Square2DWaveform

public Square2DWaveform(Double periodInSeconds,
                        Double wavelengthInSamples,
                        Double angle,
                        Double xSamples,
                        Double ySamples,
                        Double updateRateInSeconds)

Creates sine wave with given parameters.

Parameters:

periodInSeconds - the period measured in seconds

wavelengthInSamples - the wavelength measured in samples

angle - the direction of propagation for the wave

xSamples - number of samples on the x direction

ySamples - number of samples on the y direction

updateRateInSeconds - the update rate in seconds

Method Detail

getTimeBetweenSamples

public TimeDuration getTimeBetweenSamples()

Returns the time between each sample.

Returns:

a time duration