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

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

All Implemented Interfaces:

Parameterizable, OutlierScalingFunction, ScalingFunction

public class OutlierLinearScaling
extends AbstractLoggable
implements OutlierScalingFunction

Scaling that can map arbitrary values to a probability in the range of [0:1]. Transformation is done by linear mapping onto 0:1 using the minimum and maximum values.

Author:

Erich Schubert

Field Summary

(package private) double	factor Scaling factor to use (1/ max - min)
protected Double	max Field storing the Maximum value
static OptionID	MAX_ID OptionID for MAX_PARAM
private DoubleParameter	MAX_PARAM Parameter to specify the lambda value Key: -linearscale.max
private Flag	MEAN_FLAG Parameter to specify the lambda value Key: -linearscale.max
static OptionID	MEAN_ID OptionID for MEAN_FLAG
protected Double	min Field storing the Minimum to use
static OptionID	MIN_ID OptionID for MIN_PARAM
private DoubleParameter	MIN_PARAM Parameter to specify a fixed minimum to use.
(package private) boolean	usemean Use the mean for scaling

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

debug, logger

Constructor Summary

OutlierLinearScaling(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 a fixed minimum to use.

Key: -linearscale.min

MAX_ID

public static final OptionID MAX_ID

OptionID for MAX_PARAM

MAX_PARAM

private final DoubleParameter MAX_PARAM

Parameter to specify the lambda value

Key: -linearscale.max

MEAN_ID

public static final OptionID MEAN_ID

OptionID for MEAN_FLAG

MEAN_FLAG

private final Flag MEAN_FLAG

Parameter to specify the lambda value

Key: -linearscale.max

min

protected Double min

Field storing the Minimum to use

max

protected Double max

Field storing the Maximum value

factor

double factor

Scaling factor to use (1/ max - min)

usemean

boolean usemean

Use the mean for scaling

Constructor Detail

OutlierLinearScaling

public OutlierLinearScaling(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.