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

Class RangeCompareFromScalars<T extends FeatureInput>

Object

AnchorBean<Feature<T>>

InitializableBean<Feature<T>,FeatureInitialization>

Feature<T>

FeatureUnary<T,T>

FeatureUnaryGeneric<T>

RangeCompareBase<T>

RangeCompareFromScalars<T>

Type Parameters:

T - the type of FeatureInput this feature operates on

Direct Known Subclasses:

CompareWithRange, IfConditionWithinRange, IfOutsideRange

public abstract class RangeCompareFromScalars<T extends FeatureInput>
extends RangeCompareBase<T>

A base class for setting the boundaries of a range using constant scalar values.

This class extends RangeCompareBase to provide a mechanism for defining a range with fixed minimum and maximum values.

Constructor Summary

Constructors

Constructor	Description
RangeCompareFromScalars()

Method Summary

Modifier and Type	Method	Description
protected double	boundaryMax(FeatureCalculationInput<T> input)	Defines the maximum accepted value in the range.
protected double	boundaryMin(FeatureCalculationInput<T> input)	Defines the minimum accepted value in the range.
String	describeParameters()	A human-readable description of the parameterization of the bean.
double	getMax()	Boundary value indicating the maximally-allowed range value.
double	getMin()	Boundary value indicating the minimally-allowed range value.
void	setMax(double max)	Boundary value indicating the maximally-allowed range value.
void	setMin(double min)	Boundary value indicating the minimally-allowed range value.

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

calculate, featureToCalcInputValue, getAboveMaxValue, getBelowMinValue, setAboveMaxValue, setBelowMinValue, withinRangeValue

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

RangeCompareFromScalars

public RangeCompareFromScalars()

Method Details

describeParameters

public String describeParameters()

Description copied from class: Feature

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

Overrides:

describeParameters in class RangeCompareBase<T extends FeatureInput>

Returns:

the description.

boundaryMin

protected double boundaryMin(FeatureCalculationInput<T> input)

Description copied from class: RangeCompareBase

Defines the minimum accepted value in the range.

Specified by:

boundaryMin in class RangeCompareBase<T extends FeatureInput>

Parameters:

input - the FeatureCalculationInput to use for calculation

Returns:

the minimum boundary value

boundaryMax

protected double boundaryMax(FeatureCalculationInput<T> input)

Description copied from class: RangeCompareBase

Defines the maximum accepted value in the range.

Specified by:

boundaryMax in class RangeCompareBase<T extends FeatureInput>

Parameters:

input - the FeatureCalculationInput to use for calculation

Returns:

the maximum boundary value

getMin

public double getMin()

Boundary value indicating the minimally-allowed range value. Default value is Double.NEGATIVE_INFINITY.

setMin

public void setMin(double min)

Boundary value indicating the minimally-allowed range value. Default value is Double.NEGATIVE_INFINITY.

getMax

public double getMax()

Boundary value indicating the maximally-allowed range value. Default value is Double.POSITIVE_INFINITY.

setMax

public void setMax(double max)

Boundary value indicating the maximally-allowed range value. Default value is Double.POSITIVE_INFINITY.