Package noaa.coastwatch.render

Class LinearEnhancement

java.lang.Object

noaa.coastwatch.util.Function

noaa.coastwatch.render.EnhancementFunction

noaa.coastwatch.render.LinearEnhancement

All Implemented Interfaces:

Serializable, Cloneable, Encodable

Direct Known Subclasses:

StepEnhancement

public class LinearEnhancement
extends EnhancementFunction

A linear enhancement is an enhancement function formed by a linear y = mx + b relationship.

Since:

3.1.1

Author:

Peter Hollemans

See Also:

• Serialized Form

Field Summary

Fields inherited from class noaa.coastwatch.render.EnhancementFunction

range, reverse

Constructor Summary

Constructors

Constructor	Description
LinearEnhancement(double[] range)	Constructs a linear enhancement from the data value range.

Method Summary

Modifier and Type	Method	Description
String	describe()	Gets a description of the function.
double	evaluate(double[] variables)	Evaluates the enhancement at the specified data value.
double	getInverse(double normValue)	Gets the inverse enhancement value.
protected void	reset()	Resets the enhancement function.

Methods inherited from class noaa.coastwatch.render.EnhancementFunction

clone, equals, getRange, getReverse, getValue, normalize, setRange, setReverse

Methods inherited from class noaa.coastwatch.util.Function

getEncoding, useEncoding

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LinearEnhancement

public LinearEnhancement(double[] range)

Constructs a linear enhancement from the data value range. The minimum and maximum data values are mapped to [0..1].

Parameters:

range - the enhancement range as [min, max].

Method Details

getInverse

public double getInverse(double normValue)

Description copied from class: EnhancementFunction

Gets the inverse enhancement value.

Specified by:

getInverse in class EnhancementFunction

Parameters:

normValue - the normalized data value.

Returns:

the unnormalized data value.

evaluate

public double evaluate(double[] variables)

Evaluates the enhancement at the specified data value. The EnhancementFunction.getValue(double) method should be used instead of this method for evaluating enhancement values.

Specified by:

evaluate in class Function

Parameters:

variables - a double[1] specifying the data value.

Returns:

the enhancement value.

reset

protected void reset()

Resets the enhancement function.

Overrides:

reset in class EnhancementFunction

describe

public String describe()

Description copied from class: EnhancementFunction

Gets a description of the function.

Specified by:

describe in class EnhancementFunction