Package soundPlayback.preprocess

Class PlaybackFilter

java.lang.Object

soundPlayback.preprocess.PlaybackFilter

All Implemented Interfaces:

PlaybackPreprocess

public class PlaybackFilter
extends Object
implements PlaybackPreprocess

High pass filters for playback system.

Author:

dg50

Constructor Summary

Constructors

Constructor	Description
PlaybackFilter(PlaybackControl playbackControl)

Method Summary

Modifier and Type	Method	Description
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	getTextValue()
double	getValue()
boolean	isActive()	return true if the preprocess is doing anything.
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.
void	setValue(double filterValue)

Methods inherited from class java.lang.Object

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

Constructor Details

PlaybackFilter

public PlaybackFilter(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.

setValue

public void setValue(double filterValue)

getValue

public double getValue()

getTextValue

public String getTextValue()

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

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