Package adams.data.filter

Class HeatmapRotate

  • 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<Heatmap>, Serializable, Comparable
    public class HeatmapRotate
extends adams.data.filter.AbstractFilter<Heatmap>
    Rotates a heatmap by a specified number of degrees clockwise.

    Valid options are: 

    -D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 
    -rotation <ROTATE_90_DEGREES|ROTATE_180_DEGREES|ROTATE_270_DEGREES> (property: rotation)
    The type of rotation to perform on the heatmap.
    default: ROTATE_180_DEGREES
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  HeatmapRotate.Rotation
      Defines the type of rotation to perform.

      • 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 HeatmapRotate.Rotation m_Rotation
      the type of rotation to perform.

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      HeatmapRotate.Rotation getRotation()
      Returns the type of rotation to perform.
      String globalInfo()
      Returns a string describing the object.
      protected Heatmap processData​(Heatmap data)
      Performs the actual filtering.
      String rotationTipText()
      Returns the tip text for this property.
      void setRotation​(HeatmapRotate.Rotation value)
      Sets the type of rotation to perform.

      • 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

      • HeatmapRotate

        public HeatmapRotate()

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

      • setRotation

        public void setRotation​(HeatmapRotate.Rotation value)
        Sets the type of rotation to perform.
        Parameters:
        value - the type

      • getRotation

        public HeatmapRotate.Rotation getRotation()
        Returns the type of rotation to perform.
        Returns:
        the type

      • rotationTipText

        public String rotationTipText()
        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 Heatmap processData​(Heatmap data)
        Performs the actual filtering.
        Specified by:
        processData in class adams.data.filter.AbstractFilter<Heatmap>
        Parameters:
        data - the data to filter
        Returns:
        the filtered data