Package adams.flow.transformer

Class ImageSegmentationAnnotator

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

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


    Container information:
    - adams.flow.container.ImageSegmentationContainer: name, base, layers 

    -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: ImageSegmentationAnnotator
 
    -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
 
    -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
 
    -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
 
    -label <adams.core.base.BaseString> [-label ...] (property: labels)
    The labels to use.
    default:
 
    -color-provider <adams.gui.visualization.core.ColorProvider> (property: colorProvider)
    The color provider in use for generating the colors for the various layers.
    default: adams.gui.visualization.core.DefaultColorProvider
 
    -alpha <float> (property: alpha)
    The alpha value to use (fully transparent=0.0, fully opaque=1.0).
    default: 0.5
    minimum: 0.0
    maximum: 1.0
 
    -left-divider-location <int> (property: leftDividerLocation)
    The position for the left divider in pixels.
    default: 280
    minimum: 1
 
    -right-divider-location <int> (property: rightDividerLocation)
    The position for the right divider in pixels.
    default: 650
    minimum: 1
 
    -tool-button-columns <int> (property: toolButtonColumns)
    The number of columns to use for the tool buttons.
    default: 4
    minimum: 1
 
    -automatic-undo <boolean> (property: automaticUndo)
    For either using automatic undo or manual one; for large images, automatic
    undo can slow things down.
    default: true
 
    -max-undo <int> (property: maxUndo)
    The maximum undo steps to allow, use <=0 for unlimited (CAUTION: uses copies
    of images in memory).
    default: 100
    minimum: -1
 
    -zoom <double> (property: zoom)
    The zoom level in percent.
    default: 100.0
    minimum: 1.0
 
    -best-fit <boolean> (property: bestFit)
    If enabled, the image gets fitted into the viewport.
    default: false
 
    -use-separate-layers <boolean> (property: useSeparateLayers)
    If enabled, support for multiple layers is enabled (eg for annotating objects
    that do not touch/overlap).
    default: true
 
    -layer-visibility <ALL|NONE|PREVIOUSLY_VISIBLE> (property: layerVisibility)
    What layers will be visible when annotating the next image (when using separate
    layers).
    default: ALL
 
    -allow-layer-remove <boolean> (property: allowLayerRemoval)
    If enabled, the user can remove layers (when using separate layers).
    default: false
 
    -allow-layer-actions <boolean> (property: allowLayerActions)
    If enabled, the user has access to layer actions (when using separate layers
    ).
    default: false
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Labels

        protected BaseString[] m_Labels
        the labels to use.

      • m_ColorProvider

        protected ColorProvider m_ColorProvider
        the color provider to use.

      • m_Alpha

        protected float m_Alpha
        the alpha value.

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

        protected int m_ToolButtonColumns
        the number of columns to use for the tool buttons.

      • m_AutomaticUndo

        protected boolean m_AutomaticUndo
        whether to use automatic undo.

      • m_MaxUndo

        protected int m_MaxUndo
        the maximum undo steps.

      • m_Zoom

        protected double m_Zoom
        the zoom level.

      • m_BestFit

        protected boolean m_BestFit
        whether to use best fit.

      • m_UseSeparateLayers

        protected boolean m_UseSeparateLayers
        whether to use separate layers.

      • m_AllowLayerRemoval

        protected boolean m_AllowLayerRemoval
        whether layers can be deleted (when using separate layers).

      • m_AllowLayerActions

        protected boolean m_AllowLayerActions
        whether layer actions are available (when using separate layers).

      • m_Accepted

        protected boolean m_Accepted
        whether the dialog got accepted.

      • m_BestFitApplied

        protected boolean m_BestFitApplied
        whether best fit has been applied.

      • m_BestFitRedoneListener

        protected ChangeListener m_BestFitRedoneListener
        the change listener for when the best fit zoom got redone.

      • m_FirstInteraction

        protected boolean m_FirstInteraction
        whether this is the first interaction.

    • Constructor Detail

      • ImageSegmentationAnnotator

        public ImageSegmentationAnnotator()

    • Method Detail

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

      • colorProviderTipText

        public String colorProviderTipText()
        Returns the tip text for this property.
        Specified by:
        colorProviderTipText in interface ColorProviderHandler
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setAlpha

        public void setAlpha​(float value)
        Sets the alpha value to use.
        Parameters:
        value - the alpha (fully transparent=0.0, fully opaque=1.0)

      • getAlpha

        public float getAlpha()
        Returns the alpha value to use.
        Returns:
        the alpha (fully transparent=0.0, fully opaque=1.0)

      • alphaTipText

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

      • setToolButtonColumns

        public void setToolButtonColumns​(int value)
        Sets the number of columns to use for the tool buttons.
        Parameters:
        value - the columns

      • getToolButtonColumns

        public int getToolButtonColumns()
        Returns the number of columns to use for the tool buttons.
        Returns:
        the columns

      • toolButtonColumnsTipText

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

      • setAutomaticUndo

        public void setAutomaticUndo​(boolean value)
        Sets whether to use automatic or manual undo.
        Parameters:
        value - true if to use

      • getAutomaticUndo

        public boolean getAutomaticUndo()
        Returns whether to use automatic or manual undo.
        Returns:
        true if to use

      • automaticUndoTipText

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

      • setZoom

        public void setZoom​(double value)
        Sets the zoom level in percent (1-inf).
        Parameters:
        value - the zoom

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

      • setUseSeparateLayers

        public void setUseSeparateLayers​(boolean value)
        Sets whether to use separate layers or just one.
        Parameters:
        value - true if to use

      • getUseSeparateLayers

        public boolean getUseSeparateLayers()
        Returns whether to use separate layers or just one.
        Returns:
        true if to use

      • useSeparateLayersTipText

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

      • setLayerVisibility

        public void setLayerVisibility​(SegmentationPanel.LayerVisibility value)
        Sets the type of visibility to use when annotating the next image (when using separate layers).
        Parameters:
        value - the visibility

      • getLayerVisibility

        public SegmentationPanel.LayerVisibility getLayerVisibility()
        Returns the type of visibility to use when annotating the next image (when using separate layers).
        Returns:
        the visibility

      • layerVisibilityTipText

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

      • setAllowLayerRemoval

        public void setAllowLayerRemoval​(boolean value)
        Sets whether removal of layers is allowed (when using separate layers).
        Parameters:
        value - true if allowed

      • getAllowLayerRemoval

        public boolean getAllowLayerRemoval()
        Returns whether removal of layers is allowed (when using separate layers).
        Returns:
        true if allowed

      • allowLayerRemovalTipText

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

      • setAllowLayerActions

        public void setAllowLayerActions​(boolean value)
        Sets whether layer actions are available (when using separate layers).
        Parameters:
        value - true if allowed

      • getAllowLayerActions

        public boolean getAllowLayerActions()
        Returns whether layer actions are available (when using separate layers).
        Returns:
        true if allowed

      • allowLayerActionsTipText

        public String allowLayerActionsTipText()
        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