Package noaa.coastwatch.render

Class ColorEnhancementSettings

java.lang.Object

noaa.coastwatch.render.ColorEnhancementSettings

All Implemented Interfaces:

Cloneable

public class ColorEnhancementSettings
extends Object
implements Cloneable

The ColorEnhancementSettings class stores palette and enhancement function information for a color enhancement of a data variable. The settings may be used to save and later restore a color enhancement.

Since:

3.1.7

Author:

Peter Hollemans

See Also:

• ColorEnhancement

Constructor Summary

Constructors

Constructor	Description
ColorEnhancementSettings(String variableName, Palette palette, EnhancementFunction function)	Creates a new settings object.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Creates and returns a copy of this object.
EnhancementFunction	getFunction()	Gets the color enhancement function.
String	getName()	Gets the variable name.
Palette	getPalette()	Gets the color enhancement palette.
void	setFunction(EnhancementFunction function)	Gets the color enhancement function.
void	setPalette(Palette palette)	Sets the color enhancement palette.

Methods inherited from class java.lang.Object

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

Constructor Details

ColorEnhancementSettings

public ColorEnhancementSettings(String variableName,
 Palette palette,
 EnhancementFunction function)

Creates a new settings object.

Parameters:

variableName - the data variable name.

palette - the color enhancement palette.

function - the color enhancement function.

Method Details

getName

public String getName()

Gets the variable name.

getPalette

public Palette getPalette()

Gets the color enhancement palette.

setPalette

public void setPalette(Palette palette)

Sets the color enhancement palette.

getFunction

public EnhancementFunction getFunction()

Gets the color enhancement function.

setFunction

public void setFunction(EnhancementFunction function)

Gets the color enhancement function.

clone

public Object clone()

Creates and returns a copy of this object.

Overrides:

clone in class Object