Package weka.estimators

Class KernelEstimator

java.lang.Object
weka.estimators.Estimator
weka.estimators.KernelEstimator
All Implemented Interfaces:
Serializable, Cloneable, Aggregateable<KernelEstimator>, CapabilitiesHandler, CapabilitiesIgnorer, OptionHandler, RevisionHandler, IncrementalEstimator
public class KernelEstimator extends Estimator implements IncrementalEstimator, Aggregateable<KernelEstimator>
Simple kernel density estimator. Uses one gaussian kernel per observed data value.
Version:
$Revision: 15521 $
Author:
Len Trigg (trigg@cs.waikato.ac.nz)
See Also:

  • Constructor Details

    • KernelEstimator

      public KernelEstimator()
      No-arg constructor needed to make WEKA's forName() work. Uses precision of 0.01.

    • KernelEstimator

      public KernelEstimator(double precision)
      Constructor that takes a precision argument.
      Parameters:
      precision - the precision to which numeric values are given. For example, if the precision is stated to be 0.1, the values in the interval (0.25,0.35] are all treated as 0.3.

  • Method Details

    • addValue

      public void addValue(double data, double weight)
      Add a new data value to the current estimator.
      Specified by:
      addValue in interface IncrementalEstimator
      Overrides:
      addValue in class Estimator
      Parameters:
      data - the new data value
      weight - the weight assigned to the data value

    • getProbability

      public double getProbability(double data)
      Get a probability estimate for a value.
      Specified by:
      getProbability in class Estimator
      Parameters:
      data - the value to estimate the probability of
      Returns:
      the estimated probability of the supplied value

    • toString

      public String toString()
      Display a representation of this estimator
      Overrides:
      toString in class Object

    • getNumKernels

      public int getNumKernels()
      Return the number of kernels in this kernel estimator
      Returns:
      the number of kernels

    • getMeans

      public double[] getMeans()
      Return the means of the kernels.
      Returns:
      the means of the kernels

    • getWeights

      public double[] getWeights()
      Return the weights of the kernels.
      Returns:
      the weights of the kernels

    • getPrecision

      public double getPrecision()
      Return the precision of this kernel estimator.
      Returns:
      the precision

    • getStdDev

      public double getStdDev()
      Return the standard deviation of this kernel estimator.
      Returns:
      the standard deviation

    • getCapabilities

      public Capabilities getCapabilities()
      Returns default capabilities of the classifier.
      Specified by:
      getCapabilities in interface CapabilitiesHandler
      Overrides:
      getCapabilities in class Estimator
      Returns:
      the capabilities of this classifier
      See Also:

    • getRevision

      public String getRevision()
      Returns the revision string.
      Specified by:
      getRevision in interface RevisionHandler
      Overrides:
      getRevision in class Estimator
      Returns:
      the revision

    • aggregate

      public KernelEstimator aggregate(KernelEstimator toAggregate) throws Exception
      Description copied from interface: Aggregateable
      Aggregate an object with this one
      Specified by:
      aggregate in interface Aggregateable<KernelEstimator>
      Parameters:
      toAggregate - the object to aggregate
      Returns:
      the result of aggregation
      Throws:
      Exception - if the supplied object can't be aggregated for some reason

    • finalizeAggregation

      public void finalizeAggregation() throws Exception
      Description copied from interface: Aggregateable
      Call to complete the aggregation process. Allows implementers to do any final processing based on how many objects were aggregated.
      Specified by:
      finalizeAggregation in interface Aggregateable<KernelEstimator>
      Throws:
      Exception - if the aggregation can't be finalized for some reason

    • testAggregation

      public static void testAggregation()

    • main

      public static void main(String[] argv)
      Main method for testing this class.
      Parameters:
      argv - should contain a sequence of numeric values