Package org.anchoranalysis.plugin.image.feature.bean.dimensions

Class FromDimensionsBase<T extends FeatureInputDimensions>

Object

AnchorBean<Feature<T>>

InitializableBean<Feature<T>,FeatureInitialization>

Feature<T>

FromDimensionsBase<T>

Type Parameters:

T - feature-input-type that extends FeatureInputDimensions

Direct Known Subclasses:

Area, ForSpecificAxis, Volume

public abstract class FromDimensionsBase<T extends FeatureInputDimensions>
extends Feature<T>

Base class for features that are calculated from Dimensions.

Constructor Summary

Constructors

Constructor	Description
FromDimensionsBase()

Method Summary

Modifier and Type	Method	Description
double	calculate(FeatureCalculationInput<T> input)	Calculates a value for some input.
protected abstract double	calculateFromDimensions(Dimensions dimensions)	Calculates a feature value from the given dimensions.
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

FromDimensionsBase

public FromDimensionsBase()

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 FeatureInputDimensions>

Parameters:

input - the input to the calculation.

Returns:

the result of the calculation.

Throws:

FeatureCalculationException - if the calculation cannot successfully complete.

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<T extends FeatureInputDimensions>

Returns:

the class.

calculateFromDimensions

protected abstract double calculateFromDimensions(Dimensions dimensions)
                                           throws FeatureCalculationException

Calculates a feature value from the given dimensions.

Parameters:

dimensions - the Dimensions to calculate from

Returns:

the calculated feature value

Throws:

FeatureCalculationException - if the calculation fails