Package adams.flow.transformer

Class HeatmapLocateObjects

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.ArrayProvider, 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.ArrayProvider, adams.flow.core.ErrorHandler, adams.flow.core.InputConsumer, adams.flow.core.OutputProducer, Serializable, Comparable
    public class HeatmapLocateObjects
extends adams.flow.transformer.AbstractArrayProvider
    Locates objects in a heatmap and forwards a sub-heatmap per located object, cropped around the object.
    It is also possible to simply annotate the heatmap by storing the locations of the located objects in the report.

    Input/output:
    - accepts:
       adams.data.heatmap.Heatmap
    - generates:
       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: HeatmapLocateObjects
 
    -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
 
    -output-array <boolean> (property: outputArray)
    Outputs the heatmaps either one by one or as array.
    default: false
 
    -conversion <adams.data.conversion.HeatmapToBufferedImage> (property: conversion)
    The conversion for turning the heatmap into an image before applying the 
    locator algorithm.
    default: adams.data.conversion.HeatmapToBufferedImage -generator adams.gui.visualization.core.BiColorGenerator
 
    -locator <adams.flow.transformer.locateobjects.AbstractObjectLocator> (property: locator)
    The algorithm for locating the objects.
    default: adams.flow.transformer.locateobjects.PassThrough
 
    -generate-report <boolean> (property: generateReport)
    If enabled, an annotated heatmap containing a report with all the locations 
    is generated instead of separate heatmap objects.
    default: false
 
    -prefix <java.lang.String> (property: prefix)
    The report field prefix to use when generating a report.
    default: Object.
    Version:
    $Revision: 78 $
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String BACKUP_QUEUE
      the key for storing the current heatmaps in the backup.
      static String FIELD_HEIGHT
      the key for storing the height in the report.
      static String FIELD_WIDTH
      the key for storing the width in the report.
      static String FIELD_X
      the key for storing the X position (top-left corner) in the report.
      static String FIELD_Y
      the key for storing the Y position (top-left corner) in the report.
      protected HeatmapToBufferedImage m_Conversion
      for converting the heatmap into an image.
      protected boolean m_GenerateReport
      whether to generate an annotated image rather than single heatmap objects.
      protected adams.flow.transformer.locateobjects.AbstractObjectLocator m_Locator
      the algorithm to use.
      protected String m_Prefix
      the prefix to use when generating a report.

      • Fields inherited from class adams.flow.transformer.AbstractArrayProvider

        BACKUP_INDEX, m_Index, m_OutputArray, m_Queue

      • Fields inherited from class adams.flow.transformer.AbstractTransformer

        BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

      • 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Class[] accepts()
      Returns the class that the consumer accepts.
      String conversionTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      protected String doExecute()
      Executes the flow item.
      String generateReportTipText()
      Returns the tip text for this property.
      HeatmapToBufferedImage getConversion()
      Returns the conversion to use for converting the heatmap into an image for the locator.
      boolean getGenerateReport()
      Returns whether to generate an annotated heatmap with a report of all positions instead of separate heatmap objects.
      protected Class getItemClass()
      Returns the base class of the items.
      adams.flow.transformer.locateobjects.AbstractObjectLocator getLocator()
      Returns the scheme to use for locating the objects.
      String getPrefix()
      Returns the field prefix to use when generating a report.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      String globalInfo()
      Returns a string describing the object.
      String locatorTipText()
      Returns the tip text for this property.
      String outputArrayTipText()
      Returns the tip text for this property.
      String prefixTipText()
      Returns the tip text for this property.
      void setConversion​(HeatmapToBufferedImage value)
      Sets the conversion for converting the heatmap into an image for the locator.
      void setGenerateReport​(boolean value)
      Sets whether to generate an annotated heatmap with a report of all positions instead of separate heatmap objects.
      void setLocator​(adams.flow.transformer.locateobjects.AbstractObjectLocator value)
      Sets the scheme for locating the objects.
      void setPrefix​(String value)
      Sets the field prefix to use when generating a report.
      void stopExecution()
      Stops the execution.

      • Methods inherited from class adams.flow.transformer.AbstractArrayProvider

        backupState, generates, getOutputArray, hasPendingOutput, output, preExecute, pruneBackup, reset, restoreState, setOutputArray, wrapUp

      • Methods inherited from class adams.flow.transformer.AbstractTransformer

        currentInput, execute, hasInput, input, postExecute

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

        annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, 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, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, 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, toCommandLine, variableChanged

      • Methods inherited from interface adams.core.AdditionalInformationHandler

        getAdditionalInformation

      • 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

      • BACKUP_QUEUE

        public static final String BACKUP_QUEUE
        the key for storing the current heatmaps in the backup.
        See Also:
        Constant Field Values

      • FIELD_X

        public static final String FIELD_X
        the key for storing the X position (top-left corner) in the report.
        See Also:
        Constant Field Values

      • FIELD_Y

        public static final String FIELD_Y
        the key for storing the Y position (top-left corner) in the report.
        See Also:
        Constant Field Values

      • m_Locator

        protected adams.flow.transformer.locateobjects.AbstractObjectLocator m_Locator
        the algorithm to use.

      • m_GenerateReport

        protected boolean m_GenerateReport
        whether to generate an annotated image rather than single heatmap objects.

      • m_Prefix

        protected String m_Prefix
        the prefix to use when generating a report.

    • Constructor Detail

      • HeatmapLocateObjects

        public HeatmapLocateObjects()

    • 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.transformer.AbstractArrayProvider

      • outputArrayTipText

        public String outputArrayTipText()
        Returns the tip text for this property.
        Specified by:
        outputArrayTipText in interface adams.core.ArrayProvider
        Specified by:
        outputArrayTipText in interface adams.flow.core.ArrayProvider
        Specified by:
        outputArrayTipText in class adams.flow.transformer.AbstractArrayProvider
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setConversion

        public void setConversion​(HeatmapToBufferedImage value)
        Sets the conversion for converting the heatmap into an image for the locator.
        Parameters:
        value - the conversion

      • getConversion

        public HeatmapToBufferedImage getConversion()
        Returns the conversion to use for converting the heatmap into an image for the locator.
        Returns:
        the conversion

      • conversionTipText

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

      • setLocator

        public void setLocator​(adams.flow.transformer.locateobjects.AbstractObjectLocator value)
        Sets the scheme for locating the objects.
        Parameters:
        value - the scheme

      • getLocator

        public adams.flow.transformer.locateobjects.AbstractObjectLocator getLocator()
        Returns the scheme to use for locating the objects.
        Returns:
        the scheme

      • locatorTipText

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

      • setGenerateReport

        public void setGenerateReport​(boolean value)
        Sets whether to generate an annotated heatmap with a report of all positions instead of separate heatmap objects.
        Parameters:
        value - true of to generate report

      • getGenerateReport

        public boolean getGenerateReport()
        Returns whether to generate an annotated heatmap with a report of all positions instead of separate heatmap objects.
        Returns:
        true if to generate report

      • generateReportTipText

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

      • setPrefix

        public void setPrefix​(String value)
        Sets the field prefix to use when generating a report.
        Parameters:
        value - the field prefix

      • getPrefix

        public String getPrefix()
        Returns the field prefix to use when generating a report.
        Returns:
        the field prefix

      • prefixTipText

        public String prefixTipText()
        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.AbstractActor
        Returns:
        null if no info available, otherwise short string

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        the Class of objects that can be processed

      • getItemClass

        protected Class getItemClass()
        Returns the base class of the items.
        Specified by:
        getItemClass in class adams.flow.transformer.AbstractArrayProvider
        Returns:
        the class

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class adams.flow.core.AbstractActor
        Returns:
        null if everything is fine, otherwise error message

      • stopExecution

        public void stopExecution()
        Stops the execution. No message set.
        Specified by:
        stopExecution in interface adams.flow.core.Actor
        Specified by:
        stopExecution in interface adams.core.Stoppable
        Overrides:
        stopExecution in class adams.flow.core.AbstractActor