Package adams.gui.visualization.image

Class ObjectCentersOverlayFromReport

  • All Implemented Interfaces:
    CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractImageOverlay>, SizeOfHandler, PopupMenuCustomizer<ImagePanel.PaintPanel>, ImageOverlay, TypeColorProvider, Serializable
    public class ObjectCentersOverlayFromReport
extends AbstractObjectOverlayFromReport
    Displays the centers of objects in the image, using data from the attached report.
    Suffixes:
    .x
    .y
    .width
    .height
    Optionally, if type information is available per object, the locations can be displayed in distinct colors per type. The type itself can be displayed as well. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -enabled <boolean> (property: enabled)
    If enabled, this overlay is painted over the image.
    default: true
 
    -prefix <java.lang.String> (property: prefix)
    The prefix of fields in the report to identify as object location, eg 'Object.
    '.
    default: Object.
 
    -color <java.awt.Color> (property: color)
    The color to use for the objects.
    default: #ff0000
 
    -use-colors-per-type <boolean> (property: useColorsPerType)
    If enabled, individual colors per type are used.
    default: false
 
    -type-color-provider <adams.gui.visualization.core.ColorProvider> (property: typeColorProvider)
    The color provider to use for the various types.
    default: adams.gui.visualization.core.DefaultColorProvider
 
    -type-suffix <java.lang.String> (property: typeSuffix)
    The suffix of fields in the report to identify the type.
    default: .type
 
    -label-format <java.lang.String> (property: labelFormat)
    The label format string to use for the rectangles; '#' for index, '@' for
    type and '$' for short type (type suffix must be defined for '@' and '$'
    ); for instance: '# @'.
    default: #
 
    -label-font <java.awt.Font> (property: labelFont)
    The font to use for the labels.
    default: Display-PLAIN-14
 
    -diameter <int> (property: diameter)
    The diameter of the circle that is drawn; < 1 to use the rectangle's dimensions.
    default: 10
    minimum: -1
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Diameter

        protected double m_Diameter
        the diameter of the circle.

    • Constructor Detail

      • ObjectCentersOverlayFromReport

        public ObjectCentersOverlayFromReport()

    • Method Detail

      • setDiameter

        public void setDiameter​(double value)
        Sets the diameter to use for drawing the circle.
        Parameters:
        value - the diameter, -1 if using the rectangle's dimensions, (0-1) for fraction of bbox width

      • getDiameter

        public double getDiameter()
        Returns the diameter to use for drawing the circle.
        Returns:
        the diameter, -1 if using the rectangle's dimensions, (0-1) for fraction of bbox width

      • diameterTipText

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