Package adams.flow.sink

Class HeatmapDisplay

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<adams.flow.core.Actor>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.core.VariablesInspectionHandler, adams.event.VariableChangeListener, adams.flow.core.Actor, adams.flow.core.ClearableDisplay, adams.flow.core.DisplayTypeSupporter, adams.flow.core.ErrorHandler, adams.flow.core.FlowControlSubMenuSupporter, adams.flow.core.HeadlessExecutionSupporter, adams.flow.core.InputConsumer, adams.flow.sink.ComponentSupplier, adams.flow.sink.DisplayPanelProvider, adams.gui.core.MenuBarProvider, adams.gui.sendto.SendToActionSupporter, Serializable, Comparable
    public class HeatmapDisplay
extends adams.flow.sink.AbstractGraphicalDisplay
implements adams.flow.sink.DisplayPanelProvider
    Actor that displays heatmaps.

    Input/output:
    - accepts:
       adams.data.heatmap.Heatmap


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: HeatmapDisplay
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console.
    default: false
 
    -short-title <boolean> (property: shortTitle)
    If enabled uses just the name for the title instead of the actor's full 
    name.
    default: false
 
    -display-in-editor <boolean> (property: displayInEditor)
    If enabled displays the panel in a tab in the flow editor rather than in 
    a separate frame.
    default: false
 
    -width <int> (property: width)
    The width of the dialog.
    default: 1000
    minimum: -1
 
    -height <int> (property: height)
    The height of the dialog.
    default: 700
    minimum: -1
 
    -x <int> (property: x)
    The X position of the dialog (>=0: absolute, -1: left, -2: center, -3: right
    ).
    default: -1
    minimum: -3
 
    -y <int> (property: y)
    The Y position of the dialog (>=0: absolute, -1: top, -2: center, -3: bottom
    ).
    default: -1
    minimum: -3
 
    -writer <adams.gui.print.JComponentWriter> (property: writer)
    The writer to use for generating the graphics output.
    default: adams.gui.print.NullWriter
 
    -color-generator <adams.gui.visualization.core.ColorGradientGenerator> (property: colorGenerator)
    The generator for the color gradient.
    default: adams.gui.visualization.core.BiColorGenerator
 
    -overlay <adams.gui.visualization.heatmap.overlay.AbstractHeatmapOverlay> [-overlay ...] (property: overlays)
    The overlay(s) to use.
    default: 
 
    -missing-value-color <java.awt.Color> (property: missingValueColor)
    The color to use for missing values.
    default: #00ffffff
 
    -zoom <double> (property: zoom)
    The zoom level in percent.
    default: 100.0
    minimum: -1.0
    maximum: 1600.0
 
    -show-report-table <boolean> (property: showReportTable)
    Determines the visibility of the report table.
    default: true
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.gui.visualization.core.ColorGradientGenerator m_ColorGenerator
      the generator for the color gradient.
      protected Color m_MissingValueColor
      the color for missing values.
      protected AbstractHeatmapOverlay[] m_Overlays
      the overlays to use.
      protected boolean m_ShowReportTable
      whether to show the report table.
      protected double m_Zoom
      the zoom level.

      • Fields inherited from class adams.flow.sink.AbstractGraphicalDisplay

        m_GraphicFileChooser, m_MenuBar, m_MenuItemFileClear, m_MenuItemFileClose, m_MenuItemFileSaveAs, m_MenuItemFileSaveTextAs, m_MenuItemFlowPauseResume, m_MenuItemFlowStop, m_ShowFlowControlSubMenu, m_TextFileChooser, m_Writer

      • Fields inherited from class adams.flow.core.AbstractDisplay

        BACKUP_INPUT, m_CreateFrame, m_DisplayType, m_Frame, m_Height, m_InputToken, m_KeepOpen, m_Panel, m_ResetGUIWaiting, m_ShortTitle, m_Updating, m_Width, m_X, m_Y

      • Fields inherited from class adams.flow.core.AbstractActor

        m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

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

        m_OptionManager

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

      • Fields inherited from interface adams.flow.core.Actor

        FILE_EXTENSION, FILE_EXTENSION_GZ

    • Constructor Summary

      Constructors 
      Constructor Description
      HeatmapDisplay()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Class[] accepts()
      Returns the class that the consumer accepts.
      void clearPanel()
      Clears the content of the panel.
      String colorGeneratorTipText()
      Returns the tip text for this property.
      adams.flow.sink.AbstractDisplayPanel createDisplayPanel​(adams.flow.core.Token token)
      Creates a new display panel for the token.
      void defineOptions()
      Adds options to the internal list of options.
      protected void display​(adams.flow.core.Token token)
      Displays the token (the panel and dialog have already been created at this stage).
      boolean displayPanelRequiresScrollPane()
      Returns whether the created display panel requires a scroll pane or not.
      adams.gui.visualization.core.ColorGradientGenerator getColorGenerator()
      Returns the generator for the color gradient.
      protected int getDefaultHeight()
      Returns the default height for the dialog.
      protected int getDefaultWidth()
      Returns the default width for the dialog.
      Color getMissingValueColor()
      Returns the color for missing values.
      AbstractHeatmapOverlay[] getOverlays()
      Returns the overlays to use.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      boolean getShowReportTable()
      Returns whether the report table is visible.
      double getZoom()
      Returns the zoom level in percent.
      String globalInfo()
      Returns a string describing the object.
      String missingValueColorTipText()
      Returns the tip text for this property.
      protected adams.gui.core.BasePanel newPanel()
      Creates the panel to display in the dialog.
      String overlaysTipText()
      Returns the tip text for this property.
      void setColorGenerator​(adams.gui.visualization.core.ColorGradientGenerator value)
      Sets the generator for the color gradient.
      void setMissingValueColor​(Color value)
      Sets the color for missing values.
      void setOverlays​(AbstractHeatmapOverlay[] value)
      Sets the overlays to use.
      void setShowReportTable​(boolean value)
      Sets whether the report value is visible.
      void setZoom​(double value)
      Sets the zoom level in percent (0-1600).
      String showReportTableTipText()
      Returns the tip text for this property.
      boolean supportsClear()
      Whether "clear" is supported and shows up in the menu.
      String zoomTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.flow.sink.AbstractGraphicalDisplay

        canPauseOrResume, cleanUpGUI, clear, close, createMenuBar, getGraphicFileChooser, getMenuBar, getSendToClasses, getSendToItem, getShowFlowControlSubMenu, getTextFileChooser, getWriter, hasPanel, hasSendToItem, isPaused, pauseResumeFlow, saveAs, saveTextAs, setShowFlowControlSubMenu, setWriter, showFlowControlSubMenuTipText, stopFlow, supplyComponent, updateMenu, wrapUp, writerTipText

      • Methods inherited from class adams.flow.sink.AbstractDisplay

        newDisplayRunnable, postDisplay, preDisplay

      • Methods inherited from class adams.flow.core.AbstractDisplay

        backupState, cleanUp, cleanUpGUIKeepOpen, closeDisplay, createFrame, createTitle, currentInput, deregisterInWrapUp, deregisterWindow, deregisterWithEditor, displayTypeTipText, doCreateFrame, doExecute, doExecuteHeadless, getCreateFrame, getDefaultDisplayType, getDefaultShortTitle, getDefaultX, getDefaultY, getDisplayType, getFrame, getFrameDefaultCloseOperation, getHeight, getKeepOpen, getPanel, getShortTitle, getWidth, getX, getY, hasInput, heightTipText, initialize, input, postCreateFrame, preCreateFrame, registerWindow, registerWithEditor, reset, restoreState, setCreateFrame, setDisplayType, setHeight, setKeepOpen, setShortTitle, setWidth, setX, setY, shortTitleTipText, stopExecution, supportsHeadlessExecution, widthTipText, xTipText, yTipText

      • Methods inherited from class adams.flow.core.AbstractActor

        annotationsTipText, canInspectOptions, canPerformSetUpCheck, compareTo, configureLogger, destroy, equals, execute, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

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

        cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

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

        getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

      • Methods inherited from interface adams.flow.core.Actor

        cleanUp, compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged, wrapUp

      • Methods inherited from interface adams.core.AdditionalInformationHandler

        getAdditionalInformation

      • Methods inherited from interface adams.flow.core.InputConsumer

        currentInput, hasInput, input

      • 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

      • Methods inherited from interface adams.core.VariablesInspectionHandler

        canInspectOptions

    • Field Detail

      • m_ColorGenerator

        protected adams.gui.visualization.core.ColorGradientGenerator m_ColorGenerator
        the generator for the color gradient.

      • m_MissingValueColor

        protected Color m_MissingValueColor
        the color for missing values.

      • m_Zoom

        protected double m_Zoom
        the zoom level.

      • m_ShowReportTable

        protected boolean m_ShowReportTable
        whether to show the report table.

    • Constructor Detail

      • HeatmapDisplay

        public HeatmapDisplay()

    • 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.flow.sink.AbstractGraphicalDisplay

      • getDefaultWidth

        protected int getDefaultWidth()
        Returns the default width for the dialog.
        Overrides:
        getDefaultWidth in class adams.flow.core.AbstractDisplay
        Returns:
        the default width

      • getDefaultHeight

        protected int getDefaultHeight()
        Returns the default height for the dialog.
        Overrides:
        getDefaultHeight in class adams.flow.core.AbstractDisplay
        Returns:
        the default height

      • setColorGenerator

        public void setColorGenerator​(adams.gui.visualization.core.ColorGradientGenerator value)
        Sets the generator for the color gradient.
        Parameters:
        value - the generator

      • getColorGenerator

        public adams.gui.visualization.core.ColorGradientGenerator getColorGenerator()
        Returns the generator for the color gradient.
        Returns:
        the generator

      • colorGeneratorTipText

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

      • setOverlays

        public void setOverlays​(AbstractHeatmapOverlay[] value)
        Sets the overlays to use.
        Parameters:
        value - the overlays

      • getOverlays

        public AbstractHeatmapOverlay[] getOverlays()
        Returns the overlays to use.
        Returns:
        the overlays

      • overlaysTipText

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

      • setMissingValueColor

        public void setMissingValueColor​(Color value)
        Sets the color for missing values.
        Parameters:
        value - the color

      • getMissingValueColor

        public Color getMissingValueColor()
        Returns the color for missing values.
        Returns:
        the color

      • missingValueColorTipText

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

      • setZoom

        public void setZoom​(double value)
        Sets the zoom level in percent (0-1600).
        Parameters:
        value - the zoom, -1 to fit window, or 0-1600

      • getZoom

        public double getZoom()
        Returns the zoom level in percent.
        Returns:
        the zoom

      • zoomTipText

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

      • setShowReportTable

        public void setShowReportTable​(boolean value)
        Sets whether the report value is visible.
        Parameters:
        value - true if visible

      • getShowReportTable

        public boolean getShowReportTable()
        Returns whether the report table is visible.
        Returns:
        true if visible

      • showReportTableTipText

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

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.flow.core.Actor
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class adams.flow.core.AbstractDisplay
        Returns:
        null if no info available, otherwise short string

      • supportsClear

        public boolean supportsClear()
        Whether "clear" is supported and shows up in the menu.
        Specified by:
        supportsClear in interface adams.flow.core.ClearableDisplay
        Overrides:
        supportsClear in class adams.flow.sink.AbstractGraphicalDisplay
        Returns:
        true if supported

      • clearPanel

        public void clearPanel()
        Clears the content of the panel.
        Specified by:
        clearPanel in class adams.flow.core.AbstractDisplay

      • newPanel

        protected adams.gui.core.BasePanel newPanel()
        Creates the panel to display in the dialog.
        Specified by:
        newPanel in class adams.flow.core.AbstractDisplay
        Returns:
        the panel

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface adams.flow.core.InputConsumer
        Returns:
        adams.data.heatmap.Heatmap.class

      • display

        protected void display​(adams.flow.core.Token token)
        Displays the token (the panel and dialog have already been created at this stage).
        Specified by:
        display in class adams.flow.sink.AbstractDisplay
        Parameters:
        token - the token to display

      • createDisplayPanel

        public adams.flow.sink.AbstractDisplayPanel createDisplayPanel​(adams.flow.core.Token token)
        Creates a new display panel for the token.
        Specified by:
        createDisplayPanel in interface adams.flow.sink.DisplayPanelProvider
        Parameters:
        token - the token to display in a new panel, can be null
        Returns:
        the generated panel

      • displayPanelRequiresScrollPane

        public boolean displayPanelRequiresScrollPane()
        Returns whether the created display panel requires a scroll pane or not.
        Specified by:
        displayPanelRequiresScrollPane in interface adams.flow.sink.DisplayPanelProvider
        Returns:
        true if the display panel requires a scroll pane