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

Class Range<T extends FeatureInput>

Object

AnchorBean<Feature<T>>

InitializableBean<Feature<T>,FeatureInitialization>

Feature<T>

FeatureBinary<T>

Range<T>

Type Parameters:

T - the type of FeatureInput this feature operates on

public class Range<T extends FeatureInput>
extends FeatureBinary<T>

Calculates the statistical range between two feature values, with optional weighting.

The range is calculated as the absolute difference between two feature values. Different weights can be applied depending on which value is greater.

Constructor Summary

Constructors

Constructor	Description
Range()

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.
double	getWeightItem1Greater()	Weight applied when the first item's value is greater than the second.
double	getWeightItem2Greater()	Weight applied when the second item's value is greater than the first.
void	setWeightItem1Greater(double weightItem1Greater)	Weight applied when the first item's value is greater than the second.
void	setWeightItem2Greater(double weightItem2Greater)	Weight applied when the second item's value is greater than the first.

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

getItem1, getItem2, inputType, setItem1, setItem2

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

Range

public Range()

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.

getWeightItem1Greater

public double getWeightItem1Greater()

Weight applied when the first item's value is greater than the second. Default value is 1.0.

setWeightItem1Greater

public void setWeightItem1Greater(double weightItem1Greater)

Weight applied when the first item's value is greater than the second. Default value is 1.0.

getWeightItem2Greater

public double getWeightItem2Greater()

Weight applied when the second item's value is greater than the first. Default value is 1.0.

setWeightItem2Greater

public void setWeightItem2Greater(double weightItem2Greater)

Weight applied when the second item's value is greater than the first. Default value is 1.0.