Package elki.result.outlier
Class BasicOutlierScoreMeta
- java.lang.Object
-
- elki.result.outlier.BasicOutlierScoreMeta
-
- All Implemented Interfaces:
OutlierScoreMeta
- Direct Known Subclasses:
InvertedOutlierScoreMeta
,QuotientOutlierScoreMeta
public class BasicOutlierScoreMeta extends java.lang.Object implements OutlierScoreMeta
Basic outlier score. Straightforward implementation of theOutlierScoreMeta
interface.- Since:
- 0.3
- Author:
- Erich Schubert
-
-
Field Summary
Fields Modifier and Type Field Description (package private) double
actualMaximum
Store the actual maximum(package private) double
actualMinimum
Store the actual minimum(package private) double
theoreticalBaseline
Store the theoretical baseline(package private) double
theoreticalMaximum
Store the theoretical maximum(package private) double
theoreticalMinimum
Store the theoretical minimum
-
Constructor Summary
Constructors Constructor Description BasicOutlierScoreMeta(double actualMinimum, double actualMaximum)
Constructor with actual values only.BasicOutlierScoreMeta(double actualMinimum, double actualMaximum, double theoreticalMinimum, double theoreticalMaximum)
Constructor with all range valuesBasicOutlierScoreMeta(double actualMinimum, double actualMaximum, double theoreticalMinimum, double theoreticalMaximum, double theoreticalBaseline)
Full constructor - all values.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description double
getActualMaximum()
Get the actual maximum of the value range.double
getActualMinimum()
Get the actual minimum of the value range.java.lang.String
getLongName()
java.lang.String
getShortName()
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.void
setActualMaximum(double actualMaximum)
void
setActualMinimum(double actualMinimum)
-
-
-
Field Detail
-
actualMinimum
double actualMinimum
Store the actual minimum
-
actualMaximum
double actualMaximum
Store the actual maximum
-
theoreticalMinimum
double theoreticalMinimum
Store the theoretical minimum
-
theoreticalMaximum
double theoreticalMaximum
Store the theoretical maximum
-
theoreticalBaseline
double theoreticalBaseline
Store the theoretical baseline
-
-
Constructor Detail
-
BasicOutlierScoreMeta
public BasicOutlierScoreMeta(double actualMinimum, double actualMaximum)
Constructor with actual values only.- Parameters:
actualMinimum
- actual minimumactualMaximum
- actual maximum
-
BasicOutlierScoreMeta
public BasicOutlierScoreMeta(double actualMinimum, double actualMaximum, double theoreticalMinimum, double theoreticalMaximum)
Constructor with all range values- Parameters:
actualMinimum
- actual minimumactualMaximum
- actual maximumtheoreticalMinimum
- theoretical minimumtheoreticalMaximum
- theoretical maximum
-
BasicOutlierScoreMeta
public BasicOutlierScoreMeta(double actualMinimum, double actualMaximum, double theoreticalMinimum, double theoreticalMaximum, double theoreticalBaseline)
Full constructor - all values.- Parameters:
actualMinimum
- actual minimumactualMaximum
- actual maximumtheoreticalMinimum
- theoretical minimumtheoreticalMaximum
- theoretical maximumtheoreticalBaseline
- theoretical baseline
-
-
Method Detail
-
getActualMaximum
public double getActualMaximum()
Description copied from interface:OutlierScoreMeta
Get the actual maximum of the value range.- Specified by:
getActualMaximum
in interfaceOutlierScoreMeta
- Returns:
- maximum or
Double.NaN
-
getActualMinimum
public double getActualMinimum()
Description copied from interface:OutlierScoreMeta
Get the actual minimum of the value range.- Specified by:
getActualMinimum
in interfaceOutlierScoreMeta
- Returns:
- minimum 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 seeDouble.POSITIVE_INFINITY
here.- Specified by:
getTheoreticalBaseline
in interfaceOutlierScoreMeta
- 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 beDouble.NEGATIVE_INFINITY
orDouble.NaN
.- Specified by:
getTheoreticalMaximum
in interfaceOutlierScoreMeta
- 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 interfaceOutlierScoreMeta
- 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 interfaceOutlierScoreMeta
- Parameters:
value
- outlier score- Returns:
- Normalized value (in 0.0-1.0)
-
setActualMinimum
public void setActualMinimum(double actualMinimum)
- Parameters:
actualMinimum
- the actualMinimum to set
-
setActualMaximum
public void setActualMaximum(double actualMaximum)
- Parameters:
actualMaximum
- the actualMaximum to set
-
getLongName
public java.lang.String getLongName()
-
getShortName
public java.lang.String getShortName()
-
-