Package org.anchoranalysis.feature.bean.operator

Class Sum<T extends FeatureInput>

Object

org.anchoranalysis.bean.AnchorBean<B>

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

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

org.anchoranalysis.feature.bean.operator.FeatureFromList<T>

org.anchoranalysis.feature.bean.operator.Sum<T>

Type Parameters:

T - feature input-type of all features in the list, as well as the returned result.

public class Sum<T extends FeatureInput>
extends FeatureFromList<T>

Sums the results after calculating a list of Features.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
Sum()
Sum(FeatureList<T> features)	Create with a list of Features which become summed.

Method Summary

Modifier and Type	Method	Description
double	calculate(FeatureCalculationInput<T> input)	Calculates a value for some input.
String	descriptionLong()	A long human-readable description of the feature and some or all of its parameterization.
boolean	isIgnoreNaN()	If true, we ignore any NaN values.
void	setIgnoreNaN(boolean ignoreNaN)	If true, we ignore any NaN values.

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

descriptionForList, getList, inputType, setList, setList

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

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

Sum

public Sum(FeatureList<T> features)

Create with a list of Features which become summed.

Parameters:

features - the features.

Sum

public Sum()

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.

descriptionLong

public String descriptionLong()

Description copied from class: Feature

A long human-readable description of the feature and some or all of its parameterization.

This can be overwritten to create an alternative description for features. By default string returned by Feature.describeBean() is used.

Overrides:

descriptionLong in class Feature<T extends FeatureInput>

Returns:

the description.

isIgnoreNaN

public boolean isIgnoreNaN()

If true, we ignore any NaN values. Otherwise the sum becomes NaN

setIgnoreNaN

public void setIgnoreNaN(boolean ignoreNaN)

If true, we ignore any NaN values. Otherwise the sum becomes NaN