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

Class OverlapRelative

Object

AnchorBean<Feature<FeatureInputPairObjects>>

InitializableBean<Feature<FeatureInputPairObjects>,FeatureInitialization>

Feature<FeatureInputPairObjects>

FeaturePairObjects

OverlapRelative

Direct Known Subclasses:

OverlapRelativeToFirst, OverlapRelativeToMaxVolume, OverlapRelativeToMerged, OverlapRelativeToSecond

public abstract class OverlapRelative
extends FeaturePairObjects

Expresses the number of intersecting pixels between two objects as a ratio to a denominator.

The denominator is calculated by the abstract method calculateDenominator(org.anchoranalysis.image.feature.input.FeatureInputPairObjects).

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
OverlapRelative()

Method Summary

Modifier and Type	Method	Description
double	calculate(FeatureCalculationInput<FeatureInputPairObjects> input)	Calculates a value for some input.
protected abstract int	calculateDenominator(FeatureInputPairObjects input)	Calculates the denominator for the overlap ratio.

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

OverlapRelative

public OverlapRelative()

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.

calculateDenominator

protected abstract int calculateDenominator(FeatureInputPairObjects input)

Calculates the denominator for the overlap ratio.

Parameters:

input - the FeatureInputPairObjects containing the two objects

Returns:

the calculated denominator value