Package soundPlayback.preprocess

Class EnvelopeTracer

java.lang.Object

soundPlayback.preprocess.EnvelopeTracer

All Implemented Interfaces:

PamSettings, SettingsNameProvider, PlaybackPreprocess

public class EnvelopeTracer
extends Object
implements PlaybackPreprocess, PamSettings

Constructor Summary

Constructors

Constructor	Description
EnvelopeTracer(PlaybackControl playbackControl)

Method Summary

Modifier and Type	Method	Description
double	getMixRatio()
Serializable	getSettingsReference()
long	getSettingsVersion()
PreprocessSwingComponent	getSideParComponent()	Get a component to include in the PAMGuard side panel.
PreProcessFXPane	getSideParPane()	Get a node to include in the PAMGuard side panel.
String	getStateText()
String	getUnitName()
String	getUnitType()
boolean	isActive()	return true if the preprocess is doing anything.
void	postFilterMenu(ActionEvent e)
void	preFilterMenu(ActionEvent e)
RawDataUnit	processDataUnit(RawDataUnit inputDataUnit, boolean mustCopy)	Process a data unit.
void	reset(double inputSampleRate, int channelMap)	Reset or prepare the process Will almost definitely need another less abstract process for setting more specific task parameters.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
void	setMixRatio(double mixRatio)

Methods inherited from class java.lang.Object

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

Constructor Details

EnvelopeTracer

public EnvelopeTracer(PlaybackControl playbackControl)

Method Details

reset

public void reset(double inputSampleRate,
 int channelMap)

Description copied from interface: PlaybackPreprocess

Reset or prepare the process
Will almost definitely need another less abstract process for setting more specific task parameters.

Specified by:

reset in interface PlaybackPreprocess

Parameters:

channelMap - map of channels that are going to get processed.

processDataUnit

public RawDataUnit processDataUnit(RawDataUnit inputDataUnit,
 boolean mustCopy)

Description copied from interface: PlaybackPreprocess

Process a data unit.

Specified by:

processDataUnit in interface PlaybackPreprocess

Parameters:

inputDataUnit - source data unit.

mustCopy - data must not be modified in place. This will be set true for the rist unit in a chain in the playback system (generally a decimator) after that it will be false meaning that processes are free to modify the data in place so long as it remains consistent in length, etc.

Returns:

a Raw data unit which may or may not be the same as the input one.

getSideParComponent

public PreprocessSwingComponent getSideParComponent()

Description copied from interface: PlaybackPreprocess

Get a component to include in the PAMGuard side panel.

Specified by:

getSideParComponent in interface PlaybackPreprocess

Returns:

Component for the side panel

isActive

public boolean isActive()

Description copied from interface: PlaybackPreprocess

return true if the preprocess is doing anything.

Specified by:

isActive in interface PlaybackPreprocess

Returns:

Component for the side panel

getUnitName

public String getUnitName()

Specified by:

getUnitName in interface SettingsNameProvider

Returns:

A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.

getUnitType

public String getUnitType()

Specified by:

getUnitType in interface PamSettings

Returns:

A Name specific to the type, e.g. Click detector

getSettingsReference

public Serializable getSettingsReference()

Specified by:

getSettingsReference in interface PamSettings

Returns:

The serialisable object that will be stored

getSettingsVersion

public long getSettingsVersion()

Specified by:

getSettingsVersion in interface PamSettings

Returns:

An integer version number for the settings

restoreSettings

public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Specified by:

restoreSettings in interface PamSettings

Returns:

true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required

setMixRatio

public void setMixRatio(double mixRatio)

getMixRatio

public double getMixRatio()

preFilterMenu

public void preFilterMenu(ActionEvent e)

postFilterMenu

public void postFilterMenu(ActionEvent e)

getStateText

public String getStateText()

getSideParPane

public PreProcessFXPane getSideParPane()

Description copied from interface: PlaybackPreprocess

Get a node to include in the PAMGuard side panel.

Specified by:

getSideParPane in interface PlaybackPreprocess

Returns:

pane for the side panel