Package adams.flow.sink

Class ObjectLocationComparison

  • All Implemented Interfaces:
    AdditionalInformationHandler, ClassCrossReference, CleanUpHandler, CrossReference, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ClearableDisplay, DisplayTypeSupporter, ErrorHandler, FlowControlSubMenuSupporter, HeadlessExecutionSupporter, InputConsumer, ComponentSupplier, MenuBarProvider, SendToActionSupporter, Serializable, Comparable
    public class ObjectLocationComparison
extends AbstractGraphicalDisplay
implements ClassCrossReference
    For visualizing differences between object locations, annotations vs predictions.

    See also:
    adams.flow.transformer.CompareObjectLocations

    Input/output:
    - accepts:
       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: ObjectLocationComparison
 
    -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
    min-user-mode: Expert
 
    -width <int> (property: width)
    The width of the dialog.
    default: 800
    minimum: -1
 
    -height <int> (property: height)
    The height of the dialog.
    default: 600
    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
 
    -show-flow-control-submenu <boolean> (property: showFlowControlSubMenu)
    If enabled, adds a flow control sub-menu to the menubar.
    default: false
    min-user-mode: Expert
 
    -annotations-storage-name <adams.flow.control.StorageName> (property: annotationsStorageName)
    The name of the storage item containing the annotations (ground truth).
    default: storage
 
    -annotations-prefix <java.lang.String> (property: annotationsPrefix)
    The object prefix that the annotations use.
    default: Object.
 
    -annotations-label-suffix <java.lang.String> (property: annotationsLabelSuffix)
    The report suffix that the annotations use for storing the label.
    default: type
 
    -predictions-storage-name <adams.flow.control.StorageName> (property: predictionsStorageName)
    The name of the storage item containing the predictions.
    default: storage
 
    -predictions-prefix <java.lang.String> (property: predictionsPrefix)
    The object prefix that the predictions use.
    default: Object.
 
    -predictions-label-suffix <java.lang.String> (property: predictionsLabelSuffix)
    The report suffix that the predictions use for storing the label.
    default: type
 
    -comparison <adams.flow.sink.objectlocationcomparison.AbstractComparison> (property: comparison)
    The comparison view to use.
    default: adams.flow.sink.objectlocationcomparison.SideBySide -annotations-overlay \"adams.gui.visualization.image.ObjectLocationsOverlayFromReport -type-color-provider adams.gui.visualization.core.DefaultColorProvider -shape-color-provider \\\"adams.gui.visualization.core.TranslucentColorProvider -provider adams.gui.visualization.core.DefaultColorProvider\\\"\" -predictions-overlay \"adams.gui.visualization.image.ObjectLocationsOverlayFromReport -type-color-provider adams.gui.visualization.core.DefaultColorProvider -shape-color-provider \\\"adams.gui.visualization.core.TranslucentColorProvider -provider adams.gui.visualization.core.DefaultColorProvider\\\"\"
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_AnnotationsStorageName

        protected StorageName m_AnnotationsStorageName
        the storage item with the annotations.

      • m_AnnotationsPrefix

        protected String m_AnnotationsPrefix
        the annotations object prefix.

      • m_AnnotationsLabelSuffix

        protected String m_AnnotationsLabelSuffix
        the annotations label suffix.

      • m_PredictionsStorageName

        protected StorageName m_PredictionsStorageName
        the storage item with the predictions.

      • m_PredictionsPrefix

        protected String m_PredictionsPrefix
        the predictions object prefix.

      • m_PredictionsLabelSuffix

        protected String m_PredictionsLabelSuffix
        the predictions label suffix.

    • Constructor Detail

      • ObjectLocationComparison

        public ObjectLocationComparison()

    • Method Detail

      • setAnnotationsStorageName

        public void setAnnotationsStorageName​(StorageName value)
        Sets the storage item containing the annotations.
        Parameters:
        value - the name

      • getAnnotationsStorageName

        public StorageName getAnnotationsStorageName()
        Returns the storage item containing the annotations.
        Returns:
        the name

      • annotationsStorageNameTipText

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

      • setAnnotationsPrefix

        public void setAnnotationsPrefix​(String value)
        Sets the object prefix to use for the annotations.
        Parameters:
        value - the object prefix

      • getAnnotationsPrefix

        public String getAnnotationsPrefix()
        Returns the object prefix to use for the annotations.
        Returns:
        the object prefix

      • annotationsPrefixTipText

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

      • setAnnotationsLabelSuffix

        public void setAnnotationsLabelSuffix​(String value)
        Sets the report suffix that the annotations use for storing the label.
        Parameters:
        value - the suffix

      • getAnnotationsLabelSuffix

        public String getAnnotationsLabelSuffix()
        Returns the report suffix that the annotations use for storing the label.
        Returns:
        the suffix

      • annotationsLabelSuffixTipText

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

      • setPredictionsStorageName

        public void setPredictionsStorageName​(StorageName value)
        Sets the storage item containing the predictions.
        Parameters:
        value - the name

      • getPredictionsStorageName

        public StorageName getPredictionsStorageName()
        Returns the storage item containing the predictions.
        Returns:
        the name

      • predictionsStorageNameTipText

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

      • setPredictionsPrefix

        public void setPredictionsPrefix​(String value)
        Sets the object prefix to use for the predictions.
        Parameters:
        value - the object prefix

      • getPredictionsPrefix

        public String getPredictionsPrefix()
        Returns the object prefix to use for the predictions.
        Returns:
        the object prefix

      • predictionsPrefixTipText

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

      • setPredictionsLabelSuffix

        public void setPredictionsLabelSuffix​(String value)
        Sets the report suffix that the predictions use for storing the label.
        Parameters:
        value - the suffix

      • getPredictionsLabelSuffix

        public String getPredictionsLabelSuffix()
        Returns the report suffix that the predictions use for storing the label.
        Returns:
        the suffix

      • predictionsLabelSuffixTipText

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

      • setComparison

        public void setComparison​(AbstractComparison value)
        Sets the comparison view to use.
        Parameters:
        value - the comparison

      • getComparison

        public AbstractComparison getComparison()
        Returns the comparison view to use.
        Returns:
        the comparison

      • comparisonTipText

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