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

Class BoundingBoxAlongAxisBase

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.image.feature.bean.object.single.boundingbox.BoundingBoxAlongAxisBase
Direct Known Subclasses:
BoundingBoxExtentAlongAxis, BoundingBoxMaximumAlongAxis, BoundingBoxMinimumAlongAxis
public abstract class BoundingBoxAlongAxisBase
extends org.anchoranalysis.image.feature.bean.object.single.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​(org.anchoranalysis.feature.calculate.FeatureCalculationInput<org.anchoranalysis.image.feature.input.FeatureInputSingleObject> input)  
    String describeParameters()  
    protected abstract org.anchoranalysis.spatial.point.ReadableTuple3i extractTupleForBoundingBox​(org.anchoranalysis.spatial.box.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

  • 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

    • extractTupleForBoundingBox

      protected abstract org.anchoranalysis.spatial.point.ReadableTuple3i extractTupleForBoundingBox​(org.anchoranalysis.spatial.box.BoundingBox box)
      Extracts a ReadableTuple3i from the given BoundingBox.
      Parameters:
      box - the BoundingBox to extract from
      Returns:
      the extracted ReadableTuple3i

    • describeParameters

      public String describeParameters()
      Overrides:
      describeParameters in class org.anchoranalysis.feature.bean.Feature<org.anchoranalysis.image.feature.input.FeatureInputSingleObject>

    • 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").