Name

adams.flow.transformer.ImageObjectAnnotator

Synopsis

User interface for annotating objects in images.

Additional information

Flow input/output:
- input: java.awt.image.BufferedImage, adams.data.image.AbstractImageContainer
- output: adams.data.image.AbstractImageContainer

Interactive actor information:
- supports interaction in headless mode: no

Options

• loggingLevel
  

  The logging level for outputting errors and debugging output.

  command-line	-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST>
  default	WARNING
  min-user-mode	Expert

  
  
• name
  

  The name of the actor.

  command-line	-name <java.lang.String>
  default	ImageObjectAnnotator

  
  
• annotations
  

  The annotations to attach to this actor.

  command-line	-annotation <adams.core.base.BaseAnnotation>
  default

  
  
• skip
  

  If set to true, transformation is skipped and the input token is just forwarded as it is.

  command-line	-skip <boolean>
  default	false

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

  command-line	-stop-flow-on-error <boolean>
  default	false
  min-user-mode	Expert

  
  
• silent
  

  If enabled, then no errors are output in the console; Note: the enclosing actor handler must have this enabled as well.

  command-line	-silent <boolean>
  default	false
  min-user-mode	Expert

  
  
• shortTitle
  

  If enabled uses just the name for the title instead of the actor's full name.

  command-line	-short-title <boolean>
  default	false

  
  
• width
  

  The width of the dialog.

  command-line	-width <int>
  default	1200
  minimum	1

  
  
• height
  

  The height of the dialog.

  command-line	-height <int>
  default	800
  minimum	1

  
  
• x
  

  The X position of the dialog (>=0: absolute, -1: left, -2: center, -3: right).

  command-line	-x <int>
  default	-2
  minimum	-3

  
  
• y
  

  The Y position of the dialog (>=0: absolute, -1: top, -2: center, -3: bottom).

  command-line	-y <int>
  default	-2
  minimum	-3

  
  
• stopFlowIfCanceled
  

  If enabled, the flow gets stopped in case the user cancels the dialog.

  command-line	-stop-if-canceled <boolean>
  default	false

  
  
• customStopMessage
  

  The custom stop message to use in case a user cancelation stops the flow (default is the full name of the actor)

  command-line	-custom-stop-message <java.lang.String>
  default

  
  
• stopMode
  

  The stop mode to use.

  command-line	-stop-mode <GLOBAL|STOP_RESTRICTOR>
  default	GLOBAL

  
  
• annotationsDisplay
  

  The generator to use for instantiating the annotations display.

  command-line	-annotations-display <adams.gui.visualization.object.annotationsdisplay.AbstractAnnotationsDisplayGenerator>
  default	adams.gui.visualization.object.annotationsdisplay.DefaultAnnotationsDisplayGenerator

  
  
• annotator
  

  The annotator to use.

  command-line	-annotator <adams.gui.visualization.object.annotator.AbstractAnnotator>
  default	adams.gui.visualization.object.annotator.BoundingBoxAnnotator

  
  
• labelSelector
  

  The generator for creating the panel with the labels.

  command-line	-label-selector <adams.gui.visualization.object.labelselector.AbstractLabelSelectorGenerator>
  default	adams.gui.visualization.object.labelselector.ButtonSelectorGenerator

  
  
• mouseClick
  

  The processor for handling mouse clicks.

  command-line	-mouse-click <adams.gui.visualization.object.mouseclick.AbstractMouseClickProcessor>
  default	adams.gui.visualization.object.mouseclick.NullProcessor

  
  
• overlay
  

  The overlay to use for visualizing the annotations.

  command-line	-overlay <adams.gui.visualization.object.overlay.Overlay>
  default	adams.gui.visualization.object.overlay.ObjectLocationsOverlayFromReport -type-color-provider adams.gui.visualization.core.DefaultColorProvider

  
  
• annotationCheck
  

  The check to apply to the annotations before enabling the OK button.

  command-line	-annotation-check <adams.gui.visualization.object.objectannotations.check.AnnotationCheck>
  default	adams.gui.visualization.object.objectannotations.check.PassThrough

  
  
• leftDividerLocation
  

  The position for the left divider in pixels.

  command-line	-left-divider-location <int>
  default	200
  minimum	1

  
  
• rightDividerLocation
  

  The position for the right divider in pixels.

  command-line	-right-divider-location <int>
  default	900
  minimum	1

  
  
• zoom
  

  The zoom level in percent.

  command-line	-zoom <double>
  default	100.0
  minimum	1.0
  maximum	1600.0

  
  
• bestFit
  

  If enabled, the image gets fitted into the viewport.

  command-line	-best-fit <boolean>
  default	false

  
  
• interactionLoggingFilter
  

  The interaction logger to use.

  command-line	-interaction-logging-filter <adams.gui.visualization.image.interactionlogging.InteractionLoggingFilter>
  default	adams.gui.visualization.image.interactionlogging.Null

  
  
• allowUsingPreviousReport
  

  If enabled, allows the user to make use of the previous report (ie annotations); useful when annotations do not change much between images.

  command-line	-allow-using-previous-report <boolean>
  default	false

  
  
• maxUndo
  

  The maximum undo steps to allow, use -1 for unlimited 0 to turn off (CAUTION: uses copies of images in memory).

  command-line	-max-undo <int>
  default	100
  minimum	-1

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

  command-line	-tool-options-restore <adams.core.io.PlaceholderFile>
  default	${CWD}

  
  
• showFlowControlButtons
  

  If enabled, shows the 'stop flow' button.

  command-line	-show-flow-control-buttons <boolean>
  default	false