Package adams.data.filter.heatmapcrop

Class Rectangle

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable
    public class Rectangle
extends AbstractHeatmapCrop
    Crops the map to the specified rectangle x and y (both 1-based), width and height. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -x <int> (property: x)
    The row of the top-left corner, the starting point of the rectangle (1-based
    ).
    default: 1
    minimum: 1
 
    -y <int> (property: y)
    The column of the top-left corner, the starting point of the rectangle (
    1-based).
    default: 1
    minimum: 1
 
    -height <int> (property: height)
    The height of the rectangle.
    default: 240
    minimum: 1
 
    -width <int> (property: width)
    The width of the rectangle.
    default: 320
    minimum: 1
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected int m_Height
      the height of the submap.
      protected int m_Width
      the width of the submap.
      protected int m_X
      the row to start (top-left).
      protected int m_Y
      the column to start (top-left).

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      protected Heatmap doCrop​(Heatmap map)
      Performs the actual cropping.
      int getHeight()
      Returns the height of the rectangle.
      int getWidth()
      Returns the width of the submap.
      int getX()
      Returns the row start the rectangle from.
      int getY()
      Returns the column start the rectangle from.
      String globalInfo()
      Returns a string describing the object.
      String heightTipText()
      Returns the tip text for this property.
      void setHeight​(int value)
      Sets the height of the rectangle.
      void setWidth​(int value)
      Sets the width of the rectangle.
      void setX​(int value)
      Sets the row to start the rectangle from.
      void setY​(int value)
      Sets the column to start the rectangle from.
      String widthTipText()
      Returns the tip text for this property.
      String xTipText()
      Returns the tip text for this property.
      String yTipText()
      Returns the tip text for this property.

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

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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

    • Field Detail

      • m_X

        protected int m_X
        the row to start (top-left).

      • m_Y

        protected int m_Y
        the column to start (top-left).

      • m_Height

        protected int m_Height
        the height of the submap.

      • m_Width

        protected int m_Width
        the width of the submap.

    • Constructor Detail

      • Rectangle

        public Rectangle()

    • 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.core.option.AbstractOptionHandler

      • setX

        public void setX​(int value)
        Sets the row to start the rectangle from.
        Parameters:
        value - the row (top-left corner)

      • getX

        public int getX()
        Returns the row start the rectangle from.
        Returns:
        the row (top-left corner)

      • xTipText

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

      • setY

        public void setY​(int value)
        Sets the column to start the rectangle from.
        Parameters:
        value - the column (top-left corner)

      • getY

        public int getY()
        Returns the column start the rectangle from.
        Returns:
        the column (top-left corner)

      • yTipText

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

      • setHeight

        public void setHeight​(int value)
        Sets the height of the rectangle.
        Parameters:
        value - the height

      • getHeight

        public int getHeight()
        Returns the height of the rectangle.
        Returns:
        the height

      • heightTipText

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

      • setWidth

        public void setWidth​(int value)
        Sets the width of the rectangle.
        Parameters:
        value - the width

      • getWidth

        public int getWidth()
        Returns the width of the submap.
        Returns:
        the width

      • widthTipText

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

      • doCrop

        protected Heatmap doCrop​(Heatmap map)
        Performs the actual cropping.
        Specified by:
        doCrop in class AbstractHeatmapCrop
        Parameters:
        map - the map to crop
        Returns:
        the cropped heatmap