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

Class Quantile

Object

AnchorBean<Feature<FeatureInputHistogram>>

InitializableBean<Feature<FeatureInputHistogram>,FeatureInitialization>

Feature<FeatureInputHistogram>

FeatureHistogram

FeatureHistogramStatistic

Quantile

public class Quantile
extends 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(Histogram histogram)	Calculates the statistic from the histogram, that is subsequently returned as the feature-value.
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

Quantile

public Quantile()

Method Details

calculateStatisticFrom

protected double calculateStatisticFrom(Histogram histogram)
                                 throws FeatureCalculationException

Description copied from class: FeatureHistogramStatistic

Calculates the statistic from the histogram, that is subsequently returned as the feature-value.

Specified by:

calculateStatisticFrom in class FeatureHistogramStatistic

Parameters:

histogram - the histogram to calculate the statistic from.

Returns:

the calculated statistic.

Throws:

FeatureCalculationException - if the calculation cannot succeed.

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