Package org.anchoranalysis.plugin.image.feature.bean.object.single.energy

Class SpecificEnergyChannelBase

Object

AnchorBean<Feature<FeatureInputSingleObject>>

InitializableBean<Feature<FeatureInputSingleObject>,FeatureInitialization>

Feature<FeatureInputSingleObject>

FeatureSingleObject

SpecificEnergyChannelBase

Direct Known Subclasses:

CountEqual

public abstract class SpecificEnergyChannelBase
extends FeatureSingleObject

A base class for features that operate on a specific channel from the energy stack.

Constructor Summary

Constructors

Constructor	Description
SpecificEnergyChannelBase()

Method Summary

Modifier and Type	Method	Description
double	calculate(FeatureCalculationInput<FeatureInputSingleObject> input)	Calculates a value for some input.
protected abstract double	calculateWithChannel(ObjectMask object, Channel channel)	Calculates the feature value for a specific object and channel.
int	getEnergyIndex()	Index of which channel in the energy-stack to select. 0 represents the first channel, 1 the second, and so on.
void	setEnergyIndex(int energyIndex)	Index of which channel in the energy-stack to select. 0 represents the first channel, 1 the second, and so on.

Methods inherited from class org.anchoranalysis.image.feature.bean.object.single.FeatureSingleObject

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

SpecificEnergyChannelBase

public SpecificEnergyChannelBase()

Method Details

calculate

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

Description copied from class: Feature

Calculates a value for some input.

Specified by:

calculate in class Feature<FeatureInputSingleObject>

Parameters:

input - the input to the calculation.

Returns:

the result of the calculation.

Throws:

FeatureCalculationException - if the calculation cannot successfully complete.

calculateWithChannel

protected abstract double calculateWithChannel(ObjectMask object,
 Channel channel)
                                        throws FeatureCalculationException

Calculates the feature value for a specific object and channel.

Parameters:

object - the ObjectMask representing the object of interest

channel - the Channel from the energy stack to calculate the feature on

Returns:

the calculated feature value

Throws:

FeatureCalculationException - if the calculation fails

getEnergyIndex

public int getEnergyIndex()

Index of which channel in the energy-stack to select. 0 represents the first channel, 1 the second, and so on.

setEnergyIndex

public void setEnergyIndex(int energyIndex)

Index of which channel in the energy-stack to select. 0 represents the first channel, 1 the second, and so on.