Class FeatureIntersectingObjects

Object
AnchorBean<Feature<FeatureInputSingleObject>>
InitializableBean<Feature<FeatureInputSingleObject>, FeatureInitialization>
Feature<FeatureInputSingleObject>
FeatureSingleObject
FeatureIntersectingObjects
Direct Known Subclasses:
FeatureIntersectingObjectsSingleElement, NumberIntersectingObjects
public abstract class FeatureIntersectingObjects extends FeatureSingleObject
An abstract base class for features that calculate values based on intersecting objects.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FeatureIntersectingObjects()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    beforeCalc(FeatureInitialization initialization)
     
    double
    calculate(FeatureCalculationInput<FeatureInputSingleObject> input)
     
    String
    getId()
    ID for the particular object-collection
    protected ObjectCollection
    getSearchObjects()
    Gets the collection of objects to search for intersections.
    double
    getValueNoObjects()
    The value to return when there are no objects in the search collection.
    void
    setId(String id)
    ID for the particular object-collection
    void
    setValueNoObjects(double valueNoObjects)
    The value to return when there are no objects in the search collection.
    protected abstract double
    valueFor(FeatureCalculationInput<FeatureInputSingleObject> input, ResolvedPart<ObjectCollection, FeatureInputSingleObject> intersecting)
    Calculates a value based on the input and the intersecting objects.

    Methods inherited from class org.anchoranalysis.image.feature.bean.object.single.FeatureSingleObject

    inputType

    Methods inherited from class org.anchoranalysis.feature.bean.Feature

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

    • FeatureIntersectingObjects

      public FeatureIntersectingObjects()

  • Method Details

    • beforeCalc

      protected void beforeCalc(FeatureInitialization initialization) throws InitializeException
      Overrides:
      beforeCalc in class Feature<FeatureInputSingleObject>
      Throws:
      InitializeException

    • calculate

      public double calculate(FeatureCalculationInput<FeatureInputSingleObject> input) throws FeatureCalculationException
      Specified by:
      calculate in class Feature<FeatureInputSingleObject>
      Throws:
      FeatureCalculationException

    • valueFor

      protected abstract double valueFor(FeatureCalculationInput<FeatureInputSingleObject> input, ResolvedPart<ObjectCollection, FeatureInputSingleObject> intersecting) throws FeatureCalculationException
      Calculates a value based on the input and the intersecting objects.
      Parameters:
      input - the input for feature calculation
      intersecting - the resolved part containing intersecting objects
      Returns:
      the calculated feature value
      Throws:
      FeatureCalculationException - if an error occurs during calculation

    • getSearchObjects

      protected ObjectCollection getSearchObjects()
      Gets the collection of objects to search for intersections.
      Returns:
      the ObjectCollection used for searching intersections

    • getId

      public String getId()
      ID for the particular object-collection

    • setId

      public void setId(String id)
      ID for the particular object-collection

    • getValueNoObjects

      public double getValueNoObjects()
      The value to return when there are no objects in the search collection.

    • setValueNoObjects

      public void setValueNoObjects(double valueNoObjects)
      The value to return when there are no objects in the search collection.