Package spectrogramNoiseReduction.averageSubtraction

Class AverageSubtraction

java.lang.Object

spectrogramNoiseReduction.SpecNoiseMethod

spectrogramNoiseReduction.averageSubtraction.AverageSubtraction

public class AverageSubtraction
extends SpecNoiseMethod

Field Summary

Fields

Modifier and Type	Field	Description
protected AverageSubtractionParameters	averageSubtractionParameters

Constructor Summary

Constructors

Constructor	Description
AverageSubtraction()

Method Summary

Modifier and Type	Method	Description
AverageSubtractionParameters	getAverageSubtractionParameters()
int	getDelay()
String	getDescription()	Get a longer description of the method in html format for hover texts in dialogs.
SpecNoiseDialogComponent	getDialogComponent()	Get a component to include in the overall noise reductino dialog
String	getName()	Get a name for the method.
SpecNoiseNodeFX	getNode()	Get the FX node for the spectrogram method.
Serializable	getParams()	Get the noise params for this method for storage between euns
boolean	initialise(int channelMap)	Set up the noise reduction process
boolean	runNoiseReduction(FFTDataUnit fftDataUnit)	Run the noise reduction on the data in place.
boolean	setParams(Serializable noiseParams)	Set the params for this method - will check class is OK before casting.

Methods inherited from class spectrogramNoiseReduction.SpecNoiseMethod

getAnnotation

Methods inherited from class java.lang.Object

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

Field Details

averageSubtractionParameters

protected AverageSubtractionParameters averageSubtractionParameters

Constructor Details

AverageSubtraction

public AverageSubtraction()

Method Details

getDialogComponent

public SpecNoiseDialogComponent getDialogComponent()

Description copied from class: SpecNoiseMethod

Get a component to include in the overall noise reductino dialog

Specified by:

getDialogComponent in class SpecNoiseMethod

Returns:

component

getName

public String getName()

Description copied from class: SpecNoiseMethod

Get a name for the method.

Specified by:

getName in class SpecNoiseMethod

Returns:

String

getDescription

public String getDescription()

Description copied from class: SpecNoiseMethod

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

Specified by:

getDescription in class SpecNoiseMethod

Returns:

html description

getDelay

public int getDelay()

Specified by:

getDelay in class SpecNoiseMethod

Returns:

the delay imposed on the data by this operation.

getParams

public Serializable getParams()

Description copied from class: SpecNoiseMethod

Get the noise params for this method for storage between euns

Specified by:

getParams in class SpecNoiseMethod

Returns:

initialise

public boolean initialise(int channelMap)

Description copied from class: SpecNoiseMethod

Set up the noise reduction process

Specified by:

initialise in class SpecNoiseMethod

Returns:

true if initialised OK.

runNoiseReduction

public boolean runNoiseReduction(FFTDataUnit fftDataUnit)

Description copied from class: SpecNoiseMethod

Run the noise reduction on the data in place.

Specified by:

runNoiseReduction in class SpecNoiseMethod

Returns:

true if ran OK/

setParams

public boolean setParams(Serializable noiseParams)

Description copied from class: SpecNoiseMethod

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

Specified by:

setParams in class SpecNoiseMethod

Parameters:

noiseParams -

Returns:

true if parameters match

getAverageSubtractionParameters

public AverageSubtractionParameters getAverageSubtractionParameters()

getNode

public SpecNoiseNodeFX getNode()

Description copied from class: SpecNoiseMethod

Get the FX node for the spectrogram method.

Specified by:

getNode in class SpecNoiseMethod

Returns:

the FX node for the spectrogram method.