Package adams.data.wavefilter

Class AbstractWaveFilter

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, Serializable
    Direct Known Subclasses:
    Cut, MultiFilter, PassThrough, Resample, Trim
    public abstract class AbstractWaveFilter
extends adams.core.option.AbstractOptionHandler
implements adams.core.QuickInfoSupporter
    Ancestor for filters that operate on Wave containers.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected void checkData​(WaveContainer data)
      The default implementation only checks whether there is any data set.
      WaveContainer filter​(WaveContainer data)
      Returns the filtered data.
      String getQuickInfo()
      Returns a quick info about the object, which can be displayed in the GUI.
      protected abstract WaveContainer processData​(WaveContainer data)
      Performs the actual filtering.

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

    • Constructor Detail

      • AbstractWaveFilter

        public AbstractWaveFilter()

    • Method Detail

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the object, which can be displayed in the GUI.
        Default implementation returns null.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Returns:
        null if no info available, otherwise short string

      • checkData

        protected void checkData​(WaveContainer data)
        The default implementation only checks whether there is any data set.
        Parameters:
        data - the data to filter

      • processData

        protected abstract WaveContainer processData​(WaveContainer data)
        Performs the actual filtering.
        Parameters:
        data - the data to filter
        Returns:
        the filtered data

      • filter

        public WaveContainer filter​(WaveContainer data)
        Returns the filtered data.
        Parameters:
        data - the data to filter
        Returns:
        the filtered data