Package adams.data.threewayfilter

Class DownSample

  • All Implemented Interfaces:
    adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<adams.data.filter.Filter>, adams.core.SizeOfHandler, adams.data.filter.Filter<ThreeWayData>, Serializable, Comparable
    public class DownSample
extends adams.data.filter.DownSample<ThreeWayData>
    A filter that returns only every n-th 1st level and 2nd level point. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -no-id-update <boolean> (property: dontUpdateID)
    If enabled, suppresses updating the ID of adams.data.id.IDHandler data containers.
    default: false
 
    -nth <int> (property: nthPoint)
    Only every n-th point will be output.
    default: 1
    minimum: 1
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class adams.data.filter.AbstractFilter

        adams.data.filter.AbstractFilter.FilterJob<T extends adams.data.container.DataContainer>

    • Field Summary

      • Fields inherited from class adams.data.filter.DownSample

        m_NthPoint

      • Fields inherited from class adams.data.filter.AbstractFilter

        m_DontUpdateID

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

        m_OptionManager

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Constructor Summary

      Constructors 
      Constructor Description
      DownSample()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected adams.data.container.DataPoint copy​(int index, List<adams.data.container.DataPoint> points)
      Creates a copy of the data point.
      String globalInfo()
      Returns a string describing the object.

      • Methods inherited from class adams.data.filter.DownSample

        defineOptions, getNthPoint, nthPointTipText, processData, setNthPoint

      • Methods inherited from class adams.data.filter.AbstractFilter

        checkData, cleanUp, compareTo, destroy, dontUpdateIDTipText, equals, filter, forCommandLine, getDontUpdateID, reset, setDontUpdateID, shallowCopy, shallowCopy

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

        cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, 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, setLoggingLevel

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

        getLogger, isLoggingEnabled

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager, toCommandLine

    • Constructor Detail

      • DownSample

        public DownSample()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Overrides:
        globalInfo in class adams.data.filter.DownSample<ThreeWayData>
        Returns:
        a description suitable for displaying in the gui

      • copy

        protected adams.data.container.DataPoint copy​(int index,
                                              List<adams.data.container.DataPoint> points)
        Creates a copy of the data point.
        Overrides:
        copy in class adams.data.filter.DownSample<ThreeWayData>
        Parameters:
        index - the index in the data point list to copy
        points - the list of data points
        Returns:
        the copy of the specified data point