Package org.anchoranalysis.plugin.image.feature.bean.histogram.statistic

Class Quantile

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.FeatureInputHistogram>
org.anchoranalysis.image.feature.bean.FeatureHistogram
org.anchoranalysis.image.feature.bean.histogram.FeatureHistogramStatistic
org.anchoranalysis.plugin.image.feature.bean.histogram.statistic.Quantile
public class Quantile
extends org.anchoranalysis.image.feature.bean.histogram.FeatureHistogramStatistic
Calculates a specified quantile value from a Histogram.

  • Constructor Summary

    Constructors 
    Constructor Description
    Quantile()  

  • Method Summary

    Modifier and Type Method Description
    protected double calculateStatisticFrom​(org.anchoranalysis.math.histogram.Histogram histogram)  
    double getQuantile()
    The quantile to calculate from the histogram.
    void setQuantile​(double quantile)
    The quantile to calculate from the histogram.

    Methods inherited from class org.anchoranalysis.image.feature.bean.histogram.FeatureHistogramStatistic

    calculate, getValueIfEmpty, isExceptionIfEmpty, setExceptionIfEmpty, setValueIfEmpty

    Methods inherited from class org.anchoranalysis.image.feature.bean.FeatureHistogram

    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

    • calculateStatisticFrom

      protected double calculateStatisticFrom​(org.anchoranalysis.math.histogram.Histogram histogram) throws org.anchoranalysis.feature.calculate.FeatureCalculationException
      Specified by:
      calculateStatisticFrom in class org.anchoranalysis.image.feature.bean.histogram.FeatureHistogramStatistic
      Throws:
      org.anchoranalysis.feature.calculate.FeatureCalculationException

    • getQuantile

      public double getQuantile()
      The quantile to calculate from the histogram.

      This value should be between 0.0 and 1.0, where:

      • 0.0 represents the minimum value
      • 0.5 represents the median
      • 1.0 represents the maximum value

    • setQuantile

      public void setQuantile​(double quantile)
      The quantile to calculate from the histogram.

      This value should be between 0.0 and 1.0, where:

      • 0.0 represents the minimum value
      • 0.5 represents the median
      • 1.0 represents the maximum value