Package adams.flow.transformer

Class ImageLabeler

  • 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 ImageLabeler
extends AbstractInteractiveTransformerDialog
implements FlowControlButtonsSupporter
    Allows the user to label images, setting a report field in the meta-data.
    Any logged interaction will get added as JSON under interaction-log in the report.

    Input/output:
    - accepts:
       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: ImageLabeler
 
    -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
 
    -field <adams.data.report.Field> (property: field)
    The field to use for the chosen label, must be of type S.
    default: Classification[S]
 
    -label <adams.core.base.BaseString> [-label ...] (property: labels)
    The labels to use.
    default:
 
    -use-buttons <boolean> (property: useButtons)
    If enabled, buttons are used for selecting the label rather than a drop-down
    list.
    default: true
 
    -overlay <adams.gui.visualization.object.overlay.ClassificationLabelTextOverlay> (property: overlay)
    The overlay to use.
    default: adams.gui.visualization.object.overlay.ClassificationLabelTextOverlay
 
    -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
 
    -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_Field

        protected Field m_Field
        the field to use in the report.

      • m_Labels

        protected BaseString[] m_Labels
        the labels.

      • m_UseButtons

        protected boolean m_UseButtons
        whether to use buttons or drop-down list.

      • 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_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_Accepted

        protected boolean m_Accepted
        whether the dialog got accepted.

      • m_StartTimestamp

        protected transient Date m_StartTimestamp
        the start timestamp.

      • m_ToolOptionsUpdatedListener

        protected ChangeListener m_ToolOptionsUpdatedListener
        the listener for when tool options change.

    • Constructor Detail

      • ImageLabeler

        public ImageLabeler()

    • Method Detail

      • setField

        public void setField​(Field value)
        Sets the field to use for the label.
        Parameters:
        value - the field

      • getField

        public Field getField()
        Returns the field to use for the label.
        Returns:
        the field

      • fieldTipText

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

      • setLabels

        public void setLabels​(BaseString[] value)
        Sets the labels to use.
        Parameters:
        value - the labels

      • getLabels

        public BaseString[] getLabels()
        Returns the labels to use.
        Returns:
        the labels

      • labelsTipText

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

      • setUseButtons

        public void setUseButtons​(boolean value)
        Sets the labels to use.
        Parameters:
        value - the labels

      • getUseButtons

        public boolean getUseButtons()
        Returns whether to use buttons instead of drop-down list.
        Returns:
        true if to use buttons

      • useButtonsTipText

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

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

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

      • 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

      • addInterationsToReport

        protected void addInterationsToReport​(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