Class BasicOutlierScoreMeta

    • 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 values
      BasicOutlierScoreMeta​(double actualMinimum, double actualMaximum, double theoreticalMinimum, double theoreticalMaximum, double theoreticalBaseline)
      Full constructor - all values.
    • 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 minimum
        actualMaximum - actual maximum
      • BasicOutlierScoreMeta

        public BasicOutlierScoreMeta​(double actualMinimum,
                                     double actualMaximum,
                                     double theoreticalMinimum,
                                     double theoreticalMaximum)
        Constructor with all range values
        Parameters:
        actualMinimum - actual minimum
        actualMaximum - actual maximum
        theoreticalMinimum - theoretical minimum
        theoreticalMaximum - theoretical maximum
      • BasicOutlierScoreMeta

        public BasicOutlierScoreMeta​(double actualMinimum,
                                     double actualMaximum,
                                     double theoreticalMinimum,
                                     double theoreticalMaximum,
                                     double theoreticalBaseline)
        Full constructor - all values.
        Parameters:
        actualMinimum - actual minimum
        actualMaximum - actual maximum
        theoreticalMinimum - theoretical minimum
        theoreticalMaximum - theoretical maximum
        theoreticalBaseline - 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 interface OutlierScoreMeta
        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 interface OutlierScoreMeta
        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 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)
      • 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()