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

Class InvertedMax<T extends FeatureInput>

Object

AnchorBean<Feature<T>>

InitializableBean<Feature<T>,FeatureInitialization>

Feature<T>

FeatureUnary<T,T>

FeatureUnaryGeneric<T>

InvertedMax<T>

Type Parameters:

T - feature input-type

public class InvertedMax<T extends FeatureInput>
extends FeatureUnaryGeneric<T>

Finds the repciprocal (multiplicate inverse), but imposes a maximum ceiling via a constant.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
InvertedMax()

Method Summary

Modifier and Type	Method	Description
double	calculate(FeatureCalculationInput<T> input)	Calculates a value for some input.
String	describeParameters()	A human-readable description of the parameterization of the bean.
String	descriptionLong()	A long human-readable description of the feature and some or all of its parameterization.
double	getMax()
void	setMax(double max)

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

InvertedMax

public InvertedMax()

Method Details

calculate

public double calculate(FeatureCalculationInput<T> input)
                 throws FeatureCalculationException

Description copied from class: Feature

Calculates a value for some input.

Specified by:

calculate in class Feature<T extends FeatureInput>

Parameters:

input - the input to the calculation.

Returns:

the result of the calculation.

Throws:

FeatureCalculationException - if the calculation cannot successfully complete.

describeParameters

public String describeParameters()

Description copied from class: Feature

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

Overrides:

describeParameters in class Feature<T extends FeatureInput>

Returns:

the description.

descriptionLong

public String descriptionLong()

Description copied from class: Feature

A long human-readable description of the feature and some or all of its parameterization.

This can be overwritten to create an alternative description for features. By default string returned by Feature.describeBean() is used.

Overrides:

descriptionLong in class Feature<T extends FeatureInput>

Returns:

the description.

getMax

public double getMax()

setMax

public void setMax(double max)