Package adams.data.threewayfilter

Class Crop

  • 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 Crop
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 adams.core.base.BaseInterval m_RangeX
      the range for X.
      protected adams.core.base.BaseInterval m_RangeY
      the range for Y.
      protected adams.core.base.BaseInterval m_RangeZ
      the range 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
      Crop()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      adams.core.base.BaseInterval getRangeX()
      Returns the range for X.
      adams.core.base.BaseInterval getRangeY()
      Returns the range for Y.
      adams.core.base.BaseInterval getRangeZ()
      Returns the range for Z.
      String globalInfo()
      Returns a string describing the object.
      protected ThreeWayData processData​(ThreeWayData data)
      Performs the actual filtering.
      String rangeXTipText()
      Returns the tip text for this property.
      String rangeYTipText()
      Returns the tip text for this property.
      String rangeZTipText()
      Returns the tip text for this property.
      void setRangeX​(adams.core.base.BaseInterval value)
      Sets the range for X.
      void setRangeY​(adams.core.base.BaseInterval value)
      Sets the range for Y.
      void setRangeZ​(adams.core.base.BaseInterval value)
      Sets the range 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_RangeX

        protected adams.core.base.BaseInterval m_RangeX
        the range for X.

      • m_RangeY

        protected adams.core.base.BaseInterval m_RangeY
        the range for Y.

      • m_RangeZ

        protected adams.core.base.BaseInterval m_RangeZ
        the range for Z.

    • Constructor Detail

      • Crop

        public Crop()

    • 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>

      • setRangeX

        public void setRangeX​(adams.core.base.BaseInterval value)
        Sets the range for X.
        Parameters:
        value - the range

      • getRangeX

        public adams.core.base.BaseInterval getRangeX()
        Returns the range for X.
        Returns:
        the range

      • rangeXTipText

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

      • setRangeY

        public void setRangeY​(adams.core.base.BaseInterval value)
        Sets the range for Y.
        Parameters:
        value - the range

      • getRangeY

        public adams.core.base.BaseInterval getRangeY()
        Returns the range for Y.
        Returns:
        the range

      • rangeYTipText

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

      • setRangeZ

        public void setRangeZ​(adams.core.base.BaseInterval value)
        Sets the range for Z.
        Parameters:
        value - the range

      • getRangeZ

        public adams.core.base.BaseInterval getRangeZ()
        Returns the range for Z.
        Returns:
        the range

      • rangeZTipText

        public String rangeZTipText()
        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