org.opengis.coverage

Class ColorInterpretation

java.lang.Object

org.opengis.util.CodeList<ColorInterpretation>

org.opengis.coverage.ColorInterpretation

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ColorInterpretation>

@UML(identifier="CV_ColorInterpretation",
     specification=OGC_01004)
public final class ColorInterpretation
extends CodeList<ColorInterpretation>

Specifies the mapping of a band to a color model component.

WARNING: THIS CLASS WILL CHANGE. Current API is derived from OGC Grid Coverages Implementation specification 1.0. We plan to replace it by new interfaces derived from ISO 19123 (Schema for coverage geometry and functions). Current interfaces should be considered as legacy and are included in this distribution only because they were part of GeoAPI 1.0 release. We will try to preserve as much compatibility as possible, but no migration plan has been determined yet.

Since:

GeoAPI 1.0

See Also:

PaletteInterpretation, SampleDimension, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ColorInterpretation	ALPHA_BAND Alpha Band for the RGB color model components.
static ColorInterpretation	BLACK_BAND Black Band for the CMYK color model.
static ColorInterpretation	BLUE_BAND Blue Band for the RGB color model components.
static ColorInterpretation	CYAN_BAND Cyan Band for the CMYK color model.
static ColorInterpretation	GRAY_INDEX Band is an index into a lookup table.
static ColorInterpretation	GREEN_BAND Greend Band for the RGB color model components.
static ColorInterpretation	HUE_BAND Hue Band for the HLS color model.
static ColorInterpretation	LIGHTNESS_BAND Lightness Band for the HLS color model.
static ColorInterpretation	MAGENTA_BAND Magenta Band for the CMYK color model.
static ColorInterpretation	PALETTE_INDEX Band is a color index into a color table.
static ColorInterpretation	RED_BAND Red Band for the RGB color model components.
static ColorInterpretation	SATURATION_BAND Saturation Band for the HLS color model.
static ColorInterpretation	UNDEFINED Band is not associated with a color model component.
static ColorInterpretation	YELLOW_BAND Yellow Band for the CMYK color model.

Constructor Summary

Constructors

Constructor and Description
ColorInterpretation(java.lang.String name) Constructs an enum with the given name.

Method Summary

Modifier and Type	Method and Description
CodeList[]	family() Returns the list of enumerations of the same kind than this enum.
static ColorInterpretation[]	values() Returns the list of ColorInterpretations.

Methods inherited from class org.opengis.util.CodeList

compareTo, name, ordinal, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

UNDEFINED

@UML(identifier="CV_Undefined",
     obligation=CONDITIONAL,
     specification=OGC_01004)
public static final ColorInterpretation UNDEFINED

Band is not associated with a color model component.

GRAY_INDEX

@UML(identifier="CV_GrayIndex",
     obligation=CONDITIONAL,
     specification=OGC_01004)
public static final ColorInterpretation GRAY_INDEX

Band is an index into a lookup table.

See Also:

PALETTE_INDEX, PaletteInterpretation.GRAY

PALETTE_INDEX

@UML(identifier="CV_PaletteIndex",
     obligation=CONDITIONAL,
     specification=OGC_01004)
public static final ColorInterpretation PALETTE_INDEX

Band is a color index into a color table.

See Also:

GRAY_INDEX

RED_BAND

@UML(identifier="CV_RedBand",
     obligation=CONDITIONAL,
     specification=OGC_01004)
public static final ColorInterpretation RED_BAND

Red Band for the RGB color model components.

See Also:

GREEN_BAND, BLUE_BAND, ALPHA_BAND, PaletteInterpretation.RGB

GREEN_BAND

@UML(identifier="CV_GreenBand",
     obligation=CONDITIONAL,
     specification=OGC_01004)
public static final ColorInterpretation GREEN_BAND

Greend Band for the RGB color model components.

See Also:

RED_BAND, BLUE_BAND, ALPHA_BAND, PaletteInterpretation.RGB

BLUE_BAND

@UML(identifier="CV_BlueBand",
     obligation=CONDITIONAL,
     specification=OGC_01004)
public static final ColorInterpretation BLUE_BAND

Blue Band for the RGB color model components.

See Also:

RED_BAND, GREEN_BAND, ALPHA_BAND, PaletteInterpretation.RGB

ALPHA_BAND

@UML(identifier="CV_AlphaBand",
     obligation=CONDITIONAL,
     specification=OGC_01004)
public static final ColorInterpretation ALPHA_BAND

Alpha Band for the RGB color model components. Alpha band may or may not be present.

See Also:

RED_BAND, GREEN_BAND, BLUE_BAND, PaletteInterpretation.RGB

HUE_BAND

@UML(identifier="CV_HueBand",
     obligation=CONDITIONAL,
     specification=OGC_01004)
public static final ColorInterpretation HUE_BAND

Hue Band for the HLS color model.

See Also:

SATURATION_BAND, LIGHTNESS_BAND, PaletteInterpretation.HLS

SATURATION_BAND

@UML(identifier="CV_SaturationBand",
     obligation=CONDITIONAL,
     specification=OGC_01004)
public static final ColorInterpretation SATURATION_BAND

Saturation Band for the HLS color model.

See Also:

HUE_BAND, LIGHTNESS_BAND, PaletteInterpretation.HLS

LIGHTNESS_BAND

@UML(identifier="CV_LightnessBand",
     obligation=CONDITIONAL,
     specification=OGC_01004)
public static final ColorInterpretation LIGHTNESS_BAND

Lightness Band for the HLS color model.

See Also:

HUE_BAND, SATURATION_BAND, PaletteInterpretation.HLS

CYAN_BAND

@UML(identifier="CV_CyanBand",
     obligation=CONDITIONAL,
     specification=OGC_01004)
public static final ColorInterpretation CYAN_BAND

Cyan Band for the CMYK color model.

See Also:

MAGENTA_BAND, YELLOW_BAND, BLACK_BAND, PaletteInterpretation.CMYK

MAGENTA_BAND

@UML(identifier="CV_MagentaBand",
     obligation=CONDITIONAL,
     specification=OGC_01004)
public static final ColorInterpretation MAGENTA_BAND

Magenta Band for the CMYK color model.

See Also:

CYAN_BAND, YELLOW_BAND, BLACK_BAND, PaletteInterpretation.CMYK

YELLOW_BAND

@UML(identifier="CV_YellowBand",
     obligation=CONDITIONAL,
     specification=OGC_01004)
public static final ColorInterpretation YELLOW_BAND

Yellow Band for the CMYK color model.

See Also:

CYAN_BAND, MAGENTA_BAND, BLACK_BAND, PaletteInterpretation.CMYK

BLACK_BAND

@UML(identifier="CV_BlackBand",
     obligation=CONDITIONAL,
     specification=OGC_01004)
public static final ColorInterpretation BLACK_BAND

Black Band for the CMYK color model.

See Also:

CYAN_BAND, MAGENTA_BAND, YELLOW_BAND, PaletteInterpretation.CMYK

Constructor Detail

ColorInterpretation

public ColorInterpretation(java.lang.String name)

Constructs an enum with the given name. The new enum is automatically added to the list returned by values().

Parameters:

name - The enum name. This name must not be in use by an other enum of this type.

Method Detail

values

public static ColorInterpretation[] values()

Returns the list of ColorInterpretations.

family

public CodeList[] family()

Returns the list of enumerations of the same kind than this enum.

Specified by:

family in class CodeList<ColorInterpretation>