Package org.anchoranalysis.plugin.image.feature.bean.physical

Class UnitsWithinRange<T extends org.anchoranalysis.feature.input.FeatureInputWithResolution>

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<T>
org.anchoranalysis.feature.bean.operator.FeatureUnary<T,​T>
org.anchoranalysis.feature.bean.operator.FeatureUnaryGeneric<T>
org.anchoranalysis.image.feature.bean.physical.WithResolutionBase<T>
org.anchoranalysis.plugin.image.feature.bean.physical.UnitsWithinRange<T>
Type Parameters:
T - feature input-type
public class UnitsWithinRange<T extends org.anchoranalysis.feature.input.FeatureInputWithResolution>
extends org.anchoranalysis.image.feature.bean.physical.WithResolutionBase<T>
Checks if a value lies within a range defined by units (a minimum and maximum boundary)
Author:
Owen Feehan

  • Constructor Summary

    Constructors 
    Constructor Description
    UnitsWithinRange()  

  • Method Summary

    Modifier and Type Method Description
    protected double calculateWithResolution​(double value, org.anchoranalysis.image.core.dimensions.Resolution resolution)  
    String describeParameters()  
    org.anchoranalysis.image.bean.unitvalue.extent.UnitValueExtent getMax()
    Maximum-boundary for acceptable range
    org.anchoranalysis.image.bean.unitvalue.extent.UnitValueExtent getMin()
    Minimum-boundary for acceptable range
    double getOutside()
    Returned as a constant if a value lies otside the range
    double getWithin()
    Returned as a constant if a value lies within the range
    void setMax​(org.anchoranalysis.image.bean.unitvalue.extent.UnitValueExtent max)
    Maximum-boundary for acceptable range
    void setMin​(org.anchoranalysis.image.bean.unitvalue.extent.UnitValueExtent min)
    Minimum-boundary for acceptable range
    void setOutside​(double outside)
    Returned as a constant if a value lies otside the range
    void setWithin​(double within)
    Returned as a constant if a value lies within the range

    Methods inherited from class org.anchoranalysis.image.feature.bean.physical.WithResolutionBase

    calculate, isAcceptMissingResolution, setAcceptMissingResolution

    Methods inherited from class org.anchoranalysis.feature.bean.operator.FeatureUnary

    getItem, inputType, setItem

    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

    • calculateWithResolution

      protected double calculateWithResolution​(double value, org.anchoranalysis.image.core.dimensions.Resolution resolution) throws org.anchoranalysis.feature.calculate.FeatureCalculationException
      Specified by:
      calculateWithResolution in class org.anchoranalysis.image.feature.bean.physical.WithResolutionBase<T extends org.anchoranalysis.feature.input.FeatureInputWithResolution>
      Throws:
      org.anchoranalysis.feature.calculate.FeatureCalculationException

    • describeParameters

      public String describeParameters()
      Overrides:
      describeParameters in class org.anchoranalysis.feature.bean.Feature<T extends org.anchoranalysis.feature.input.FeatureInputWithResolution>

    • getWithin

      public double getWithin()
      Returned as a constant if a value lies within the range

    • setWithin

      public void setWithin​(double within)
      Returned as a constant if a value lies within the range

    • getOutside

      public double getOutside()
      Returned as a constant if a value lies otside the range

    • setOutside

      public void setOutside​(double outside)
      Returned as a constant if a value lies otside the range

    • getMin

      public org.anchoranalysis.image.bean.unitvalue.extent.UnitValueExtent getMin()
      Minimum-boundary for acceptable range

      We default to volume as units, but it could also be area. It's arbitrary for 0-value.

    • setMin

      public void setMin​(org.anchoranalysis.image.bean.unitvalue.extent.UnitValueExtent min)
      Minimum-boundary for acceptable range

      We default to volume as units, but it could also be area. It's arbitrary for 0-value.

    • getMax

      public org.anchoranalysis.image.bean.unitvalue.extent.UnitValueExtent getMax()
      Maximum-boundary for acceptable range

      We default to volume as units, but it could also be area. It's arbitrary for infinity-value.

    • setMax

      public void setMax​(org.anchoranalysis.image.bean.unitvalue.extent.UnitValueExtent max)
      Maximum-boundary for acceptable range

      We default to volume as units, but it could also be area. It's arbitrary for infinity-value.