Package org.anchoranalysis.plugin.points.bean.feature

Class EllipsoidBase

Object

AnchorBean<Feature<FeatureInputSingleObject>>

InitializableBean<Feature<FeatureInputSingleObject>,FeatureInitialization>

Feature<FeatureInputSingleObject>

FeatureSingleObject

EllipsoidBase

Direct Known Subclasses:

AxisRatioEllipsoid, Ellipsoidicity

public abstract class EllipsoidBase
extends FeatureSingleObject

Base class for features that calculate properties of an Ellipsoid fitted to an object.

Constructor Summary

Constructors

Constructor	Description
EllipsoidBase()

Method Summary

Modifier and Type	Method	Description
double	calculate(FeatureCalculationInput<FeatureInputSingleObject> input)	Calculates a value for some input.
protected abstract double	calculateWithEllipsoid(FeatureInputSingleObject input, Ellipsoid ellipsoid)	Calculates a feature value based on the fitted Ellipsoid.
boolean	isSuppressZ()	If true, suppresses covariance in the z-direction.
void	setSuppressZ(boolean suppressZ)	If true, suppresses covariance in the z-direction.

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

EllipsoidBase

public EllipsoidBase()

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.

calculateWithEllipsoid

protected abstract double calculateWithEllipsoid(FeatureInputSingleObject input,
 Ellipsoid ellipsoid)
                                          throws FeatureCalculationException

Calculates a feature value based on the fitted Ellipsoid.

Parameters:

input - the input object

ellipsoid - the fitted ellipsoid

Returns:

the calculated feature value

Throws:

FeatureCalculationException - if the calculation fails

isSuppressZ

public boolean isSuppressZ()

If true, suppresses covariance in the z-direction.

setSuppressZ

public void setSuppressZ(boolean suppressZ)

If true, suppresses covariance in the z-direction.