agi.foundation.graphics.imaging

(agi.foundation.graphics-2024r3.jar)

Enum RasterBand

java.lang.Object

java.lang.Enum<RasterBand>

agi.foundation.graphics.imaging.RasterBand

All Implemented Interfaces:

Enumeration, Serializable, Comparable<RasterBand>

public enum RasterBand
extends Enum<RasterBand>
implements Enumeration

Common band types that may be contained within a Raster dataset. Each band can be thought of as a set of values, which are most commonly associated with colors when the raster represents an image. For instance, a typical color image contains three sets of values, or bands (red, green, and blue) which define the color of pixels within the image.

See Also:

RasterAttributes, Rasters and Filtering topic

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALPHA A band containing alpha values.
BLUE A band containing blue values.
GREEN A band containing green values.
LUMINANCE A band containing luminance values.
RED A band containing red values.

Method Summary

Modifier and Type	Method and Description
static RasterBand	getDefault() Get the enum constant that is considered to be the default.
static RasterBand	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static RasterBand	valueOf(String name) Returns the enum constant of this type with the specified name.
static RasterBand[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RED

public static final RasterBand RED

A band containing red values.

GREEN

public static final RasterBand GREEN

A band containing green values.

BLUE

public static final RasterBand BLUE

A band containing blue values.

ALPHA

public static final RasterBand ALPHA

A band containing alpha values.

LUMINANCE

public static final RasterBand LUMINANCE

A band containing luminance values.

Method Detail

values

public static RasterBand[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RasterBand c : RasterBand.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RasterBand valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static RasterBand getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static RasterBand getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.