Package noaa.coastwatch.render

Class ColorPointEnhancement

java.lang.Object

noaa.coastwatch.render.EarthDataView

noaa.coastwatch.render.SolidBackground

noaa.coastwatch.render.ColorPointEnhancement

All Implemented Interfaces:

Cloneable, Renderable

public class ColorPointEnhancement
extends SolidBackground

The ColorPointEnhancement class uses a Palette and EnhancementFunction to render a PointFeatureOverlay to an earth view.

Since:

3.2.0

Author:

Peter Hollemans

See Also:

• ColorEnhanced
• ColorEnhancement
• PointFeatureOverlay

Field Summary

Fields inherited from class noaa.coastwatch.render.EarthDataView

changed, image, imageDims, overlays, progress, stopRendering, trans, UPDATE_FRACTION, verbose

Constructor Summary

Constructors

Constructor	Description
ColorPointEnhancement(PointFeatureOverlay overlay, String name, String units, EarthTransform trans)	Creates a new point enhancement with white background.

Method Summary

Modifier and Type	Method	Description
EnhancementFunction	getFunction()	Gets the enhancement function.
Legend	getLegend()	Gets a data color scale legend for annotation of this color point enhancement.
Color	getMissingColor()	Gets the missing value color.
Palette	getPalette()	Gets the enhancement color palette.
void	normalize(double units)	Normalizes the enhancement function for this view using the visible grid value statistics.
void	restoreSettings(ColorEnhancementSettings settings)	Restores the previously saved settings.
ColorEnhancementSettings	saveSettings()	Saves and returns the current settings.
void	setFunction(EnhancementFunction func)	Sets the enhancement function.
void	setMissingColor(Color missingColor)	Sets the missing value color.
void	setPalette(Palette pal)	Sets the enhancement color palette.

Methods inherited from class noaa.coastwatch.render.SolidBackground

getBackground, prepare, setBackground

Methods inherited from class noaa.coastwatch.render.EarthDataView

addOverlay, addOverlays, clone, computeCaches, containsOverlay, getArea, getBounds, getCenter, getCorners, getImageAffine, getOrientationAffine, getOverlays, getProgress, getResolution, getScale, getSize, getSubregion, getTransform, getUpsideDown, hasCompatibleCaches, hasCoordinateCaches, invalidate, isChanged, isPrepared, isRendering, magnify, magnify, magnify, main, removeOverlay, render, reset, resize, resize, resizeHeight, resizeMaxAspect, resizeWidth, setCenter, setCenterAndScale, setChanged, setImageAffine, setProgress, setProperties, setSize, setVerbose, showSubregion, stopRendering, transform, transform

Methods inherited from class java.lang.Object

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

Constructor Details

ColorPointEnhancement

public ColorPointEnhancement(PointFeatureOverlay overlay,
 String name,
 String units,
 EarthTransform trans)
                      throws NoninvertibleTransformException

Creates a new point enhancement with white background.

Parameters:

overlay - the overlay to use for rendering point data.

name - the enhancement variable name used for color bar legend.

units - the enhancement variable units used for color bar legend.

trans - the view earth transform.

Throws:

NoninvertibleTransformException - if the resulting image transform is not invertible.

Method Details

getPalette

public Palette getPalette()

Gets the enhancement color palette.

getFunction

public EnhancementFunction getFunction()

Gets the enhancement function.

setPalette

public void setPalette(Palette pal)

Sets the enhancement color palette.

setMissingColor

public void setMissingColor(Color missingColor)

Sets the missing value color.

getMissingColor

public Color getMissingColor()

Gets the missing value color.

setFunction

public void setFunction(EnhancementFunction func)

Sets the enhancement function.

getLegend

public Legend getLegend()

Gets a data color scale legend for annotation of this color point enhancement.

Overrides:

getLegend in class EarthDataView

Returns:

the data color scale legend. The legend is constructed with the default font and colors.

See Also:

• DataColorScale

normalize

public void normalize(double units)

Normalizes the enhancement function for this view using the visible grid value statistics.

Parameters:

units - the number of standard deviation units above and below the mean for the data range.

saveSettings

public ColorEnhancementSettings saveSettings()

Saves and returns the current settings.

restoreSettings

public void restoreSettings(ColorEnhancementSettings settings)

Restores the previously saved settings.

Parameters:

settings - the settings to restore. Only the palette and function are used -- the variable name is igored.