Package adams.flow.transformer

Class ImageObjectAnnotator

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, FlowControlButtonsSupporter, InputConsumer, InteractiveActor, OutputProducer, StopModeSupporter, Serializable, Comparable
    public class ImageObjectAnnotator
extends AbstractInteractiveTransformerDialog
implements FlowControlButtonsSupporter
    User interface for annotating objects in images.

    Input/output:
    - accepts:
       java.awt.image.BufferedImage
       adams.data.image.AbstractImageContainer
    - generates:
       adams.data.image.AbstractImageContainer


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    min-user-mode: Expert
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: ImageObjectAnnotator
 
    -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 execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
    min-user-mode: Expert
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
    min-user-mode: Expert
 
    -short-title <boolean> (property: shortTitle)
    If enabled uses just the name for the title instead of the actor's full
    name.
    default: false
 
    -width <int> (property: width)
    The width of the dialog.
    default: 1200
    minimum: 1
 
    -height <int> (property: height)
    The height of the dialog.
    default: 800
    minimum: 1
 
    -x <int> (property: x)
    The X position of the dialog (>=0: absolute, -1: left, -2: center, -3: right
    ).
    default: -2
    minimum: -3
 
    -y <int> (property: y)
    The Y position of the dialog (>=0: absolute, -1: top, -2: center, -3: bottom
    ).
    default: -2
    minimum: -3
 
    -stop-if-canceled <boolean> (property: stopFlowIfCanceled)
    If enabled, the flow gets stopped in case the user cancels the dialog.
    default: false
 
    -custom-stop-message <java.lang.String> (property: customStopMessage)
    The custom stop message to use in case a user cancelation stops the flow
    (default is the full name of the actor)
    default:
 
    -stop-mode <GLOBAL|STOP_RESTRICTOR> (property: stopMode)
    The stop mode to use.
    default: GLOBAL
 
    -annotations-display <adams.gui.visualization.object.annotationsdisplay.AbstractAnnotationsDisplayGenerator> (property: annotationsDisplay)
    The generator to use for instantiating the annotations display.
    default: adams.gui.visualization.object.annotationsdisplay.DefaultAnnotationsDisplayGenerator
 
    -annotator <adams.gui.visualization.object.annotator.AbstractAnnotator> (property: annotator)
    The annotator to use.
    default: adams.gui.visualization.object.annotator.BoundingBoxAnnotator
 
    -label-selector <adams.gui.visualization.object.labelselector.AbstractLabelSelectorGenerator> (property: labelSelector)
    The generator for creating the panel with the labels.
    default: adams.gui.visualization.object.labelselector.ButtonSelectorGenerator
 
    -mouse-click <adams.gui.visualization.object.mouseclick.AbstractMouseClickProcessor> (property: mouseClick)
    The processor for handling mouse clicks.
    default: adams.gui.visualization.object.mouseclick.NullProcessor
 
    -overlay <adams.gui.visualization.object.overlay.Overlay> (property: overlay)
    The overlay to use for visualizing the annotations.
    default: adams.gui.visualization.object.overlay.ObjectLocationsOverlayFromReport -type-color-provider adams.gui.visualization.core.DefaultColorProvider
 
    -annotation-check <adams.gui.visualization.object.objectannotations.check.AnnotationCheck> (property: annotationCheck)
    The check to apply to the annotations before enabling the OK button.
    default: adams.gui.visualization.object.objectannotations.check.PassThrough
 
    -left-divider-location <int> (property: leftDividerLocation)
    The position for the left divider in pixels.
    default: 200
    minimum: 1
 
    -right-divider-location <int> (property: rightDividerLocation)
    The position for the right divider in pixels.
    default: 900
    minimum: 1
 
    -zoom <double> (property: zoom)
    The zoom level in percent.
    default: 100.0
    minimum: 1.0
    maximum: 1600.0
 
    -best-fit <boolean> (property: bestFit)
    If enabled, the image gets fitted into the viewport.
    default: false
 
    -interaction-logging-filter <adams.gui.visualization.image.interactionlogging.InteractionLoggingFilter> (property: interactionLoggingFilter)
    The interaction logger to use.
    default: adams.gui.visualization.image.interactionlogging.Null
 
    -allow-using-previous-report <boolean> (property: allowUsingPreviousReport)
    If enabled, allows the user to make use of the previous report (ie annotations
    ); useful when annotations do not change much between images.
    default: false
 
    -max-undo <int> (property: maxUndo)
    The maximum undo steps to allow, use -1 for unlimited 0 to turn off (CAUTION:
     uses copies of images in memory).
    default: 100
    minimum: -1
 
    -tool-options-restore <adams.core.io.PlaceholderFile> (property: toolOptionsRestore)
    The JSON file to store the tool options in for restoring it the next time
    the actor gets called; ignored if pointing to a directory.
    default: ${CWD}
 
    -show-flow-control-buttons <boolean> (property: showFlowControlButtons)
    If enabled, shows the 'stop flow' button.
    default: false
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Overlay

        protected Overlay m_Overlay
        the overlay to use.

      • m_AnnotationCheck

        protected AnnotationCheck m_AnnotationCheck
        the annotation check to apply.

      • m_LeftDividerLocation

        protected int m_LeftDividerLocation
        the position for the left divider.

      • m_RightDividerLocation

        protected int m_RightDividerLocation
        the position for the right divider.

      • m_Zoom

        protected double m_Zoom
        the zoom level.

      • m_BestFit

        protected boolean m_BestFit
        whether to use best fit.

      • m_InteractionLoggingFilter

        protected InteractionLoggingFilter m_InteractionLoggingFilter
        the interaction logger to use.

      • m_AllowUsingPreviousReport

        protected boolean m_AllowUsingPreviousReport
        whether to allow using the previous report.

      • m_MaxUndo

        protected int m_MaxUndo
        the maximum undo steps.

      • m_ToolOptionsRestore

        protected PlaceholderFile m_ToolOptionsRestore
        the json file to store the tool options in.

      • m_ShowFlowControlButtons

        protected boolean m_ShowFlowControlButtons
        whether to show the flow control buttons.

      • m_ToolOptionsUpdatedListener

        protected ChangeListener m_ToolOptionsUpdatedListener
        the listener for when tool options change.

      • m_Accepted

        protected boolean m_Accepted
        whether the dialog got accepted.

      • m_StartTimestamp

        protected transient Date m_StartTimestamp
        the start timestamp.

      • m_PreviousReport

        protected Report m_PreviousReport
        the previous report.

      • m_PreviousLabel

        protected String m_PreviousLabel
        the previous label used.

      • m_ButtonOK

        protected BaseButton m_ButtonOK
        the OK button.

      • m_ButtonCancel

        protected BaseButton m_ButtonCancel
        the Cancel button.

      • m_ChangeListenerAnnotations

        protected ChangeListener m_ChangeListenerAnnotations
        the change listener for updating the OK button.

      • m_FirstInteraction

        protected boolean m_FirstInteraction
        whether this is the first interaction.

    • Constructor Detail

      • ImageObjectAnnotator

        public ImageObjectAnnotator()

    • Method Detail

      • setAnnotationsDisplay

        public void setAnnotationsDisplay​(AbstractAnnotationsDisplayGenerator value)
        Sets the generator for the annotations display.
        Parameters:
        value - the generator

      • annotationsDisplayTipText

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

      • setAnnotator

        public void setAnnotator​(AbstractAnnotator value)
        Sets the annotator to use.
        Parameters:
        value - the annotator

      • getAnnotator

        public AbstractAnnotator getAnnotator()
        Returns the annotator in use.
        Returns:
        the annotator

      • annotatorTipText

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

      • setLabelSelector

        public void setLabelSelector​(AbstractLabelSelectorGenerator value)
        Sets the generator to use for creating the panel with the labels.
        Parameters:
        value - the generator

      • getLabelSelector

        public AbstractLabelSelectorGenerator getLabelSelector()
        Returns the generator to use for creating the panel with the labels.
        Returns:
        the generator

      • labelSelectorTipText

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

      • setMouseClick

        public void setMouseClick​(AbstractMouseClickProcessor value)
        Sets the processor for mouse clicks.
        Parameters:
        value - the processor

      • mouseClickTipText

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

      • setOverlay

        public void setOverlay​(Overlay value)
        Sets the overlay for the annotations.
        Parameters:
        value - the overlay

      • getOverlay

        public Overlay getOverlay()
        Returns the overlay for the annotations.
        Returns:
        the overlay

      • overlayTipText

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

      • setAnnotationCheck

        public void setAnnotationCheck​(AnnotationCheck value)
        Sets the check to apply to the annotations before enabling the OK button.
        Parameters:
        value - the check

      • getAnnotationCheck

        public AnnotationCheck getAnnotationCheck()
        Returns the check to apply to the annotations before enabling the OK button.
        Returns:
        the check

      • annotationCheckTipText

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

      • setLeftDividerLocation

        public void setLeftDividerLocation​(int value)
        Sets the position for the left divider in pixels.
        Parameters:
        value - the position

      • getLeftDividerLocation

        public int getLeftDividerLocation()
        Returns the position for the left divider in pixels.
        Returns:
        the position

      • leftDividerLocationTipText

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

      • setRightDividerLocation

        public void setRightDividerLocation​(int value)
        Sets the position for the right divider in pixels.
        Parameters:
        value - the position

      • getRightDividerLocation

        public int getRightDividerLocation()
        Returns the position for the right divider in pixels.
        Returns:
        the position

      • rightDividerLocationTipText

        public String rightDividerLocationTipText()
        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, 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.

      • setBestFit

        public void setBestFit​(boolean value)
        Sets whether to use best fit for the image or not.
        Parameters:
        value - true if to use

      • getBestFit

        public boolean getBestFit()
        Returns whether to use best fit for the image or not.
        Returns:
        true if to use

      • bestFitTipText

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

      • setInteractionLoggingFilter

        public void setInteractionLoggingFilter​(InteractionLoggingFilter value)
        Sets the interaction logger to use.
        Parameters:
        value - the logger

      • getInteractionLoggingFilter

        public InteractionLoggingFilter getInteractionLoggingFilter()
        Returns the interaction logger in use.
        Returns:
        the logger

      • interactionLoggingFilterTipText

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

      • setAllowUsingPreviousReport

        public void setAllowUsingPreviousReport​(boolean value)
        Sets whether to allow using the previous report.
        Parameters:
        value - true if allowed

      • getAllowUsingPreviousReport

        public boolean getAllowUsingPreviousReport()
        Returns whether to allow using the previous report.
        Returns:
        true if allowed

      • allowUsingPreviousReportTipText

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

      • setMaxUndo

        public void setMaxUndo​(int value)
        Sets whether to allow using the previous report.
        Parameters:
        value - true if allowed

      • getMaxUndo

        public int getMaxUndo()
        Returns the maximum undo steps.
        Returns:
        the maximum (-1: unlimited, 0: off)

      • maxUndoTipText

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

      • setToolOptionsRestore

        public void setToolOptionsRestore​(PlaceholderFile value)
        Sets the JSON file to store the tool options in for restoring the next time the actor gets called. Ignored when pointing to a directory.
        Parameters:
        value - the file

      • getToolOptionsRestore

        public PlaceholderFile getToolOptionsRestore()
        Returns the JSON file to store the tool options in for restoring the next time the actor gets called. Ignored when pointing to a directory.
        Returns:
        the file

      • toolOptionsRestoreTipText

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

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        Returns:
        the Class of the generated tokens

      • checkAnnotations

        protected void checkAnnotations()
        Checks the annotations and updates the OK button accordingly.

      • addInteractionsToReport

        protected void addInteractionsToReport​(Report report,
                                       List<InteractionEvent> events)
        Adds the interactions to the report.
        Parameters:
        report - the report to add to
        events - the events to add, ignored if null