Package adams.gui.visualization.heatmap.overlay

Class HighestTemperature

  • 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.gui.visualization.image.AbstractImageOverlay>, adams.core.SizeOfHandler, adams.gui.visualization.image.ImageOverlay, Serializable
    public class HighestTemperature
extends AbstractSingleColorHeatmapOverlay
    Overlays the heatmap with the points that have the highest temperature. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -enabled <boolean> (property: enabled)
    If enabled, this overlay is painted over the image.
    default: true
 
    -color <java.awt.Color> (property: color)
    The color for the overlay.
    default: #ff0000
 
    -tolerance <double> (property: tolerance)
    The tolerance to apply to values to still consider them 'highest' temperature.
    default: 0.0
    minimum: 0.0
    Version:
    $Revision: 10480 $
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    HeatmapCentroid, Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected List<Point> m_Points
      the list of points with highest temperature.
      protected double m_Tolerance
      the tolerance in temperature to consider still "highest" temperature.

      • Fields inherited from class adams.gui.visualization.image.AbstractImageOverlay

        m_Enabled

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

        m_OptionManager

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      protected void doImageChanged​(adams.gui.visualization.image.ImagePanel.PaintPanel panel)
      Notifies the overlay that the image has changed.
      protected void doPaintOverlay​(adams.gui.visualization.image.ImagePanel.PaintPanel panel, Graphics g)
      Paints the overlay over the image.
      double getTolerance()
      Returns the tolerance.
      String globalInfo()
      Returns a string describing the object.
      protected void locate​(Heatmap map)
      Locates the points with the highest temperature.
      protected void reset()
      Resets the scheme.
      void setTolerance​(double value)
      Sets the tolerance.
      String toleranceTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.gui.visualization.image.AbstractImageOverlay

        cleanUp, enabledTipText, imageChanged, isEnabled, overlayAdded, overlayRemoved, setEnabled, shallowCopy, shallowCopy

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

        cleanUpOptions, destroy, 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.Destroyable

        destroy

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

        getLoggingLevel

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

        cleanUpOptions, getOptionManager, toCommandLine

    • Field Detail

      • m_Tolerance

        protected double m_Tolerance
        the tolerance in temperature to consider still "highest" temperature.

      • m_Points

        protected List<Point> m_Points
        the list of points with highest temperature.

    • Constructor Detail

      • HighestTemperature

        public HighestTemperature()

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

      • reset

        protected void reset()
        Resets the scheme.
        Overrides:
        reset in class adams.core.option.AbstractOptionHandler

      • setTolerance

        public void setTolerance​(double value)
        Sets the tolerance.
        Parameters:
        value - the tolerance

      • getTolerance

        public double getTolerance()
        Returns the tolerance.
        Returns:
        the tolerance

      • toleranceTipText

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

      • doImageChanged

        protected void doImageChanged​(adams.gui.visualization.image.ImagePanel.PaintPanel panel)
        Notifies the overlay that the image has changed.
        Specified by:
        doImageChanged in class adams.gui.visualization.image.AbstractImageOverlay
        Parameters:
        panel - the panel this overlay belongs to

      • locate

        protected void locate​(Heatmap map)
        Locates the points with the highest temperature.
        Parameters:
        map - the heatmap to use

      • doPaintOverlay

        protected void doPaintOverlay​(adams.gui.visualization.image.ImagePanel.PaintPanel panel,
                              Graphics g)
        Paints the overlay over the image.
        Specified by:
        doPaintOverlay in class adams.gui.visualization.image.AbstractImageOverlay
        Parameters:
        panel - the panel this overlay is for
        g - the graphics context