org.geotoolkit.image.io
Enum DimensionSlice.API

Object
  Enum<DimensionSlice.API>
      DimensionSlice.API

All Implemented Interfaces:

Serializable, Comparable<DimensionSlice.API>

Enclosing class:

DimensionSlice

public static enum DimensionSlice.API
extends Enum<DimensionSlice.API>

The standard Java API used for selecting the slice to read or write in a particular dimension. The region to read or write in a hyper-cube can be specified in up to 4 dimensions in the following ways:

• When reading:

1. Specifying the x ordinate of the source region.
2. Specifying the y ordinate of the source region.
3. Specifying the the source bands.
4. Specifying the image index.

• When writing:

1. Specifying the x ordinate of the destination offset.
2. Specifying the y ordinate of the destination offset.
3. Specifying the image index.

Supplemental dimensions if any can not be specified by an API from the standard Java library. DimensionSlice instances shall be created for those supplemental dimensions.

Since:

3.08

Version:

3.08

Author:

Martin Desruisseaux (Geomatys)

See Also:

DimensionSlice, MultidimensionalImageStore, IllegalImageDimensionException

Module:

coverage/geotk-coverageio (download)

View source code for this class

Enum Constant Summary

BANDS
The region to read along a dimension is specified by the source bands.

COLUMNS
The region to read/write along a dimension is specified by the x ordinate.

IMAGES
The region to read/write along a dimension is specified by the image index.

NONE
Indicates that no standard Java API match the dimension.

ROWS
The region to read/write along a dimension is specified by the y ordinate.

Method Summary

static DimensionSlice.API	valueOf(String name) Returns the enum constant of this type with the specified name.
static DimensionSlice.API[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COLUMNS

public static final DimensionSlice.API COLUMNS

The region to read/write along a dimension is specified by the x ordinate.

• On reading, this is the (x, width) attributes of the source region.
• On writing, this is the x attribute of the destination offset.

ROWS

public static final DimensionSlice.API ROWS

The region to read/write along a dimension is specified by the y ordinate.

• On reading, this is the (y, height) attributes of the source region.
• On writing, this is the y attribute of the destination offset.

BANDS

public static final DimensionSlice.API BANDS

The region to read along a dimension is specified by the source bands.

IMAGES

public static final DimensionSlice.API IMAGES

The region to read/write along a dimension is specified by the image index. Note that this parameter needs to be given directly to the ImageReader or ImageWriter instead than the IIOParam object.

NONE

public static final DimensionSlice.API NONE

Indicates that no standard Java API match the dimension.

Method Detail

values

public static DimensionSlice.API[] 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 (DimensionSlice.API c : DimensionSlice.API.values())
    System.out.println(c);

Returns:

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

valueOf

public static DimensionSlice.API 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