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

Class GaussianCumulative<T extends FeatureInput>

Object

AnchorBean<Feature<T>>

InitializableBean<Feature<T>,FeatureInitialization>

Feature<T>

FeatureUnary<T,T>

FeatureUnaryGeneric<T>

StatisticalBase<T>

GaussianCumulative<T>

Type Parameters:

T - the type of FeatureInput this feature operates on

public class GaussianCumulative<T extends FeatureInput>
extends StatisticalBase<T>

Calculates a score between 0 and 1 based on the Cumulative Distribution Function (CDF) of a Gaussian distribution. As the value approaches the mean, the score approaches 1.0.

Constructor Summary

Constructors

Constructor	Description
GaussianCumulative()

Method Summary

Modifier and Type	Method	Description
protected double	deriveScore(double featureValue, double mean, FeatureResultSupplier stdDev)	Derive scores given the value, mean and standard deviation.
boolean	isIgnoreHigherSide()	If true, always returns 1.0 for values higher than the mean.
boolean	isIgnoreLowerSide()	If true, always returns 1.0 for values lower than the mean.
boolean	isRewardHigherSide()	If true, treats the higher side as if it's the full CDF.
boolean	isRewardLowerSide()	If true, treats the lower side as if it's 1 minus the full CDF.
void	setIgnoreHigherSide(boolean ignoreHigherSide)	If true, always returns 1.0 for values higher than the mean.
void	setIgnoreLowerSide(boolean ignoreLowerSide)	If true, always returns 1.0 for values lower than the mean.
void	setRewardHigherSide(boolean rewardHigherSide)	If true, treats the higher side as if it's the full CDF.
void	setRewardLowerSide(boolean rewardLowerSide)	If true, treats the lower side as if it's 1 minus the full CDF.

Methods inherited from class org.anchoranalysis.plugin.operator.feature.bean.statistics.StatisticalBase

calculate, describeParameters, getItemMean, getItemStdDev, setItemMean, setItemStdDev

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

GaussianCumulative

public GaussianCumulative()

Method Details

deriveScore

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

Description copied from class: StatisticalBase

Derive scores given the value, mean and standard deviation.

Specified by:

deriveScore in class StatisticalBase<T extends FeatureInput>

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

isIgnoreHigherSide

public boolean isIgnoreHigherSide()

If true, always returns 1.0 for values higher than the mean.

setIgnoreHigherSide

public void setIgnoreHigherSide(boolean ignoreHigherSide)

If true, always returns 1.0 for values higher than the mean.

isIgnoreLowerSide

public boolean isIgnoreLowerSide()

If true, always returns 1.0 for values lower than the mean.

setIgnoreLowerSide

public void setIgnoreLowerSide(boolean ignoreLowerSide)

If true, always returns 1.0 for values lower than the mean.

isRewardHigherSide

public boolean isRewardHigherSide()

If true, treats the higher side as if it's the full CDF.

setRewardHigherSide

public void setRewardHigherSide(boolean rewardHigherSide)

If true, treats the higher side as if it's the full CDF.

isRewardLowerSide

public boolean isRewardLowerSide()

If true, treats the lower side as if it's 1 minus the full CDF.

setRewardLowerSide

public void setRewardLowerSide(boolean rewardLowerSide)

If true, treats the lower side as if it's 1 minus the full CDF.