Package org.anchoranalysis.plugin.operator.feature.bean.statistics

Class StatisticalBase<T extends FeatureInput>

Object

AnchorBean<Feature<T>>

InitializableBean<Feature<T>,FeatureInitialization>

Feature<T>

FeatureUnary<T,T>

FeatureUnaryGeneric<T>

StatisticalBase<T>

Type Parameters:

T - the type of FeatureInput this feature operates on

Direct Known Subclasses:

GaussianCumulative, ZScore

public abstract class StatisticalBase<T extends FeatureInput>
extends FeatureUnaryGeneric<T>

Calculates a score based upon the statistical mean and standard deviation.

Constructor Summary

Constructors

Constructor	Description
StatisticalBase()

Method Summary

Modifier and Type	Method	Description
double	calculate(FeatureCalculationInput<T> input)	Calculates a value for some input.
protected abstract double	deriveScore(double featureValue, double mean, FeatureResultSupplier stdDev)	Derive scores given the value, mean and standard deviation.
String	describeParameters()	A human-readable description of the parameterization of the bean.
Feature<T>	getItemMean()	The Feature used to calculate the mean.
Feature<T>	getItemStdDev()	The Feature used to calculate the standard deviation.
void	setItemMean(Feature<T> itemMean)	The Feature used to calculate the mean.
void	setItemStdDev(Feature<T> itemStdDev)	The Feature used to calculate the standard deviation.

Methods inherited from class org.anchoranalysis.feature.bean.operator.FeatureUnary

getItem, inputType, setItem

Methods inherited from class org.anchoranalysis.feature.bean.Feature

assignTo, beforeCalc, calculateCheckInitialized, castAs, createListChildFeatures, describeBean, descriptionLong, duplicateChangeName, getCustomName, getFriendlyName, onInitialization, setCustomName, toString

Methods inherited from class org.anchoranalysis.bean.initializable.InitializableBean

getInitialization, getLogger, getPropertyInitializer, initialize, initializeRecursive, initRecursiveWithInitializer, isInitialized

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise

Methods inherited from class java.lang.Object

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

Constructor Details

StatisticalBase

public StatisticalBase()

Method Details

calculate

public double calculate(FeatureCalculationInput<T> input)
                 throws FeatureCalculationException

Description copied from class: Feature

Calculates a value for some input.

Specified by:

calculate in class Feature<T extends FeatureInput>

Parameters:

input - the input to the calculation.

Returns:

the result of the calculation.

Throws:

FeatureCalculationException - if the calculation cannot successfully complete.

describeParameters

public String describeParameters()

Description copied from class: Feature

A human-readable description of the parameterization of the bean.

Overrides:

describeParameters in class Feature<T extends FeatureInput>

Returns:

the description.

deriveScore

protected abstract double deriveScore(double featureValue,
 double mean,
 FeatureResultSupplier stdDev)
                               throws FeatureCalculationException

Derive scores given the value, mean and standard deviation.

Parameters:

featureValue - the feature-value calculated from FeatureUnary.getItem()

mean - the mean

stdDev - a supplier for the standard deviation (if needed)

Returns:

the derived score

Throws:

FeatureCalculationException - if the score calculation fails

getItemMean

public Feature<T> getItemMean()

The Feature used to calculate the mean.

setItemMean

public void setItemMean(Feature<T> itemMean)

The Feature used to calculate the mean.

getItemStdDev

public Feature<T> getItemStdDev()

The Feature used to calculate the standard deviation.

setItemStdDev

public void setItemStdDev(Feature<T> itemStdDev)

The Feature used to calculate the standard deviation.