Package adams.flow.transformer

Class OutlierDetector

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class OutlierDetector
extends AbstractTransformer
    Applies the outlier detector and either outputs the updated data container or a flow container with the data and the detection results.

    Input/output:
    - accepts:
       adams.data.container.DataContainer
    - generates:
       adams.data.container.DataContainer


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: OutlierDetector
 
    -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
 
    -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
 
    -detector <adams.data.outlier.AbstractOutlierDetector> (property: detector)
    The outlier detector to use for analyzing the data.
    default: adams.data.outlier.PassThrough
 
    -only-warning <boolean> (property: onlyWarning)
    If enabled, the detections get added merely as warnings instead of as errors.
    default: false
 
    -output-container <boolean> (property: outputContainer)
    If enabled, a flow container is output instead of just adding the detections
    to the data container.
    default: false
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_OnlyWarning

        protected boolean m_OnlyWarning
        whether the detection is only added as warning instead of error.

      • m_OutputContainer

        protected boolean m_OutputContainer
        whether to output a container.

    • Constructor Detail

      • OutlierDetector

        public OutlierDetector()

    • Method Detail

      • setDetector

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

      • getDetector

        public AbstractOutlierDetector getDetector()
        Returns the outlier detector in use.
        Returns:
        the outlier 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.

      • setOnlyWarning

        public void setOnlyWarning​(boolean value)
        Sets whether the detections are added as error or warning.
        Parameters:
        value - if true then the detections are added as warning instead of as error

      • getOnlyWarning

        public boolean getOnlyWarning()
        Returns whether the detections are added as error or warning.
        Returns:
        true if the detections get added as warning instead of as error

      • onlyWarningTipText

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

      • setOutputContainer

        public void setOutputContainer​(boolean value)
        Sets whether a flow container is output instead of just adding the detections to the data container.
        Parameters:
        value - true if a container is output

      • getOutputContainer

        public boolean getOutputContainer()
        Returns whether a flow container is output instead of just adding the detections to the data container.
        Returns:
        true if a container is output

      • outputContainerTipText

        public String outputContainerTipText()
        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

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message