Package adams.gui.visualization.object.tools

Class SAM

  • All Implemented Interfaces:
    adams.core.CleanUpHandler, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.SizeOfHandler, adams.gui.visualization.object.tools.CustomizableTool, adams.gui.visualization.object.tools.Tool, Serializable
    public class SAM
extends AbstractRedisTool<String,​String>
    Uses SAN (via docker and redis) to aid human in annotating.
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_TextMarkerSize

        protected adams.gui.core.NumberTextField m_TextMarkerSize
        the marker size.

      • m_PanelColor

        protected adams.gui.chooser.ColorChooserPanel m_PanelColor
        the marker color.

      • m_TextMinObjectSize

        protected adams.gui.core.NumberTextField m_TextMinObjectSize
        the minimum object size (width/height).

      • m_TextMaxObjectSize

        protected adams.gui.core.NumberTextField m_TextMaxObjectSize
        the maximum object size (width/height).

      • m_CheckBoxForeground

        protected adams.gui.core.BaseCheckBox m_CheckBoxForeground
        whether foreground or background.

      • m_MarkerSize

        protected int m_MarkerSize
        the marker size.

      • m_MarkerColor

        protected Color m_MarkerColor
        the marker color.

      • m_MinObjectSize

        protected int m_MinObjectSize
        the minimum object size (width/height).

      • m_MaxObjectSize

        protected int m_MaxObjectSize
        the maximum object size (width/height).

      • m_Foreground

        protected boolean m_Foreground
        whether foreground.

      • m_BaseImageBase64

        protected transient String m_BaseImageBase64
        the cached base image as base64 JPEG.

      • m_Points

        protected List<Point> m_Points
        the points to send.

      • m_Annotator

        protected SAMMarkers m_Annotator
        the internally used annotator.

    • Constructor Detail

      • SAM

        public SAM()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Returns:
        a description suitable for displaying in the gui

      • initialize

        protected void initialize()
        Initializes the members.
        Overrides:
        initialize in class adams.gui.visualization.object.tools.AbstractTool

      • getName

        public String getName()
        The name of the tool.
        Returns:
        the name

      • getIcon

        public Icon getIcon()
        The icon of the tool.
        Returns:
        the icon

      • createCursor

        protected Cursor createCursor()
        Creates the mouse cursor to use.
        Specified by:
        createCursor in class adams.gui.visualization.object.tools.AbstractTool
        Returns:
        the cursor

      • createMouseListener

        protected adams.gui.visualization.object.tools.ToolMouseAdapter createMouseListener()
        Creates the mouse listener to use.
        Specified by:
        createMouseListener in class adams.gui.visualization.object.tools.AbstractTool
        Returns:
        the listener, null if not applicable

      • createMouseMotionListener

        protected adams.gui.visualization.object.tools.ToolMouseMotionAdapter createMouseMotionListener()
        Creates the mouse motion listener to use.
        Specified by:
        createMouseMotionListener in class adams.gui.visualization.object.tools.AbstractTool
        Returns:
        the listener, null if not applicable

      • createKeyListener

        protected adams.gui.visualization.object.tools.ToolKeyAdapter createKeyListener()
        Creates the key listener to use.
        Overrides:
        createKeyListener in class adams.gui.visualization.object.tools.AbstractTool
        Returns:
        the listener, null if not applicable

      • checkBeforeApply

        protected String checkBeforeApply()
        Checks the parameters before applying them.
        Overrides:
        checkBeforeApply in class AbstractRedisTool<String,​String>
        Returns:
        null if checks passed, otherwise error message (gets displayed in GUI)

      • addOptions

        protected void addOptions​(adams.gui.core.ParameterPanel paramPanel)
        Fills the parameter panel with the options.
        Overrides:
        addOptions in class AbstractRedisTool<String,​String>
        Parameters:
        paramPanel - for adding the options to

      • setPoints

        public void setPoints​(List<Point> value)
        Sets the points to send.
        Parameters:
        value - the points

      • getPoints

        public List<Point> getPoints()
        Returns the points to send.
        Returns:
        the point, null if none set

      • assembleSendData

        protected String assembleSendData​(adams.core.MessageCollection errors)
        Method that assembles the data to send.
        Specified by:
        assembleSendData in class AbstractRedisTool<String,​String>
        Parameters:
        errors - for collecting errors
        Returns:
        the data to send (String or byte[])

      • parseReceivedData

        protected void parseReceivedData​(String data,
                                 adams.core.MessageCollection errors)
        Parses the received data and updates the GUI.
        Specified by:
        parseReceivedData in class AbstractRedisTool<String,​String>
        Parameters:
        data - the data to parse (String or byte[])
        errors - for collecting errors

      • activate

        public void activate()
        Gets called to activate the tool.
        Specified by:
        activate in interface adams.gui.visualization.object.tools.Tool
        Overrides:
        activate in class adams.gui.visualization.object.tools.AbstractTool