org.geotoolkit.image.io.mosaic
Enum ImageTypePolicy

Object
  Enum<ImageTypePolicy>
      ImageTypePolicy

All Implemented Interfaces:

Serializable, Comparable<ImageTypePolicy>

public enum ImageTypePolicy
extends Enum<ImageTypePolicy>

The policy for computing image types in a mosaic. Those policies offer various compromise between performance and safety in presence of a mosaic of heterogenous image format. The SUPPORTED_BY_ALL mode is the safest one, but may be very expensive to compute. The SUPPORTED_BY_FIRST mode is faster, but assume that every tiles in a mosaic use the same image format.

Since:

2.5

Version:

3.15

Author:

Martin Desruisseaux (Geomatys)

See Also:

MosaicImageReadParam.getImageTypePolicy(), MosaicImageReader.getDefaultImageTypePolicy()

Module:

coverage/geotk-coverageio (download)

View source code for this class

Enum Constant Summary

ALWAYS_ARGB
Returns a single type specifier for images of TYPE_INT_ARGB.

ALWAYS_RGB
Returns a single type specifier for images of TYPE_INT_RGB.

SUPPORTED_BY_ALL
Returns type specifiers that are supported by every tiles.

SUPPORTED_BY_FIRST
Returns type specifiers that are supported by one of the first tiles to be read.

SUPPORTED_BY_ONE
Returns type specifiers that are supported by one tile, selected arbitrary.

Method Summary

static ImageTypePolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static ImageTypePolicy[]	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

SUPPORTED_BY_ALL

public static final ImageTypePolicy SUPPORTED_BY_ALL

Returns type specifiers that are supported by every tiles. This is the most robust policy, but also the most expensive. This policy should be selected when the tiles may be stored in heterogeneous formats.

SUPPORTED_BY_ONE

public static final ImageTypePolicy SUPPORTED_BY_ONE

Returns type specifiers that are supported by one tile, selected arbitrary. This policy is appropriate when the tiles are stored in a homogeneous format.

When Java assertions are enabled, MosaicImageReader will ensures that this policy produces the same result than the SUPPORTED_BY_ALL policy.

SUPPORTED_BY_FIRST

public static final ImageTypePolicy SUPPORTED_BY_FIRST

Returns type specifiers that are supported by one of the first tiles to be read. This policy is similar to SUPPORTED_BY_ONE, except that the result is cached for all future invocation of the read method, unless a new input is set.

Since:

3.15

ALWAYS_ARGB

public static final ImageTypePolicy ALWAYS_ARGB

Returns a single type specifier for images of TYPE_INT_ARGB. This policy should be used only when tiles are known in advance to be compatible with the ARGB model, and this model is wanted.

ALWAYS_RGB

public static final ImageTypePolicy ALWAYS_RGB

Returns a single type specifier for images of TYPE_INT_RGB. This policy should be used only when tiles are known in advance to be compatible with the RGB model, and this model is wanted.

Since:

3.15

Method Detail

values

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

Returns:

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

valueOf

public static ImageTypePolicy 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