org.geotools.cv
Class SampleDimensionType

java.lang.Object
  javax.media.jai.EnumeratedParameter
      org.geotools.cv.SampleDimensionType

All Implemented Interfaces:

java.io.Serializable

Deprecated. Replaced by SampleDimensionType in the org.opengis.coverage package.

public final class SampleDimensionType

extends javax.media.jai.EnumeratedParameter

Contains information for an individual sample dimension of coverage. This interface is applicable to any coverage type. For grid coverages, the sample dimension refers to an individual band.

Version:

$Id: SampleDimensionType.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

OpenGIS, Martin Desruisseaux

See Also:

CV_SampleDimensionType, Serialized Form

Field Summary

static SampleDimensionType	BIT Deprecated. 1 bit integers.
static SampleDimensionType	BYTE Deprecated. Signed 8 bits integers.
static SampleDimensionType	DOUBLE Deprecated. Double precision floating point numbers.
static SampleDimensionType	DOUBLET Deprecated. 2 bits integers.
static SampleDimensionType	FLOAT Deprecated. Simple precision floating point numbers.
static SampleDimensionType	INT Deprecated. Signed 32 bits integers.
static SampleDimensionType	NIBBLE Deprecated. 4 bits integers (also called "quartet" or "half-byte").
static SampleDimensionType	SHORT Deprecated. Signed 16 bits integers.
static SampleDimensionType	UBYTE Deprecated. Unsigned 8 bits integers.
static SampleDimensionType	UINT Deprecated. Unsigned 32 bits integers.
static SampleDimensionType	USHORT Deprecated. Unsigned 16 bits integers.

Method Summary

int	getDataBufferType() Deprecated. Returns the DataBuffer type.
static SampleDimensionType	getEnum(int value) Deprecated. Return the enum for the specified value.
static SampleDimensionType	getEnum(javax.media.jai.util.Range range) Deprecated. Returns the enum for the smallest type capable to hold the specified range of values.
static SampleDimensionType	getEnum(org.opengis.coverage.SampleDimensionType value) Deprecated. Return the enum for the specified value.
static SampleDimensionType	getEnum(java.awt.image.SampleModel model, int band) Deprecated. Return the enum for the specified sample model and band number.
java.lang.String	getName(java.util.Locale locale) Deprecated. Returns this enum's name in the specified locale.
int	getSize() Deprecated. Returns the size in bits.
boolean	isFloatingPoint() Deprecated. Returns true for floating-point data type.
boolean	isSigned() Deprecated. Returns true for signed sample type.

Methods inherited from class javax.media.jai.EnumeratedParameter

equals, getName, getValue, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

BIT

public static final SampleDimensionType BIT

Deprecated.

1 bit integers.

See Also:

CV_SampleDimensionType.CV_1BIT, DataBuffer.TYPE_BYTE

DOUBLET

public static final SampleDimensionType DOUBLET

Deprecated.

2 bits integers.

See Also:

CV_SampleDimensionType.CV_2BIT, DataBuffer.TYPE_BYTE

NIBBLE

public static final SampleDimensionType NIBBLE

Deprecated.

4 bits integers (also called "quartet" or "half-byte").

See Also:

CV_SampleDimensionType.CV_4BIT, DataBuffer.TYPE_BYTE

UBYTE

public static final SampleDimensionType UBYTE

Deprecated.

Unsigned 8 bits integers.

See Also:

CV_SampleDimensionType.CV_8BIT_U, DataBuffer.TYPE_BYTE

BYTE

public static final SampleDimensionType BYTE

Deprecated.

Signed 8 bits integers. The equivalent Java data type is DataBuffer.TYPE_BYTE.

See Also:

CV_SampleDimensionType.CV_8BIT_S, DataBuffer.TYPE_BYTE

USHORT

public static final SampleDimensionType USHORT

Deprecated.

Unsigned 16 bits integers. The equivalent Java data type is DataBuffer.TYPE_USHORT.

See Also:

CV_SampleDimensionType.CV_16BIT_U, DataBuffer.TYPE_USHORT

