de.lmu.ifi.dbs.elki.utilities.scaling.outlier
Class TopKOutlierScaling

java.lang.Object
  extended by de.lmu.ifi.dbs.elki.utilities.scaling.outlier.TopKOutlierScaling
All Implemented Interfaces:
InspectionUtilFrequentlyScanned, Parameterizable, OutlierScalingFunction, ScalingFunction

public class TopKOutlierScaling
extends Object
implements OutlierScalingFunction

Outlier scaling function that only keeps the top k outliers.


Nested Class Summary
static class TopKOutlierScaling.Parameterizer
          Parameterization class.
 
Field Summary
private  boolean binary
          Do a binary decision
static OptionID BINARY_ID
          Parameter to specify the lambda value Key: -topk.binary
private  double cutoff
          The value we cut off at.
private  double ground
          The "ground" value
private  int k
          Number of outliers to keep.
static OptionID K_ID
          Parameter to specify the number of outliers to keep Key: -topk.k
private  double max
          The maximum value
 
Constructor Summary
TopKOutlierScaling(int k, boolean binary)
          Constructor.
 
Method Summary
 double getMax()
          Get maximum resulting value.
 double getMin()
          Get minimum resulting value.
 double getScaled(double value)
          Transform a given value using the scaling function.
 void prepare(OutlierResult or)
          Prepare is called once for each data set, before getScaled() will be called.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

K_ID

public static final OptionID K_ID
Parameter to specify the number of outliers to keep

Key: -topk.k


BINARY_ID

public static final OptionID BINARY_ID
Parameter to specify the lambda value

Key: -topk.binary


k

private int k
Number of outliers to keep.


binary

private boolean binary
Do a binary decision


cutoff

private double cutoff
The value we cut off at.


ground

private double ground
The "ground" value


max

private double max
The maximum value

Constructor Detail

TopKOutlierScaling

public TopKOutlierScaling(int k,
                          boolean binary)
Constructor.

Parameters:
k -
binary -
Method Detail

prepare

public void prepare(OutlierResult or)
Description copied from interface: OutlierScalingFunction
Prepare is called once for each data set, before getScaled() will be called. This function can be used to extract global parameters such as means, minimums or maximums from the Database, Result or Annotation.

Specified by:
prepare in interface OutlierScalingFunction
Parameters:
or - Outlier result to use

getMax

public double getMax()
Description copied from interface: ScalingFunction
Get maximum resulting value. May be Double.NaN or Double.POSITIVE_INFINITY.

Specified by:
getMax in interface ScalingFunction
Returns:
Maximum resulting value.

getMin

public double getMin()
Description copied from interface: ScalingFunction
Get minimum resulting value. May be Double.NaN or Double.NEGATIVE_INFINITY.

Specified by:
getMin in interface ScalingFunction
Returns:
Minimum resulting value.

getScaled

public double getScaled(double value)
Description copied from interface: ScalingFunction
Transform a given value using the scaling function.

Specified by:
getScaled in interface ScalingFunction
Parameters:
value - Original value
Returns:
Scaled value

Release 0.4.0 (2011-09-20_1324)