gov.sandia.cognition.learning.data.feature
Class MultivariateDecorrelator.FullCovarianceLearner

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.learning.data.feature.MultivariateDecorrelator.FullCovarianceLearner
All Implemented Interfaces:
BatchLearner<Collection<? extends Vectorizable>,MultivariateDecorrelator>, CloneableSerializable, Serializable, Cloneable
Enclosing class:
MultivariateDecorrelator

public static class MultivariateDecorrelator.FullCovarianceLearner
extends AbstractCloneableSerializable
implements BatchLearner<Collection<? extends Vectorizable>,MultivariateDecorrelator>

The FullCovarianceLearner class implements a BatchLearner object for a MultivariateDecorrelator.

See Also:
Serialized Form

Field Summary
static double DEFAULT_DEFAULT_COVARIANCE
          The default value for default covariance is 1.0E-5.
protected  double defaultCovariance
          The default covariance.
 
Constructor Summary
MultivariateDecorrelator.FullCovarianceLearner()
          Creates a new MultivariateDecorrelator.FullCovarianceLearner with the default value for default covariance.
MultivariateDecorrelator.FullCovarianceLearner(double defaultCovariance)
          Creates a new MultivariateDecorrelator.FullCovarianceLearner with the given value for default covariance.
 
Method Summary
 double getDefaultCovariance()
          Gets the default covariance value.
 MultivariateDecorrelator learn(Collection<? extends Vectorizable> values)
          Learns a MultivariateDecorrelator from the given values by computing the mean and covariance of the dimensions.
 void setDefaultCovariance(double defaultCovariance)
          Sets the default covariance value.
 
Methods inherited from class gov.sandia.cognition.util.AbstractCloneableSerializable
clone
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface gov.sandia.cognition.util.CloneableSerializable
clone
 

Field Detail

DEFAULT_DEFAULT_COVARIANCE

public static final double DEFAULT_DEFAULT_COVARIANCE
The default value for default covariance is 1.0E-5.

See Also:
Constant Field Values

defaultCovariance

protected double defaultCovariance
The default covariance. Added to the diagonal to prevent it from becoming singular.

Constructor Detail

MultivariateDecorrelator.FullCovarianceLearner

public MultivariateDecorrelator.FullCovarianceLearner()
Creates a new MultivariateDecorrelator.FullCovarianceLearner with the default value for default covariance.


MultivariateDecorrelator.FullCovarianceLearner

public MultivariateDecorrelator.FullCovarianceLearner(double defaultCovariance)
Creates a new MultivariateDecorrelator.FullCovarianceLearner with the given value for default covariance.

Parameters:
defaultCovariance - The default covariance value. Added to the diagonal to prevent it from becoming singular
Method Detail

learn

public MultivariateDecorrelator learn(Collection<? extends Vectorizable> values)
Learns a MultivariateDecorrelator from the given values by computing the mean and covariance of the dimensions.

Specified by:
learn in interface BatchLearner<Collection<? extends Vectorizable>,MultivariateDecorrelator>
Parameters:
values - The values to use.
Returns:
The MultivariateDecorrelator computed from the given values.

getDefaultCovariance

public double getDefaultCovariance()
Gets the default covariance value. It is added to the diagonal terms of the covariance matrix to attempt to prevent them from becoming singular.

Returns:
The default covariance value.

setDefaultCovariance

public void setDefaultCovariance(double defaultCovariance)
Sets the default covariance value. It is added to the diagonal terms of the covariance matrix to attempt to prevent them from becoming singular.

Parameters:
defaultCovariance - The default covariance value. Must be non-negative.