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

Class ArbitraryInsidePoint

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.ArbitraryInsidePoint
public class ArbitraryInsidePoint
extends org.anchoranalysis.image.feature.bean.object.single.FeatureSingleObject
Calculates deterministically a point that is definitely inside the object-mask and outputs a selected axis value.

This feature finds an arbitrary point inside the object-mask and returns the coordinate value for the specified axis.

Author:
Owen Feehan

  • Constructor Summary

    Constructors 
    Constructor Description
    ArbitraryInsidePoint()  
    ArbitraryInsidePoint​(String axis)
    Creates an ArbitraryInsidePoint with a specified axis.

  • Method Summary

    Modifier and Type Method Description
    double calculate​(org.anchoranalysis.feature.calculate.FeatureCalculationInput<org.anchoranalysis.image.feature.input.FeatureInputSingleObject> input)  
    String getAxis()
    The axis to output.
    double getEmptyValue()
    The value to return if no point is found inside the object-mask.
    void setAxis​(String axis)
    The axis to output.
    void setEmptyValue​(double emptyValue)
    The value to return if no point is found inside the object-mask.

    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

    • ArbitraryInsidePoint

      public ArbitraryInsidePoint​(String axis)
      Creates an ArbitraryInsidePoint with a specified axis.
      Parameters:
      axis - the axis to output ("x", "y", or "z")

    • ArbitraryInsidePoint

      public ArbitraryInsidePoint()

  • 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

    • getAxis

      public String getAxis()
      The axis to output. Can be "x", "y", or "z".

    • setAxis

      public void setAxis​(String axis)
      The axis to output. Can be "x", "y", or "z".

    • getEmptyValue

      public double getEmptyValue()
      The value to return if no point is found inside the object-mask.

    • setEmptyValue

      public void setEmptyValue​(double emptyValue)
      The value to return if no point is found inside the object-mask.