com.rapidminer.operator.preprocessing.outlier
Class DKNOutlierOperator

java.lang.Object
  com.rapidminer.tools.AbstractObservable<Operator>
      com.rapidminer.operator.Operator
          com.rapidminer.operator.AbstractExampleSetProcessing
              com.rapidminer.operator.preprocessing.outlier.AbstractOutlierDetection
                  com.rapidminer.operator.preprocessing.outlier.DKNOutlierOperator

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ResourceConsumer, ParameterHandler, LoggingHandler, Observable<Operator>

public class DKNOutlierOperator
extends AbstractOutlierDetection

This operator performs a D^k_n Outlier Search according to the outlier detection approach recommended by Ramaswamy, Rastogi and Shim in "Efficient Algorithms for Mining Outliers from Large Data Sets". It is primarily a statistical outlier search based on a distance measure similar to the DB(p,D)-Outlier Search from Knorr and Ng. But it utilizes a distance search through the k-th nearest neighbourhood, so it implements some sort of locality as well.

The method states, that those objects with the largest distance to their k-th nearest neighbours are likely to be outliers respective to the data set, because it can be assumed, that those objects have a more sparse neighbourhood than the average objects. As this effectively provides a simple ranking over all the objects in the data set according to the distance to their k-th nearest neighbours, the user can specify a number of n objects to be the top-n outliers in the data set.

The operator supports cosine, sine or squared distances in addition to the euclidian distance which can be specified by a distance parameter. The Operator takes an example set and passes it on with an boolean top-n D^k outlier status in a new boolean-valued special outlier attribute indicating true (outlier) and false (no outlier).

Author:

Stephan Deutsch, Ingo Mierswa

Field Summary

static java.lang.String	PARAMETER_DISTANCE_FUNCTION The parameter name for "choose which distance function will be used for calculating "
static java.lang.String	PARAMETER_NUMBER_OF_NEIGHBORS The parameter name for "Specifies the k value for the k-th nearest neighbours to be the analyzed.
static java.lang.String	PARAMETER_NUMBER_OF_OUTLIERS The parameter name for "The number of top-n Outliers to be looked for.

Constructor Summary

DKNOutlierOperator(OperatorDescription description)

Method Summary

ExampleSet	apply(ExampleSet eSet) This method implements the main functionality of the Operator but can be considered as a sort of wrapper to pass the RapidMiner operator chain data deeper into the search space class, so do not expect a lot of things happening here.
protected java.util.Set<java.lang.String>	getOutlierValues()
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.
ResourceConsumptionEstimator	getResourceConsumptionEstimator() Subclasses can override this method if they are able to estimate the consumed resources (CPU time and memory), based on their input.

Methods inherited from class com.rapidminer.operator.preprocessing.outlier.AbstractOutlierDetection

modifyMetaData, writesIntoExistingData

Methods inherited from class com.rapidminer.operator.AbstractExampleSetProcessing

doWork, getExampleSetInputPort, getExampleSetOutputPort, getInputPort, getRequiredMetaData, shouldAutoConnect

Methods inherited from class com.rapidminer.operator.Operator

