Class RemoveOutliersClickAction

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, adams.flow.sink.sequenceplotter.MouseClickAction, Serializable

    public class RemoveOutliersClickAction
    extends adams.flow.sink.sequenceplotter.AbstractMouseClickAction
    Allows the user to toggle the outlier state of data points to be removed.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.gui.visualization.sequence.AbstractXYSequencePointHitDetector m_HitDetector
      the hit detector to use.
      protected RemoveDataListener m_RemoveDataListener
      the listener for removing the data.
      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager
      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void clearOutliers​(adams.flow.sink.sequenceplotter.SequencePlotterPanel panel)
      Resets the outlier status of all points.
      void defineOptions()
      Adds options to the internal list of options.
      adams.gui.visualization.sequence.AbstractXYSequencePointHitDetector getHitDetector()
      Returns the hit detector to use.
      RemoveDataListener getRemoveDataListener()
      Returns the listener, if any.
      String globalInfo()
      Returns a string describing the object.
      String hitDetectorTipText()
      Returns the tip text for this property.
      protected void initialize()
      Initializes the members.
      void mouseClickOccurred​(adams.flow.sink.sequenceplotter.SequencePlotterPanel panel, MouseEvent e)
      Gets triggered if the user clicks on the canvas.
      protected void remove​(adams.data.spreadsheet.SpreadSheet data)
      Removes the data points from the current dataset.
      void setHitDetector​(adams.gui.visualization.sequence.AbstractXYSequencePointHitDetector value)
      Sets the hit detector to use.
      void setRemoveDataListener​(RemoveDataListener l)
      Sets the listener.
      protected void showData​(adams.flow.sink.sequenceplotter.SequencePlotterPanel panel, adams.data.spreadsheet.SpreadSheet sheet)
      Displays the data.
      protected void showHits​(adams.flow.sink.sequenceplotter.SequencePlotterPanel panel, List<adams.data.sequence.XYSequencePoint> hits)
      Displays the points that were determined by the hit detector.
      protected void showOutliers​(adams.flow.sink.sequenceplotter.SequencePlotterPanel panel)
      Displays the points that were flagged as outliers.
      protected void toggleHits​(adams.flow.sink.sequenceplotter.SequencePlotterPanel panel, List<adams.data.sequence.XYSequencePoint> hits)
      Sets or toggles the outlier state of the specified points.
      protected void togglePolygonPoints​(adams.flow.sink.sequenceplotter.SequencePlotterPanel panel)
      Displays the points that were surrounded by the polygon.
      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString
      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf
      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel
    • Field Detail

      • m_HitDetector

        protected adams.gui.visualization.sequence.AbstractXYSequencePointHitDetector m_HitDetector
        the hit detector to use.
      • m_RemoveDataListener

        protected RemoveDataListener m_RemoveDataListener
        the listener for removing the data.
    • Constructor Detail

      • RemoveOutliersClickAction

        public RemoveOutliersClickAction()
    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui
      • initialize

        protected void initialize()
        Initializes the members.
        Overrides:
        initialize in class adams.core.option.AbstractOptionHandler
      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.core.option.AbstractOptionHandler
      • setHitDetector

        public void setHitDetector​(adams.gui.visualization.sequence.AbstractXYSequencePointHitDetector value)
        Sets the hit detector to use.
        Parameters:
        value - the hit detector
      • getHitDetector

        public adams.gui.visualization.sequence.AbstractXYSequencePointHitDetector getHitDetector()
        Returns the hit detector to use.
        Returns:
        the hit detector
      • hitDetectorTipText

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

        public void setRemoveDataListener​(RemoveDataListener l)
        Sets the listener.
        Parameters:
        l - the listener, null to unset
      • getRemoveDataListener

        public RemoveDataListener getRemoveDataListener()
        Returns the listener, if any.
        Returns:
        the listener, null if none set
      • toggleHits

        protected void toggleHits​(adams.flow.sink.sequenceplotter.SequencePlotterPanel panel,
                                  List<adams.data.sequence.XYSequencePoint> hits)
        Sets or toggles the outlier state of the specified points.
        Parameters:
        panel - the panel the points belong to
        hits - the points to process
      • togglePolygonPoints

        protected void togglePolygonPoints​(adams.flow.sink.sequenceplotter.SequencePlotterPanel panel)
        Displays the points that were surrounded by the polygon.
        Parameters:
        panel - the associated panel
      • showData

        protected void showData​(adams.flow.sink.sequenceplotter.SequencePlotterPanel panel,
                                adams.data.spreadsheet.SpreadSheet sheet)
        Displays the data.
        Parameters:
        panel - the associated panel
        sheet - the data to display
      • showOutliers

        protected void showOutliers​(adams.flow.sink.sequenceplotter.SequencePlotterPanel panel)
        Displays the points that were flagged as outliers.
        Parameters:
        panel - the associated panel
      • clearOutliers

        protected void clearOutliers​(adams.flow.sink.sequenceplotter.SequencePlotterPanel panel)
        Resets the outlier status of all points.
      • remove

        protected void remove​(adams.data.spreadsheet.SpreadSheet data)
        Removes the data points from the current dataset.
        Parameters:
        data - the data points of the instances to remove
      • showHits

        protected void showHits​(adams.flow.sink.sequenceplotter.SequencePlotterPanel panel,
                                List<adams.data.sequence.XYSequencePoint> hits)
        Displays the points that were determined by the hit detector.
        Parameters:
        panel - the associated panel
        hits - the hits
      • mouseClickOccurred

        public void mouseClickOccurred​(adams.flow.sink.sequenceplotter.SequencePlotterPanel panel,
                                       MouseEvent e)
        Gets triggered if the user clicks on the canvas.
        Parameters:
        panel - the associated panel
        e - the mouse event