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

Class FeatureEnergyChannel

Object

AnchorBean<Feature<FeatureInputSingleObject>>

InitializableBean<Feature<FeatureInputSingleObject>,FeatureInitialization>

Feature<FeatureInputSingleObject>

FeatureSingleObject

FeatureEnergyChannel

Direct Known Subclasses:

Intensity, IntensityMeanMaxSlice, IntensityMeanShellBase, TextureScore

public abstract class FeatureEnergyChannel
extends FeatureSingleObject

A feature that uses a channel from the energy-stack as identified by an index.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
FeatureEnergyChannel()

Method Summary

Modifier and Type	Method	Description
double	calculate(FeatureCalculationInput<FeatureInputSingleObject> input)	Calculates a value for some input.
protected abstract double	calculateForChannel(FeatureCalculationInput<FeatureInputSingleObject> input, Channel channel)	Calculates the feature value for a specific channel in the energy stack.
int	getEnergyIndex()	Index of channel to use in the energy-stack (0 is the first channel, 1 is second etc.)
void	setEnergyIndex(int energyIndex)	Index of channel to use in the energy-stack (0 is the first channel, 1 is second etc.)

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

FeatureEnergyChannel

public FeatureEnergyChannel()

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.

calculateForChannel

protected abstract double calculateForChannel(FeatureCalculationInput<FeatureInputSingleObject> input,
 Channel channel)
                                       throws FeatureCalculationException

Calculates the feature value for a specific channel in the energy stack.

Parameters:

input - the FeatureCalculationInput containing the FeatureInputSingleObject

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 channel to use in the energy-stack (0 is the first channel, 1 is second etc.)

setEnergyIndex

public void setEnergyIndex(int energyIndex)

Index of channel to use in the energy-stack (0 is the first channel, 1 is second etc.)