Package adams.flow.sink

Class ImageSegmentationViewer

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ClearableDisplay, DisplayTypeSupporter, ErrorHandler, InputConsumer, ComponentSupplier, DisplayPanelProvider, MenuBarProvider, SendToActionSupporter, Serializable, Comparable
    public class ImageSegmentationViewer
extends AbstractGraphicalDisplay
implements DisplayPanelProvider
    Displays image segmentation containers.

    Input/output:
    - accepts:
       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
    min-user-mode: Expert
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: ImageSegmentationViewer
 
    -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
 
    -display-type <adams.flow.core.displaytype.AbstractDisplayType> (property: displayType)
    Determines how to show the display, eg as standalone frame (default) or
    in the Flow editor window.
    default: adams.flow.core.displaytype.Default
 
    -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: -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
 
    -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
 
    -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
    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_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.

    • Constructor Detail

      • ImageSegmentationViewer

        public ImageSegmentationViewer()

    • Method Detail

      • getDefaultWidth

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

      • getDefaultHeight

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

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

      • setColorProvider

        public void setColorProvider​(ColorProvider value)
        Sets the color provider to use.
        Parameters:
        value - the color provider

      • getColorProvider

        public ColorProvider getColorProvider()
        Returns the color provider in use.
        Returns:
        the color provider

      • colorProviderTipText

        public String colorProviderTipText()
        Returns the tip text for this property.
        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.

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

      • 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

      • display

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

      • createDisplayPanel

        public DisplayPanel createDisplayPanel​(Token token)
        Creates a new panel for the token.
        Specified by:
        createDisplayPanel in interface 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 DisplayPanelProvider
        Returns:
        true if the display panel requires a scroll pane