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

java.lang.Object
  de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      de.lmu.ifi.dbs.elki.utilities.scaling.outlier.SqrtStandardDeviationScaling

All Implemented Interfaces:

Parameterizable, OutlierScalingFunction, ScalingFunction

public class SqrtStandardDeviationScaling
extends AbstractLoggable
implements OutlierScalingFunction

Scaling that can map arbitrary values to a probability in the range of [0:1]. Transformation is done using the formulas y = sqrt(x - min) newscore = max(0, erf(lambda * (y - mean) / (stddev * sqrt(2)))) Where min and mean can be fixed to a given value, and stddev is then computed against this mean.

Author:

Erich Schubert

Field Summary

(package private) double	factor Scaling factor to use (usually: Lambda * Stddev * Sqrt(2))
protected Double	lambda Field storing the lambda value
static OptionID	LAMBDA_ID OptionID for LAMBDA_PARAM
private DoubleParameter	LAMBDA_PARAM Parameter to specify the lambda value Key: -sqrtstddevscale.lambda
(package private) Double	mean Mean to use
static OptionID	MEAN_ID OptionID for MEAN_PARAM
private DoubleParameter	MEAN_PARAM Parameter to specify a fixed mean to use.
(package private) Double	min Min to use
static OptionID	MIN_ID OptionID for MIN_PARAM
private DoubleParameter	MIN_PARAM Parameter to specify the fixed minimum to use.

Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debug, logger

Constructor Summary

SqrtStandardDeviationScaling(Parameterization config)
Constructor, adhering to Parameterizable

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(Database<?> db, Result result, OutlierResult or) Prepare is called once for each data set, before getScaled() will be called.

Methods inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debugFine, debugFiner, debugFinest, exception, progress, verbose, warning

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

OptionID for MIN_PARAM

MIN_PARAM

private final DoubleParameter MIN_PARAM

Parameter to specify the fixed minimum to use.

Key: -sqrtstddevscale.min

MEAN_ID

public static final OptionID MEAN_ID

OptionID for MEAN_PARAM

MEAN_PARAM

private final DoubleParameter MEAN_PARAM

Parameter to specify a fixed mean to use.

Key: -sqrtstddevscale.mean

LAMBDA_ID

public static final OptionID LAMBDA_ID

OptionID for LAMBDA_PARAM

LAMBDA_PARAM

private final DoubleParameter LAMBDA_PARAM

Parameter to specify the lambda value

Key: -sqrtstddevscale.lambda

lambda

protected Double lambda

Field storing the lambda value

min

Double min

Min to use

mean

Double mean

Mean to use

factor

double factor

Scaling factor to use (usually: Lambda * Stddev * Sqrt(2))

Constructor Detail

SqrtStandardDeviationScaling

public SqrtStandardDeviationScaling(Parameterization config)

Constructor, adhering to Parameterizable

Parameters:

config - Parameterization

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(Database<?> db,
                    Result result,
                    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:

db - Database used

result - Result object

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.