de.lmu.ifi.dbs.elki.result.outlier
Class ProbabilisticOutlierScore

java.lang.Object
  extended by de.lmu.ifi.dbs.elki.result.outlier.ProbabilisticOutlierScore
All Implemented Interfaces:
OutlierScoreMeta, Result

public class ProbabilisticOutlierScore
extends Object
implements OutlierScoreMeta

Outlier score that is a probability value in the range 0.0 - 1.0 But the baseline may be different from 0.0!


Field Summary
private  double actualMaximum
          Actual maximum seen, if given by the algorithm.
private  double actualMinimum
          Actual minimum seen, if given by the algorithm.
private  double theoreticalBaseline
          Theoretical baseline specified by the algorithm.
 
Constructor Summary
ProbabilisticOutlierScore()
          Default constructor.
ProbabilisticOutlierScore(double theoreticalBaseline)
          Constructor with baseline only.
ProbabilisticOutlierScore(double actualMinimum, double actualMaximum)
          Constructor with actual values, and a baseline of 0.0
ProbabilisticOutlierScore(double actualMinimum, double actualMaximum, double theoreticalBaseline)
          Full constructor.
 
Method Summary
 double getActualMaximum()
          Get the actual maximum of the value range.
 double getActualMinimum()
          Get the actual minimum of the value range.
 String getLongName()
          A "pretty" name for the result, for use in titles, captions and menus.
 String getShortName()
          A short name for the result, useful for file names.
 double getTheoreticalBaseline()
          Get the theoretical baseline of the value range.
 double getTheoreticalMaximum()
          Get the theoretical maximum of the value range.
 double getTheoreticalMinimum()
          Get the theoretical minimum of the value range.
 double normalizeScore(double value)
          Return a normalized value of the outlier score.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

actualMinimum

private double actualMinimum
Actual minimum seen, if given by the algorithm.


actualMaximum

private double actualMaximum
Actual maximum seen, if given by the algorithm.


theoreticalBaseline

private double theoreticalBaseline
Theoretical baseline specified by the algorithm. Defaults to 0.0 in short constructor.

Constructor Detail

ProbabilisticOutlierScore

public ProbabilisticOutlierScore()
Default constructor. No actual values, Baseline 0.0


ProbabilisticOutlierScore

public ProbabilisticOutlierScore(double theoreticalBaseline)
Constructor with baseline only.

Parameters:
theoreticalBaseline - Baseline

ProbabilisticOutlierScore

public ProbabilisticOutlierScore(double actualMinimum,
                                 double actualMaximum)
Constructor with actual values, and a baseline of 0.0

Parameters:
actualMinimum - actual minimum seen
actualMaximum - actual maximum seen

ProbabilisticOutlierScore

public ProbabilisticOutlierScore(double actualMinimum,
                                 double actualMaximum,
                                 double theoreticalBaseline)
Full constructor.

Parameters:
actualMinimum - actual minimum seen
actualMaximum - actual maximum seen
theoreticalBaseline - theoretical baseline
Method Detail

getActualMinimum

public double getActualMinimum()
Description copied from interface: OutlierScoreMeta
Get the actual minimum of the value range.

Specified by:
getActualMinimum in interface OutlierScoreMeta
Returns:
minimum or Double.NaN

getActualMaximum

public double getActualMaximum()
Description copied from interface: OutlierScoreMeta
Get the actual maximum of the value range.

Specified by:
getActualMaximum in interface OutlierScoreMeta
Returns:
maximum or Double.NaN

getTheoreticalBaseline

public double getTheoreticalBaseline()
Description copied from interface: OutlierScoreMeta
Get the theoretical baseline of the value range. It will be common to see Double.POSITIVE_INFINITY here.

Specified by:
getTheoreticalBaseline in interface OutlierScoreMeta
Returns:
theoretical baseline or Double.NaN

getTheoreticalMaximum

public double getTheoreticalMaximum()
Description copied from interface: OutlierScoreMeta
Get the theoretical maximum of the value range. This value may be Double.NEGATIVE_INFINITY or Double.NaN.

Specified by:
getTheoreticalMaximum in interface OutlierScoreMeta
Returns:
theoretical maximum or Double.NaN

getTheoreticalMinimum

public double getTheoreticalMinimum()
Description copied from interface: OutlierScoreMeta
Get the theoretical minimum of the value range.

Specified by:
getTheoreticalMinimum in interface OutlierScoreMeta
Returns:
theoretical minimum or Double.NaN

normalizeScore

public double normalizeScore(double value)
Description copied from interface: OutlierScoreMeta
Return a normalized value of the outlier score.

Specified by:
normalizeScore in interface OutlierScoreMeta
Parameters:
value - outlier score
Returns:
Normalized value (in 0.0-1.0)

getLongName

public String getLongName()
Description copied from interface: Result
A "pretty" name for the result, for use in titles, captions and menus.

Specified by:
getLongName in interface Result
Returns:
result name

getShortName

public String getShortName()
Description copied from interface: Result
A short name for the result, useful for file names.

Specified by:
getShortName in interface Result
Returns:
result name

Release 0.4.0 (2011-09-20_1324)