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

Class BoundingBoxAlongAxisBase

Object

AnchorBean<Feature<FeatureInputSingleObject>>

InitializableBean<Feature<FeatureInputSingleObject>,FeatureInitialization>

Feature<FeatureInputSingleObject>

FeatureSingleObject

BoundingBoxAlongAxisBase

Direct Known Subclasses:

BoundingBoxExtentAlongAxis, BoundingBoxMaximumAlongAxis, BoundingBoxMinimumAlongAxis

public abstract class BoundingBoxAlongAxisBase
extends FeatureSingleObject

Base class for features that calculate a value along a specific axis of an object's bounding box.

Constructor Summary

Constructors

Constructor	Description
BoundingBoxAlongAxisBase()

Method Summary

Modifier and Type	Method	Description
double	calculate(FeatureCalculationInput<FeatureInputSingleObject> input)	Calculates a value for some input.
String	describeParameters()	A human-readable description of the parameterization of the bean.
protected abstract ReadableTuple3i	extractTupleForBoundingBox(BoundingBox box)	Extracts a ReadableTuple3i from the given BoundingBox.
String	getAxis()	The axis along which to calculate the feature value ("x", "y", or "z").
void	setAxis(String axis)	The axis along which to calculate the feature value ("x", "y", or "z").

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, 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

BoundingBoxAlongAxisBase

public BoundingBoxAlongAxisBase()

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.

extractTupleForBoundingBox

protected abstract ReadableTuple3i extractTupleForBoundingBox(BoundingBox box)

Extracts a ReadableTuple3i from the given BoundingBox.

Parameters:

box - the BoundingBox to extract from

Returns:

the extracted ReadableTuple3i

describeParameters

public String describeParameters()

Description copied from class: Feature

A human-readable description of the parameterization of the bean.

Overrides:

describeParameters in class Feature<FeatureInputSingleObject>

Returns:

the description.

getAxis

public String getAxis()

The axis along which to calculate the feature value ("x", "y", or "z").

setAxis

public void setAxis(String axis)

The axis along which to calculate the feature value ("x", "y", or "z").