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

Class Minimum

Object

AnchorBean<Feature<FeatureInputPairObjects>>

InitializableBean<Feature<FeatureInputPairObjects>,FeatureInitialization>

Feature<FeatureInputPairObjects>

FeaturePairObjects

FeatureDeriveFromPair

Minimum

public class Minimum
extends FeatureDeriveFromPair

Calculates the minimum value of a feature applied to both objects in a pair.

This class extends FeatureDeriveFromPair to calculate a feature value for both objects in a pair and return the minimum of the two values.

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
Minimum()
Minimum(Feature<FeatureInputSingleObject> item)	Creates a new instance that will calculate the minimum feature value from a pair of objects.

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

Minimum

public Minimum(Feature<FeatureInputSingleObject> item)

Creates a new instance that will calculate the minimum feature value from a pair of objects.

Parameters:

item - the feature to be evaluated on both objects in the pair

Minimum

public Minimum()

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.