Package org.anchoranalysis.plugin.operator.feature.bean.range

Class IfOutsideRange<T extends FeatureInput>

Object

AnchorBean<Feature<T>>

InitializableBean<Feature<T>,FeatureInitialization>

Feature<T>

FeatureUnary<T,T>

FeatureUnaryGeneric<T>

RangeCompareBase<T>

RangeCompareFromScalars<T>

IfOutsideRange<T>

Type Parameters:

T - the type of FeatureInput this feature operates on

public class IfOutsideRange<T extends FeatureInput>
extends RangeCompareFromScalars<T>

Clamps a feature value if it lies outside a specified range.

This class extends RangeCompareFromScalars to return particular constants if the calculated feature value is below or above an acceptable range.

Constructor Summary

Constructors

Constructor	Description
IfOutsideRange()

Method Summary

Modifier and Type	Method	Description
protected Feature<T>	featureToCalcInputValue()	Specifies which feature to calculate the input value.
protected double	withinRangeValue(double valWithinRange, FeatureCalculationInput<T> input)	Calculates the value to return if the input is within the range.

Methods inherited from class org.anchoranalysis.plugin.operator.feature.bean.range.RangeCompareFromScalars

boundaryMax, boundaryMin, describeParameters, getMax, getMin, setMax, setMin

Methods inherited from class org.anchoranalysis.plugin.operator.feature.bean.range.RangeCompareBase

calculate, getAboveMaxValue, getBelowMinValue, setAboveMaxValue, setBelowMinValue

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

IfOutsideRange

public IfOutsideRange()

Method Details

featureToCalcInputValue

protected Feature<T> featureToCalcInputValue()

Description copied from class: RangeCompareBase

Specifies which feature to calculate the input value.

Specified by:

featureToCalcInputValue in class RangeCompareBase<T extends FeatureInput>

Returns:

the Feature used to calculate the input value

withinRangeValue

protected double withinRangeValue(double valWithinRange,
 FeatureCalculationInput<T> input)
                           throws FeatureCalculationException

Description copied from class: RangeCompareBase

Calculates the value to return if the input is within the range.

Specified by:

withinRangeValue in class RangeCompareBase<T extends FeatureInput>

Parameters:

valWithinRange - the input value that is within the range

input - the FeatureCalculationInput to use for calculation

Returns:

the calculated value

Throws:

FeatureCalculationException - if the calculation fails