Package simulatedAcquisition.sounds

Class ClickSound

java.lang.Object

simulatedAcquisition.sounds.SimSignal

simulatedAcquisition.sounds.ClickSound

Direct Known Subclasses:

BranchedChirp

public class ClickSound
extends SimSignal

Generate short click like sounds. These can be chirped (to look like beaked whales) and a variety of windows are available.

Author:

doug

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ClickSound.WINDOWTYPE

Field Summary

Fields

Modifier and Type	Field	Description
protected double	duration
protected double	f0
protected double	f1

Constructor Summary

Constructors

Constructor	Description
ClickSound(String name, double f0, double f1, double duration, ClickSound.WINDOWTYPE windowType)

Method Summary

Modifier and Type	Method	Description
protected void	generateSound(float sampleRate, double sampleOffset)
String	getName()
double[]	getSignal(int channel, float sampleRate, double sampleOffset)	Get a single simulated signal.

Methods inherited from class simulatedAcquisition.sounds.SimSignal

prepareSignal, taperEnds, toString

Methods inherited from class java.lang.Object

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

Field Details

f0

protected double f0

f1

protected double f1

duration

protected double duration

Constructor Details

ClickSound

public ClickSound(String name,
 double f0,
 double f1,
 double duration,
 ClickSound.WINDOWTYPE windowType)

Method Details

generateSound

protected void generateSound(float sampleRate,
 double sampleOffset)

getName

public String getName()

Specified by:

getName in class SimSignal

Returns:

friendly name for displaying

getSignal

public double[] getSignal(int channel,
 float sampleRate,
 double sampleOffset)

Description copied from class: SimSignal

Get a single simulated signal.

Specified by:

getSignal in class SimSignal

Parameters:

sampleRate - sample rate of data

sampleOffset - sample offset - 0invalid input: '<'=sampleOffsetinvalid input: '<'1
How far into the sound the first sample is, i.e. 0 means that the first sample point will be right on the start of the sound (value 0 if it's sin wave based), value 0.5 would be half a sample later.

Returns:

a signal for a single channel.