Package org.anchoranalysis.image.feature.bean.evaluator

Class FeatureEvaluator<T extends FeatureInput>

Object

org.anchoranalysis.bean.AnchorBean<B>

org.anchoranalysis.bean.initializable.InitializableBean<T,FeatureRelatedInitialization>

org.anchoranalysis.feature.bean.FeatureRelatedBean<FeatureEvaluator<T>>

org.anchoranalysis.image.feature.bean.evaluator.FeatureEvaluator<T>

Type Parameters:

T - feature input-type

public class FeatureEvaluator<T extends FeatureInput>
extends FeatureRelatedBean<FeatureEvaluator<T>>

Defines a feature and provides a means to calculate inputs for it, a session.

Optionally, an energy stack can be associated with these inputs.

Constructor Summary

Constructors

Constructor	Description
FeatureEvaluator()

Method Summary

Modifier and Type	Method	Description
void	checkMisconfigured(BeanInstanceMap defaultInstances)
FeatureCalculatorSingle<T>	createFeatureSession()	Creates session for evaluating feature optionally adding an energy-stack.
Optional<EnergyStack>	energyStack()	The specified energy stack.
DictionaryProvider	getDictionary()	Parameters to optionally associated with stackEnergy, and meaningless if stackEnergy is not specified.
Feature<T>	getFeature()	The single feature that will be calculated (possibly repeatedly) in the session.
FeatureProvider<T>	getFeatureProvider()	The single feature that will be calculated (possibly repeatedly) in the session
Provider<Stack>	getStackEnergy()	Optionally specifies an energy-stack to be associated with every calculation input.
void	setDictionary(DictionaryProvider dictionary)	Parameters to optionally associated with stackEnergy, and meaningless if stackEnergy is not specified.
void	setFeature(Feature<T> feature)	The single feature that will be calculated (possibly repeatedly) in the session.
void	setFeatureProvider(FeatureProvider<T> featureProvider)	The single feature that will be calculated (possibly repeatedly) in the session
void	setStackEnergy(Provider<Stack> stackEnergy)	Optionally specifies an energy-stack to be associated with every calculation input.

Methods inherited from class org.anchoranalysis.bean.initializable.InitializableBean

getInitialization, getLogger, getPropertyInitializer, initialize, initializeRecursive, initRecursiveWithInitializer, isInitialized, onInitialization

Methods inherited from class org.anchoranalysis.bean.AnchorBean

describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

FeatureEvaluator

public FeatureEvaluator()

Method Details

checkMisconfigured

public void checkMisconfigured(BeanInstanceMap defaultInstances) throws BeanMisconfiguredException

Overrides:

checkMisconfigured in class AnchorBean<FeatureEvaluator<T extends FeatureInput>>

Throws:

BeanMisconfiguredException

createFeatureSession

public FeatureCalculatorSingle<T> createFeatureSession() throws OperationFailedException

Creates session for evaluating feature optionally adding an energy-stack.

Returns:

the calculator for a newly created session.

Throws:

OperationFailedException - if the session creation fails

energyStack

public Optional<EnergyStack> energyStack() throws OperationFailedException

The specified energy stack.

Returns:

the energy stack if it is specified.

Throws:

OperationFailedException - if the energy-stack is specified but cannot be created.

getFeature

public Feature<T> getFeature()

The single feature that will be calculated (possibly repeatedly) in the session.

Either this field must be set or featureProvider, but not both.

setFeature

public void setFeature(Feature<T> feature)

The single feature that will be calculated (possibly repeatedly) in the session.

Either this field must be set or featureProvider, but not both.

getFeatureProvider

public FeatureProvider<T> getFeatureProvider()

The single feature that will be calculated (possibly repeatedly) in the session

Either this field must be set or feature, but not both.

setFeatureProvider

public void setFeatureProvider(FeatureProvider<T> featureProvider)

The single feature that will be calculated (possibly repeatedly) in the session

Either this field must be set or feature, but not both.

getStackEnergy

public Provider<Stack> getStackEnergy()

Optionally specifies an energy-stack to be associated with every calculation input.

setStackEnergy

public void setStackEnergy(Provider<Stack> stackEnergy)

Optionally specifies an energy-stack to be associated with every calculation input.

getDictionary

public DictionaryProvider getDictionary()

Parameters to optionally associated with stackEnergy, and meaningless if stackEnergy is not specified.

setDictionary

public void setDictionary(DictionaryProvider dictionary)

Parameters to optionally associated with stackEnergy, and meaningless if stackEnergy is not specified.