Package org.anchoranalysis.feature.bean.results

Class FeatureResultsStatistic

Object

org.anchoranalysis.bean.AnchorBean<B>

org.anchoranalysis.bean.initializable.InitializableBean<Feature<T>,FeatureInitialization>

org.anchoranalysis.feature.bean.Feature<FeatureInputResults>

org.anchoranalysis.feature.bean.results.FeatureResults

org.anchoranalysis.feature.bean.results.FeatureResultsStatistic

Direct Known Subclasses:

Maximum, Mean, Minimum, Quantile, StandardDeviation, Sum

public abstract class FeatureResultsStatistic
extends FeatureResults

Base class for an instance of FeatureResults that calculating a statistic across all results in the ResultsVectorList for a particular feature-value.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
FeatureResultsStatistic()

Method Summary

Modifier and Type	Method	Description
double	calculate(FeatureInputResults input)	Calculates the feature-result given a FeatureInputResults.
String	getId()	The name of the feature, whose results will provide the statistic.
void	setId(String id)	The name of the feature, whose results will provide the statistic.
protected abstract double	statisticFromFeatureValue(cern.colt.list.DoubleArrayList values)	Calculates the statistic for a given list of result-value.

Methods inherited from class org.anchoranalysis.feature.bean.results.FeatureResults

calculate, inputType

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

assignTo, beforeCalc, calculateCheckInitialized, castAs, createListChildFeatures, describeBean, describeParameters, 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

FeatureResultsStatistic

public FeatureResultsStatistic()

Method Details

calculate

public double calculate(FeatureInputResults input) throws FeatureCalculationException

Description copied from class: FeatureResults

Calculates the feature-result given a FeatureInputResults.

Specified by:

calculate in class FeatureResults

Parameters:

input - the input.

Returns:

the calculated value.

Throws:

FeatureCalculationException - if the result cannot be successfully calculated.

statisticFromFeatureValue

protected abstract double statisticFromFeatureValue(cern.colt.list.DoubleArrayList values) throws FeatureCalculationException

Calculates the statistic for a given list of result-value.

Parameters:

values - the values to calculate the statistic for.

Returns:

the calculated statistic.

Throws:

FeatureCalculationException - if the calculation cannot complete successfully.

getId

public String getId()

The name of the feature, whose results will provide the statistic.

setId

public void setId(String id)

The name of the feature, whose results will provide the statistic.