Package org.anchoranalysis.feature.bean.results

Class FeatureResults

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

Direct Known Subclasses:

Count, FeatureResultsStatistic

public abstract class FeatureResults
extends Feature<FeatureInputResults>

Features that process ResultsVectorList.

i.e. the result of the calculation of some other features.

This is useful for applying some aggregate statistics (min, max etc.) to the results of multiple features calculated together.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
FeatureResults()

Method Summary

Modifier and Type	Method	Description
double	calculate(FeatureCalculationInput<FeatureInputResults> input)	Calculates a value for some input.
abstract double	calculate(FeatureInputResults input)	Calculates the feature-result given a FeatureInputResults.
Class<? extends FeatureInput>	inputType()	The class corresponding to feature input-type.

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

FeatureResults

public FeatureResults()

Method Details

calculate

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

Description copied from class: Feature

Calculates a value for some input.

Specified by:

calculate in class Feature<FeatureInputResults>

Parameters:

input - the input to the calculation.

Returns:

the result of the calculation.

Throws:

FeatureCalculationException - if the calculation cannot successfully complete.

calculate

public abstract double calculate(FeatureInputResults input) throws FeatureCalculationException

Calculates the feature-result given a FeatureInputResults.

Parameters:

input - the input.

Returns:

the calculated value.

Throws:

FeatureCalculationException - if the result cannot be successfully calculated.

inputType

public Class<? extends FeatureInput> inputType()

Description copied from class: Feature

The class corresponding to feature input-type.

i.e. corresponding to the T template parameter.

Specified by:

inputType in class Feature<FeatureInputResults>

Returns:

the class.