spectrogramNoiseReduction
Class SpecNoiseMethod

java.lang.Object
  spectrogramNoiseReduction.SpecNoiseMethod

Direct Known Subclasses:

AverageSubtraction, KernelSmoothing, SpectrogramMedianFilter, SpectrogramThreshold

public abstract class SpecNoiseMethod
extends java.lang.Object

Interface for multiple plugins to the spectrogram noise reduction system.

Author:

Doug Gillespie

Constructor Summary

SpecNoiseMethod()

Method Summary

abstract void	fillXMLParameters(org.w3c.dom.Element n)
Annotation	getAnnotation(PamProcess pamProcess) Get an annotation to go with this method.
abstract int	getDelay()
abstract java.lang.String	getDescription() Get a longer description of the method in html format for hover texts in dialogs.
abstract SpecNoiseDialogComponent	getDialogComponent() Get a component to include in the overall noise reductino dialog
abstract java.lang.String	getName() Get a name for the method.
abstract java.io.Serializable	getParams() Get the noise params for this method for storage between euns
abstract boolean	initialise(int channelMap) Set up the noise reduction process
abstract boolean	runNoiseReduction(FFTDataUnit fftDataUnit) Run the noise reduction on the data in place.
abstract boolean	setParams(java.io.Serializable noiseParams) Set the params for this method - will check class is OK before casting.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpecNoiseMethod

public SpecNoiseMethod()

Method Detail

getName

public abstract java.lang.String getName()

Get a name for the method.

Returns:

String

getDescription

public abstract java.lang.String getDescription()

Get a longer description of the method in html format for hover texts in dialogs.

Returns:

html description

runNoiseReduction

public abstract boolean runNoiseReduction(FFTDataUnit fftDataUnit)

Run the noise reduction on the data in place.

Parameters:

fftData - array of fft data (half fft length)

Returns:

true if ran OK/

getDelay

public abstract int getDelay()

Returns:

the delay imposed on the data by this operation.

initialise

public abstract boolean initialise(int channelMap)

Set up the noise reduction process

Returns:

true if initialised OK.

setParams

public abstract boolean setParams(java.io.Serializable noiseParams)

Set the params for this method - will check class is OK before casting.

Parameters:

noiseParams -

Returns:

true if parameters match

getParams

public abstract java.io.Serializable getParams()

Get the noise params for this method for storage between euns

Returns:

getDialogComponent

public abstract SpecNoiseDialogComponent getDialogComponent()

Get a component to include in the overall noise reductino dialog

Returns:

component

getAnnotation

public Annotation getAnnotation(PamProcess pamProcess)

Get an annotation to go with this method.

Parameters:

pamProcess - parent process

Returns:

annotation

fillXMLParameters

public abstract void fillXMLParameters(org.w3c.dom.Element n)