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

Class EllipsoidBase

Object
org.anchoranalysis.bean.AnchorBean<B>
org.anchoranalysis.bean.initializable.InitializableBean<org.anchoranalysis.feature.bean.Feature<T>,​org.anchoranalysis.feature.initialization.FeatureInitialization>
org.anchoranalysis.feature.bean.Feature<org.anchoranalysis.image.feature.input.FeatureInputSingleObject>
org.anchoranalysis.image.feature.bean.object.single.FeatureSingleObject
org.anchoranalysis.plugin.points.bean.feature.EllipsoidBase
Direct Known Subclasses:
AxisRatioEllipsoid, Ellipsoidicity
public abstract class EllipsoidBase
extends org.anchoranalysis.image.feature.bean.object.single.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​(org.anchoranalysis.feature.calculate.FeatureCalculationInput<org.anchoranalysis.image.feature.input.FeatureInputSingleObject> input)  
    protected abstract double calculateWithEllipsoid​(org.anchoranalysis.image.feature.input.FeatureInputSingleObject input, org.anchoranalysis.mpp.mark.conic.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

  • Method Details

    • calculate

      public double calculate​(org.anchoranalysis.feature.calculate.FeatureCalculationInput<org.anchoranalysis.image.feature.input.FeatureInputSingleObject> input) throws org.anchoranalysis.feature.calculate.FeatureCalculationException
      Specified by:
      calculate in class org.anchoranalysis.feature.bean.Feature<org.anchoranalysis.image.feature.input.FeatureInputSingleObject>
      Throws:
      org.anchoranalysis.feature.calculate.FeatureCalculationException

    • calculateWithEllipsoid

      protected abstract double calculateWithEllipsoid​(org.anchoranalysis.image.feature.input.FeatureInputSingleObject input, org.anchoranalysis.mpp.mark.conic.Ellipsoid ellipsoid) throws org.anchoranalysis.feature.calculate.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:
      org.anchoranalysis.feature.calculate.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.