Package elki.evaluation.outlier

Class ComputeOutlierHistogram

  • All Implemented Interfaces:
    elki.evaluation.Evaluator, elki.result.ResultProcessor
    public class ComputeOutlierHistogram
extends java.lang.Object
implements elki.evaluation.Evaluator
    Compute a Histogram to evaluate a ranking algorithm.

    The parameter -hist.positive specifies the class label of "positive" hits.

    Since:
    0.3
    Author:
    Lisa Reichert, Erich Schubert

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ComputeOutlierHistogram.Par
      Parameterization class.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private int bins
      Number of bins
      private java.util.regex.Pattern positiveClassName
      Stores the "positive" class.
      private elki.utilities.scaling.ScalingFunction scaling
      Scaling function to use
      private boolean splitfreq
      Flag to make split frequencies

    • Constructor Summary

      Constructors 
      Constructor Description
      ComputeOutlierHistogram​(java.util.regex.Pattern positive_class_name, int bins, elki.utilities.scaling.ScalingFunction scaling, boolean splitfreq)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      elki.result.HistogramResult evaluateOutlierResult​(elki.database.Database database, OutlierResult or)
      Evaluate a single outlier result as histogram.
      void processNewResult​(java.lang.Object result)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • positiveClassName

        private java.util.regex.Pattern positiveClassName
        Stores the "positive" class.

      • bins

        private int bins
        Number of bins

      • scaling

        private elki.utilities.scaling.ScalingFunction scaling
        Scaling function to use

      • splitfreq

        private boolean splitfreq
        Flag to make split frequencies

    • Constructor Detail

      • ComputeOutlierHistogram

        public ComputeOutlierHistogram​(java.util.regex.Pattern positive_class_name,
                               int bins,
                               elki.utilities.scaling.ScalingFunction scaling,
                               boolean splitfreq)
        Constructor.
        Parameters:
        positive_class_name - Class name
        bins - Bins
        scaling - Scaling
        splitfreq - Scale inlier and outlier frequencies independently

    • Method Detail

      • evaluateOutlierResult

        public elki.result.HistogramResult evaluateOutlierResult​(elki.database.Database database,
                                                         OutlierResult or)
        Evaluate a single outlier result as histogram.
        Parameters:
        database - Database to process
        or - Outlier result
        Returns:
        Result

      • processNewResult

        public void processNewResult​(java.lang.Object result)
        Specified by:
        processNewResult in interface elki.result.ResultProcessor