KernelEstimator (original) (raw)

• java.lang.Object

• • weka.estimators.Estimator
  • • weka.estimators.KernelEstimator

• All Implemented Interfaces:
  java.io.Serializable, java.lang.Cloneable, CapabilitiesHandler, OptionHandler, RevisionHandler, IncrementalEstimator

public class KernelEstimator
extends Estimator
implements IncrementalEstimator
Simple kernel density estimator. Uses one gaussian kernel per observed data value.
Version: Revision:5540Revision: 5540 Revision:5540
Author:
Len Trigg (trigg@cs.waikato.ac.nz)
See Also:
Serialized Form

• • Constructor Summary

  Constructors

  Constructor and Description
  KernelEstimator(double precision) Constructor that takes a precision argument.

  • Method Summary

  All Methods Static Methods Instance Methods Concrete Methods

  Modifier and Type	Method and Description
  void	addValue(double data, double weight) Add a new data value to the current estimator.
  Capabilities	getCapabilities() Returns default capabilities of the classifier.
  double[]	getMeans() Return the means of the kernels.
  int	getNumKernels() Return the number of kernels in this kernel estimator
  double	getPrecision() Return the precision of this kernel estimator.
  double	getProbability(double data) Get a probability estimate for a value.
  java.lang.String	getRevision() Returns the revision string.
  double	getStdDev() Return the standard deviation of this kernel estimator.
  double[]	getWeights() Return the weights of the kernels.
  static void	main(java.lang.String[] argv) Main method for testing this class.
  java.lang.String	toString() Display a representation of this estimator

     * ### Methods inherited from class weka.estimators.[Estimator](../../weka/estimators/Estimator.html "class in weka.estimators")  
     `[addValues](../../weka/estimators/Estimator.html#addValues-weka.core.Instances-int-), [addValues](../../weka/estimators/Estimator.html#addValues-weka.core.Instances-int-double-double-double-), [addValues](../../weka/estimators/Estimator.html#addValues-weka.core.Instances-int-int-int-), [addValues](../../weka/estimators/Estimator.html#addValues-weka.core.Instances-int-int-int-double-double-), [buildEstimator](../../weka/estimators/Estimator.html#buildEstimator-weka.estimators.Estimator-weka.core.Instances-int-int-int-boolean-), [buildEstimator](../../weka/estimators/Estimator.html#buildEstimator-weka.estimators.Estimator-java.lang.String:A-boolean-), [clone](../../weka/estimators/Estimator.html#clone-weka.estimators.Estimator-), [debugTipText](../../weka/estimators/Estimator.html#debugTipText--), [equals](../../weka/estimators/Estimator.html#equals-java.lang.Object-), [forName](../../weka/estimators/Estimator.html#forName-java.lang.String-java.lang.String:A-), [getDebug](../../weka/estimators/Estimator.html#getDebug--), [getOptions](../../weka/estimators/Estimator.html#getOptions--), [listOptions](../../weka/estimators/Estimator.html#listOptions--), [makeCopies](../../weka/estimators/Estimator.html#makeCopies-weka.estimators.Estimator-int-), [makeCopy](../../weka/estimators/Estimator.html#makeCopy-weka.estimators.Estimator-), [setDebug](../../weka/estimators/Estimator.html#setDebug-boolean-), [setOptions](../../weka/estimators/Estimator.html#setOptions-java.lang.String:A-), [testCapabilities](../../weka/estimators/Estimator.html#testCapabilities-weka.core.Instances-int-)`  
     * ### Methods inherited from class java.lang.Object  
     `getClass, hashCode, notify, notifyAll, wait, wait, wait`

• • Constructor Detail

     * #### 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 Detail

    * #### addValue  
    public void addValue(double data,  
                         double weight)  
    Add a new data value to the current estimator.  
    Specified by:  
    `[addValue](../../weka/estimators/IncrementalEstimator.html#addValue-double-double-)` in interface `[IncrementalEstimator](../../weka/estimators/IncrementalEstimator.html "interface in weka.estimators")`  
    Overrides:  
    `[addValue](../../weka/estimators/Estimator.html#addValue-double-double-)` in class `[Estimator](../../weka/estimators/Estimator.html "class in weka.estimators")`  
    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](../../weka/estimators/Estimator.html#getProbability-double-)` in class `[Estimator](../../weka/estimators/Estimator.html "class in weka.estimators")`  
    Parameters:  
    `data` \- the value to estimate the probability of  
    Returns:  
    the estimated probability of the supplied value  
    * #### toString  
    public java.lang.String toString()  
    Display a representation of this estimator  
    Overrides:  
    `toString` in class `java.lang.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](../../weka/core/Capabilities.html "class in weka.core") getCapabilities()  
    Returns default capabilities of the classifier.  
    Specified by:  
    `[getCapabilities](../../weka/core/CapabilitiesHandler.html#getCapabilities--)` in interface `[CapabilitiesHandler](../../weka/core/CapabilitiesHandler.html "interface in weka.core")`  
    Overrides:  
    `[getCapabilities](../../weka/estimators/Estimator.html#getCapabilities--)` in class `[Estimator](../../weka/estimators/Estimator.html "class in weka.estimators")`  
    Returns:  
    the capabilities of this classifier  
    See Also:  
    [Capabilities](../../weka/core/Capabilities.html "class in weka.core")  
    * #### getRevision  
    public java.lang.String getRevision()  
    Returns the revision string.  
    Specified by:  
    `[getRevision](../../weka/core/RevisionHandler.html#getRevision--)` in interface `[RevisionHandler](../../weka/core/RevisionHandler.html "interface in weka.core")`  
    Returns:  
    the revision  
    * #### main  
    public static void main(java.lang.String[] argv)  
    Main method for testing this class.  
    Parameters:  
    `argv` \- should contain a sequence of numeric values