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

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

public class OutlierSqrtScaling
extends Object
implements OutlierScalingFunction

Scaling that can map arbitrary positive values to a value in the range of [0:1]. Transformation is done by taking the square root, then doing a linear linear mapping onto 0:1 using the minimum values seen.


Nested Class Summary
static class OutlierSqrtScaling.Parameterizer
          Parameterization class.
 
Field Summary
protected  double factor
          Scaling factor
protected  Double max
          Field storing the Maximum value
static OptionID MAX_ID
          Parameter to specify the fixed maximum to use.
protected  Double min
          Field storing the minimum value
static OptionID MIN_ID
          Parameter to specify the fixed minimum to use.
 
Constructor Summary
OutlierSqrtScaling(Double min, Double max)
          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

MIN_ID

public static final OptionID MIN_ID
Parameter to specify the fixed minimum to use.

Key: -sqrtscale.min


MAX_ID

public static final OptionID MAX_ID
Parameter to specify the fixed maximum to use.

Key: -sqrtscale.max


min

protected Double min
Field storing the minimum value


max

protected Double max
Field storing the Maximum value


factor

protected double factor
Scaling factor

Constructor Detail

OutlierSqrtScaling

public OutlierSqrtScaling(Double min,
                          Double max)
Constructor.

Parameters:
min -
max -
Method Detail

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

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

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.

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.

Release 0.4.0 (2011-09-20_1324)