Package org.anchoranalysis.image.feature.bean.object.pair

Class First

Object

AnchorBean<Feature<FeatureInputPairObjects>>

InitializableBean<Feature<FeatureInputPairObjects>,FeatureInitialization>

Feature<FeatureInputPairObjects>

FeaturePairObjects

FeatureDeriveFromPair

First

public class First
extends FeatureDeriveFromPair

Evaluates a feature on the first object in a pair of objects.

This class extends FeatureDeriveFromPair to specifically calculate a feature value for the first object in a pair, ignoring the second object.

Author:

Owen Feehan

Field Summary

Fields inherited from class org.anchoranalysis.image.feature.bean.object.pair.FeatureDeriveFromPair

CACHE_NAME_FIRST, CACHE_NAME_MERGED, CACHE_NAME_SECOND

Constructor Summary

Constructors

Constructor	Description
First()
First(Feature<FeatureInputSingleObject> item)	Creates a new instance that will evaluate the given feature on the first object of a pair.

Method Summary

Modifier and Type	Method	Description
double	calculate(FeatureCalculationInput<FeatureInputPairObjects> input)	Calculates a value for some input.

Methods inherited from class org.anchoranalysis.image.feature.bean.object.pair.FeatureDeriveFromPair

getItem, setItem, valueFromFirst, valueFromMerged, valueFromSecond

Methods inherited from class org.anchoranalysis.image.feature.bean.object.pair.FeaturePairObjects

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

First

public First(Feature<FeatureInputSingleObject> item)

Creates a new instance that will evaluate the given feature on the first object of a pair.

Parameters:

item - the feature to be evaluated on the first object

First

public First()

Method Details

calculate

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

Description copied from class: Feature

Calculates a value for some input.

Specified by:

calculate in class Feature<FeatureInputPairObjects>

Parameters:

input - the input to the calculation.

Returns:

the result of the calculation.

Throws:

FeatureCalculationException - if the calculation cannot successfully complete.