RasterFormat | DME Component Libraries for Java 2024 r3

java.lang.Object
- java.lang.Enum<RasterFormat>
- - agi.foundation.graphics.imaging.RasterFormat

All Implemented Interfaces:

Enumeration, Serializable, Comparable<RasterFormat>
```
public enum RasterFormat
extends Enum<RasterFormat>
implements Enumeration
```
Common RasterBand layouts that may be contained within a Raster dataset. Each pixel of the raster will contain the bands defined by the layout in the specified order. A typical color raster image will have an RGB RasterFormat.

See Also:

RasterAttributes, Rasters and Filtering topic

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALPHA` The format of the `Raster` is a single band consisting of alpha values.
`BGR` The format of the `Raster` is three bands consisting of blue, green, and red values.
`BGRA` The format of the `Raster` is four bands consisting of blue, green, red, and alpha values.
`BLUE` The format of the `Raster` is a single band consisting of blue values.
`GREEN` The format of the `Raster` is a single band consisting of green values.
`LUMINANCE` The format of the `Raster` is a single band consisting of luminance values.
`LUMINANCE_ALPHA` The format of the `Raster` is two bands consisting of luminance and alpha values.
`RED` The format of the `Raster` is a single band consisting of red values.
`RGB` The format of the `Raster` is three bands consisting of red, green, and blue values.
`RGBA` The format of the `Raster` is four bands consisting of red, green, blue, and alpha values.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RasterFormat`	`getDefault()` Get the enum constant that is considered to be the default.
`static RasterFormat`	`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 RasterFormat`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static RasterFormat[]`	`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 RasterFormat RED
```
    The format of the Raster is a single band consisting of red values.
  - GREEN
```
public static final RasterFormat GREEN
```
    The format of the Raster is a single band consisting of green values.
  - BLUE
```
public static final RasterFormat BLUE
```
    The format of the Raster is a single band consisting of blue values.
  - ALPHA
```
public static final RasterFormat ALPHA
```
    The format of the Raster is a single band consisting of alpha values.
  - RGB
```
public static final RasterFormat RGB
```
    The format of the Raster is three bands consisting of red, green, and blue values.
  - BGR
```
public static final RasterFormat BGR
```
    The format of the Raster is three bands consisting of blue, green, and red values.
  - RGBA
```
public static final RasterFormat RGBA
```
    The format of the Raster is four bands consisting of red, green, blue, and alpha values.
  - BGRA
```
public static final RasterFormat BGRA
```
    The format of the Raster is four bands consisting of blue, green, red, and alpha values.
  - LUMINANCE
```
public static final RasterFormat LUMINANCE
```
    The format of the Raster is a single band consisting of luminance values.
  - LUMINANCE_ALPHA
```
public static final RasterFormat LUMINANCE_ALPHA
```
    The format of the Raster is two bands consisting of luminance and alpha values.
- Method Detail
  - values
```
public static RasterFormat[] 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 (RasterFormat c : RasterFormat.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static RasterFormat 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 RasterFormat 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 RasterFormat getDefault()
```
    Get the enum constant that is considered to be the default.
    
    Returns:
    
    The default enum constant.

Enum RasterFormat

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

RED

GREEN

BLUE

ALPHA

RGB

BGR

RGBA

BGRA

LUMINANCE

LUMINANCE_ALPHA

Method Detail

values

valueOf

getValue

getFromValue

getDefault