Package adams.flow.control

Class RemoveOutliers

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, InteractiveActor, OutputProducer, StopModeSupporter, Serializable, Comparable
    public class RemoveOutliers
extends AbstractInteractiveTransformerDialog
    Allows the user to interactively remove outliers.
    You can toggle the 'outlier' state of individual points by left-clicking them.You can also toggle whole regions by selecting a polygon around them: use SHIFT+left-click to place vertices and SHIFT+right-click to finish the polygon.

    Input/output:
    - accepts:
       adams.data.spreadsheet.SpreadSheet
    - generates:
       adams.flow.container.OutlierContainer


    Container information:
    - adams.flow.container.OutlierContainer: Original, Clean, Outliers 

    -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: RemoveOutliers
 
    -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
 
    -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
 
    -stop-if-canceled <boolean> (property: stopFlowIfCanceled)
    If enabled, the flow gets stopped in case the user cancels the dialog.
    default: false
 
    -custom-stop-message <java.lang.String> (property: customStopMessage)
    The custom stop message to use in case a user cancelation stops the flow
    (default is the full name of the actor)
    default:
 
    -stop-mode <GLOBAL|STOP_RESTRICTOR> (property: stopMode)
    The stop mode to use.
    default: GLOBAL
 
    -detector <adams.flow.control.removeoutliers.AbstractOutlierDetector> (property: detector)
    The detector to use for the initial outlier detection.
    default: adams.flow.control.removeoutliers.Null
 
    -col-actual <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: columnActual)
    The spreadsheet column with the actual values.
    default: 1
    example: An index is a number starting with 1; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
 
    -col-predicted <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: columnPredicted)
    The spreadsheet column with the predicted values.
    default: 2
    example: An index is a number starting with 1; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • RemoveOutliers

        public RemoveOutliers()

    • Method Detail

      • setDetector

        public void setDetector​(AbstractOutlierDetector value)
        Sets the detector to use.
        Parameters:
        value - the detector

      • detectorTipText

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

      • setColumnActual

        public void setColumnActual​(SpreadSheetColumnIndex value)
        Sets the spreadsheet column with the actual values.
        Parameters:
        value - the column

      • getColumnActual

        public SpreadSheetColumnIndex getColumnActual()
        Returns the spreadsheet column with the actual values.
        Returns:
        the column

      • columnActualTipText

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

      • setColumnPredicted

        public void setColumnPredicted​(SpreadSheetColumnIndex value)
        Sets the spreadsheet column with the predicted values.
        Parameters:
        value - the column

      • getColumnPredicted

        public SpreadSheetColumnIndex getColumnPredicted()
        Returns the spreadsheet column with the predicted values.
        Returns:
        the column

      • columnPredictedTipText

        public String columnPredictedTipText()
        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.
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        the Class of the generated tokens