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

Class RatioNonMode

Object

AnchorBean<Feature<FeatureInputHistogram>>

InitializableBean<Feature<FeatureInputHistogram>,FeatureInitialization>

Feature<FeatureInputHistogram>

FeatureHistogram

FeatureHistogramStatistic

RatioNonMode

public class RatioNonMode
extends FeatureHistogramStatistic

Calculates the ratio of non-mode pixels to total pixels in a Histogram.

The mode is the most frequent value in the histogram.

Constructor Summary

Constructors

Constructor	Description
RatioNonMode()

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.
boolean	isIgnoreZero()	Whether to ignore the zero value when calculating the ratio.
void	setIgnoreZero(boolean ignoreZero)	Whether to ignore the zero value when calculating the ratio.

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

RatioNonMode

public RatioNonMode()

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.

isIgnoreZero

public boolean isIgnoreZero()

Whether to ignore the zero value when calculating the ratio.

If true, pixels with value 0 are not considered in the calculation.

setIgnoreZero

public void setIgnoreZero(boolean ignoreZero)

Whether to ignore the zero value when calculating the ratio.

If true, pixels with value 0 are not considered in the calculation.