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: 15522 $
- Author:
- Len Trigg (trigg@cs.waikato.ac.nz)
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionNo-arg constructor needed to make WEKA's forName() work.KernelEstimator(double precision) Constructor that takes a precision argument. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddValue(double data, double weight) Add a new data value to the current estimator.aggregate(KernelEstimator toAggregate) Aggregate an object with this onevoidCall to complete the aggregation process.Returns default capabilities of the classifier.double[]getMeans()Return the means of the kernels.intReturn the number of kernels in this kernel estimatordoubleReturn the precision of this kernel estimator.doublegetProbability(double data) Get a probability estimate for a value.Returns the revision string.doubleReturn the standard deviation of this kernel estimator.double[]Return the weights of the kernels.static voidMain method for testing this class.static voidtoString()Display a representation of this estimatorMethods inherited from class weka.estimators.Estimator
addValues, addValues, addValues, addValues, buildEstimator, buildEstimator, clone, debugTipText, doNotCheckCapabilitiesTipText, equals, forName, getDebug, getDoNotCheckCapabilities, getOptions, listOptions, makeCopies, makeCopy, setDebug, setDoNotCheckCapabilities, setOptions, testCapabilities
-
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:
addValuein interfaceIncrementalEstimator- Overrides:
addValuein classEstimator- Parameters:
data- the new data valueweight- the weight assigned to the data value
-
getProbability
public double getProbability(double data) Get a probability estimate for a value.- Specified by:
getProbabilityin classEstimator- Parameters:
data- the value to estimate the probability of- Returns:
- the estimated probability of the supplied value
-
toString
Display a representation of this estimator -
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
Returns default capabilities of the classifier.- Specified by:
getCapabilitiesin interfaceCapabilitiesHandler- Overrides:
getCapabilitiesin classEstimator- Returns:
- the capabilities of this classifier
- See Also:
-
getRevision
Returns the revision string.- Specified by:
getRevisionin interfaceRevisionHandler- Overrides:
getRevisionin classEstimator- Returns:
- the revision
-
aggregate
Description copied from interface:AggregateableAggregate an object with this one- Specified by:
aggregatein interfaceAggregateable<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
Description copied from interface:AggregateableCall to complete the aggregation process. Allows implementers to do any final processing based on how many objects were aggregated.- Specified by:
finalizeAggregationin interfaceAggregateable<KernelEstimator>- Throws:
Exception- if the aggregation can't be finalized for some reason
-
testAggregation
public static void testAggregation() -
main
Main method for testing this class.- Parameters:
argv- should contain a sequence of numeric values
-