Package adams.data.threewayfilter

Class Shift

  • 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 Shift
extends adams.data.filter.AbstractFilter<ThreeWayData>
    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 
      Modifier and Type Field Description
      protected int m_OffsetX
      the offset for X.
      protected int m_OffsetY
      the offset for Y.
      protected int m_OffsetZ
      the offset for Z.

      • 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
      Shift()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      int getOffsetX()
      Returns the offset for X.
      int getOffsetY()
      Returns the offset for Y.
      int getOffsetZ()
      Returns the offset for Z.
      String globalInfo()
      Returns a string describing the object.
      String offsetXTipText()
      Returns the tip text for this property.
      String offsetYTipText()
      Returns the tip text for this property.
      String offsetZTipText()
      Returns the tip text for this property.
      protected ThreeWayData processData​(ThreeWayData data)
      Performs the actual filtering.
      void setOffsetX​(int value)
      Sets the offset for X.
      void setOffsetY​(int value)
      Sets the offset for Y.
      void setOffsetZ​(int value)
      Sets the offset for Z.

      • 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

    • Field Detail

      • m_OffsetX

        protected int m_OffsetX
        the offset for X.

      • m_OffsetY

        protected int m_OffsetY
        the offset for Y.

      • m_OffsetZ

        protected int m_OffsetZ
        the offset for Z.

    • Constructor Detail

      • Shift

        public Shift()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.data.filter.AbstractFilter<ThreeWayData>

      • setOffsetX

        public void setOffsetX​(int value)
        Sets the offset for X.
        Parameters:
        value - the offset

      • getOffsetX

        public int getOffsetX()
        Returns the offset for X.
        Returns:
        the offset

      • offsetXTipText

        public String offsetXTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setOffsetY

        public void setOffsetY​(int value)
        Sets the offset for Y.
        Parameters:
        value - the offset

      • getOffsetY

        public int getOffsetY()
        Returns the offset for Y.
        Returns:
        the offset

      • offsetYTipText

        public String offsetYTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setOffsetZ

        public void setOffsetZ​(int value)
        Sets the offset for Z.
        Parameters:
        value - the offset

      • getOffsetZ

        public int getOffsetZ()
        Returns the offset for Z.
        Returns:
        the offset

      • offsetZTipText

        public String offsetZTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • processData

        protected ThreeWayData processData​(ThreeWayData data)
        Performs the actual filtering.
        Specified by:
        processData in class adams.data.filter.AbstractFilter<ThreeWayData>
        Parameters:
        data - the data to filter
        Returns:
        the filtered data