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

Class RatioThreshold

Object

AnchorBean<Feature<FeatureInputHistogram>>

InitializableBean<Feature<FeatureInputHistogram>,FeatureInitialization>

Feature<FeatureInputHistogram>

FeatureHistogram

FeatureHistogramStatistic

RatioThreshold

public class RatioThreshold
extends FeatureHistogramStatistic

Calculates the ratio of values in a Histogram that satisfy a specified threshold condition.

Constructor Summary

Constructors

Constructor	Description
RatioThreshold()

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.
String	describeParameters()	A human-readable description of the parameterization of the bean.
RelationToThreshold	getThreshold()	The threshold condition to be applied to the histogram values.
void	setThreshold(RelationToThreshold threshold)	The threshold condition to be applied to the histogram values.

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

RatioThreshold

public RatioThreshold()

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.

describeParameters

public String describeParameters()

Description copied from class: Feature

A human-readable description of the parameterization of the bean.

Overrides:

describeParameters in class Feature<FeatureInputHistogram>

Returns:

the description.

getThreshold

public RelationToThreshold getThreshold()

The threshold condition to be applied to the histogram values.

This RelationToThreshold defines how each value in the histogram should be compared to a threshold value.

setThreshold

public void setThreshold(RelationToThreshold threshold)

The threshold condition to be applied to the histogram values.

This RelationToThreshold defines how each value in the histogram should be compared to a threshold value.