SHORT

public static final SampleDimensionType SHORT

Deprecated.

Signed 16 bits integers. The equivalent Java data type is DataBuffer.TYPE_SHORT.

See Also:

CV_SampleDimensionType.CV_16BIT_S, DataBuffer.TYPE_SHORT

UINT

public static final SampleDimensionType UINT

Deprecated.

Unsigned 32 bits integers.

See Also:

CV_SampleDimensionType.CV_32BIT_U, DataBuffer.TYPE_INT

INT

public static final SampleDimensionType INT

Deprecated.

Signed 32 bits integers. The equivalent Java data type is DataBuffer.TYPE_INT.

See Also:

CV_SampleDimensionType.CV_32BIT_S, DataBuffer.TYPE_INT

FLOAT

public static final SampleDimensionType FLOAT

Deprecated.

Simple precision floating point numbers. The equivalent Java data type is DataBuffer.TYPE_FLOAT.

See Also:

CV_SampleDimensionType.CV_32BIT_REAL, DataBuffer.TYPE_FLOAT

DOUBLE

public static final SampleDimensionType DOUBLE

Deprecated.

Double precision floating point numbers. The equivalent Java data type is DataBuffer.TYPE_DOUBLE.

See Also:

CV_SampleDimensionType.CV_64BIT_REAL, DataBuffer.TYPE_DOUBLE

Method Detail

getEnum

public static SampleDimensionType getEnum(int value)
                                   throws java.util.NoSuchElementException

Deprecated.

Return the enum for the specified value. This method is provided for compatibility with CV_SampleDimensionType.

Parameters:

value - The enum value.

Returns:

The enum for the specified value.

Throws:

java.util.NoSuchElementException - if there is no enum for the specified value.

getEnum

public static SampleDimensionType getEnum(org.opengis.coverage.SampleDimensionType value)
                                   throws java.util.NoSuchElementException

Deprecated.

Return the enum for the specified value. This method is provided for compatibility with SampleDimensionType.

Parameters:

value - The enum value.

Returns:

The enum for the specified value.

Throws:

java.util.NoSuchElementException - if there is no enum for the specified value.

getEnum

public static SampleDimensionType getEnum(javax.media.jai.util.Range range)

Deprecated.

Returns the enum for the smallest type capable to hold the specified range of values.

Parameters:

range - The range of values.

Returns:

The enum for the specified range.

getEnum

public static SampleDimensionType getEnum(java.awt.image.SampleModel model,
                                          int band)
                                   throws java.lang.IllegalArgumentException

Deprecated.

Return the enum for the specified sample model and band number. If the sample model use an undefined data type, then this method returns null.

Parameters:

model - The sample model.

band - The band to query.

Returns:

The enum for the specified sample model and band number.

Throws:

java.lang.IllegalArgumentException - if the band number is not in the valid range.

getName

public java.lang.String getName(java.util.Locale locale)

Deprecated.

Returns this enum's name in the specified locale. If no name is available for the specified locale, a default one will be used. For example, the localized name for SHORT is "16 bits unsigned integer" in English and "Entier non-sign? sur 16 bits" in French.

Parameters:

locale - The locale, or null for the default locale.

Returns:

Enum's name in the specified locale.

getDataBufferType

public int getDataBufferType()

Deprecated.

Returns the DataBuffer type. This is one of the following constants: DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, DataBuffer.TYPE_SHORT, DataBuffer.TYPE_INT, DataBuffer.TYPE_FLOAT, DataBuffer.TYPE_DOUBLE.

getSize

public int getSize()

Deprecated.

Returns the size in bits. The value range from 1 to 64. This is similar, but different than DataBuffer.getDataTypeSize(int), which have values ranging from 8 to 64.

isSigned

public boolean isSigned()

Deprecated.

Returns true for signed sample type. true is returned for BYTE, SHORT, INT, FLOAT and DOUBLE.

isFloatingPoint

public boolean isFloatingPoint()

Deprecated.

Returns true for floating-point data type. true is returned for FLOAT and DOUBLE.