acceptsInput, addError, addError, addValue, addWarning, apply, apply, assumePreconditionsSatisfied, checkAll, checkAllExcludingMetaData, checkDeprecations, checkForStop, checkIO, checkProperties, clear, clearErrorList, cloneOperator, collectErrors, createExperimentTree, createExperimentTree, createFromXML, createFromXML, createFromXML, createMarkedExperimentTree, createMarkedProcessTree, createProcessTree, createProcessTree, disconnectPorts, execute, fireUpdate, freeMemory, getAddOnlyAdditionalOutput, getApplyCount, getCompatibilityLevel, getDeliveredOutputClasses, getDeprecationInfo, getDesiredInputClasses, getDOMRepresentation, getEncoding, getErrorList, getExecutionUnit, getExperiment, getIncompatibleVersionChanges, getInput, getInput, getInput, getInputClasses, getInputDescription, getInputPorts, getIODescription, getLog, getLogger, getName, getNumberOfBreakpoints, getOperatorClassName, getOperatorDescription, getOutputClasses, getOutputPorts, getParameter, getParameterAsBoolean, getParameterAsChar, getParameterAsColor, getParameterAsDouble, getParameterAsFile, getParameterAsFile, getParameterAsInputStream, getParameterAsInt, getParameterAsMatrix, getParameterAsRepositoryLocation, getParameterAsString, getParameterHandler, getParameterList, getParameters, getParameterTupel, getParameterType, getParent, getPortOwner, getProcess, getRoot, getStartTime, getTransformer, getUserDescription, getValue, getValues, getXML, getXML, getXML, hasBreakpoint, hasBreakpoint, hasInput, inApplyLoop, isDebugMode, isDirty, isEnabled, isExpanded, isParallel, isParameterSet, isRunning, log, log, logError, logNote, logWarning, lookupOperator, makeDirty, makeDirtyOnUpdate, notifyRenaming, performAdditionalChecks, preAutoWire, processFinished, processStarts, producesOutput, propagateDirtyness, register, registerOperator, remove, removeAndKeepConnections, rename, resume, setBreakpoint, setCompatibilityLevel, setEnabled, setEnclosingProcess, setExpanded, setInput, setListParameter, setPairParameter, setParameter, setParameters, setUserDescription, shouldAutoConnect, shouldStopStandaloneExecution, toString, transformMetaData, unregisterOperator, updateExecutionOrder, walk, writeXML, writeXML

Methods inherited from class com.rapidminer.tools.AbstractObservable

addObserver, addObserverAsFirst, fireUpdate, removeObserver

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PARAMETER_NUMBER_OF_NEIGHBORS

public static final java.lang.String PARAMETER_NUMBER_OF_NEIGHBORS

The parameter name for "Specifies the k value for the k-th nearest neighbours to be the analyzed."

See Also:

Constant Field Values

PARAMETER_NUMBER_OF_OUTLIERS

public static final java.lang.String PARAMETER_NUMBER_OF_OUTLIERS

The parameter name for "The number of top-n Outliers to be looked for."

See Also:

Constant Field Values

PARAMETER_DISTANCE_FUNCTION

public static final java.lang.String PARAMETER_DISTANCE_FUNCTION

The parameter name for "choose which distance function will be used for calculating "

See Also:

Constant Field Values

Constructor Detail

DKNOutlierOperator

public DKNOutlierOperator(OperatorDescription description)

Method Detail

apply

public ExampleSet apply(ExampleSet eSet)
                 throws OperatorException

This method implements the main functionality of the Operator but can be considered as a sort of wrapper to pass the RapidMiner operator chain data deeper into the search space class, so do not expect a lot of things happening here.

Specified by:

apply in class AbstractExampleSetProcessing

Throws:

OperatorException

getParameterTypes

public java.util.List<ParameterType> getParameterTypes()

Description copied from class: Operator

Returns a list of ParameterTypes describing the parameters of this operator. The default implementation returns an empty list if no input objects can be retained and special parameters for those input objects which can be prevented from being consumed. ATTENTION! This will create new parameterTypes. For calling already existing parameter types use getParameters().getParameterTypes();

Specified by:

getParameterTypes in interface ParameterHandler

Overrides:

getParameterTypes in class Operator

getOutlierValues

protected java.util.Set<java.lang.String> getOutlierValues()

Specified by:

getOutlierValues in class AbstractOutlierDetection

getResourceConsumptionEstimator

public ResourceConsumptionEstimator getResourceConsumptionEstimator()

Description copied from class: Operator

Subclasses can override this method if they are able to estimate the consumed resources (CPU time and memory), based on their input. The default implementation returns null.

Specified by:

getResourceConsumptionEstimator in interface ResourceConsumer

Overrides:

getResourceConsumptionEstimator in class Operator