Class SpecNoiseMethod

java.lang.Object
spectrogramNoiseReduction.SpecNoiseMethod
Direct Known Subclasses:
AverageSubtraction, KernelSmoothing, SpectrogramMedianFilter, SpectrogramThreshold

public abstract class SpecNoiseMethod extends Object
Interface for multiple plugins to the spectrogram noise reduction system.
Author:
Doug Gillespie
  • Constructor Details

    • SpecNoiseMethod

      public SpecNoiseMethod()
  • Method Details

    • getName

      public abstract String getName()
      Get a name for the method.
      Returns:
      String
    • getDescription

      public abstract 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(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 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 ProcessAnnotation getAnnotation(PamProcess pamProcess)
      Get an annotation to go with this method.
      Parameters:
      pamProcess - parent process
      Returns:
      annotation
    • getNode

      public abstract SpecNoiseNodeFX getNode()
      Get the FX node for the spectrogram method.
      Returns:
      the FX node for the spectrogram method.