Package org.apache.sis.image

Class TransferType<T extends Buffer>

Object

TransferType<T>

Type Parameters:

T - the type of buffer which can be used for transferring data.

All Implemented Interfaces:

Serializable

public final class TransferType<T extends Buffer>
extends Object
implements Serializable

The type of data used to transfer pixels. Data transfers happen in various Raster methods and in Pixel­Iterator.create­Window(Transfer­Type). The type used for transferring data is not necessarily the same than the type used by the raster for storing data. In particular, byte and short (both signed and unsigned) are converted to int during the transfer. Raster and Pixel­Iterator transfer data in int[], float[] and double[] arrays. Additionally, Pixel­Iterator uses also Int­Buffer, Float­Buffer and Double­Buffer.

Future evolution: this class may be refactored as an enumeration in a future Java version if JEP 301 is implemented.

Since:

1.0

See Also:

Raster.get­Transfer­Type(), Pixel­Iterator.create­Window(Transfer­Type), Serialized Form

Defined in the sis-feature module

Field Summary

Fields

Modifier and Type	Field	Description
static TransferType<DoubleBuffer>	DOUBLE	Specifies that sample values are transfered as double-precision floating point number.
static TransferType<FloatBuffer>	FLOAT	Specifies that sample values are transfered as single-precision floating point number.
static TransferType<IntBuffer>	INT	Specifies that sample values are transfered as 32 bits signed integer.

Method Summary

Modifier and Type	Method	Description
String	toString()	Returns the name of this enumeration constant.
static TransferType<?>	valueOf(int type)	Returns the enumeration value for the given Data­Buffer constant.

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, wait, wait, wait

Field Detail

INT

public static final TransferType<IntBuffer> INT

Specifies that sample values are transfered as 32 bits signed integer. If the raster stores sample values as byte or short, the values are casted by a widening conversion before to be transfered. If the raster stores sample values as float or double, the values are rounded toward 0 before to be transfered.

See Also:

Pixel­Iterator.get­Sample(int), Pixel­Iterator.get­Pixel(int[])

FLOAT

public static final TransferType<FloatBuffer> FLOAT

Specifies that sample values are transfered as single-precision floating point number. Values of other types are casted as needed.

See Also:

Pixel­Iterator.get­Sample­Float(int), Pixel­Iterator.get­Pixel(float[])

DOUBLE

public static final TransferType<DoubleBuffer> DOUBLE

Specifies that sample values are transfered as double-precision floating point number. Values of other types are casted as needed. This is the safest transfer type to use when wanting to avoid any precision lost.

See Also:

Pixel­Iterator.get­Sample­Double(int), Pixel­Iterator.get­Pixel(double[])

Method Detail

valueOf

public static TransferType<?> valueOf(int type)

Returns the enumeration value for the given Data­Buffer constant. This method applies the following mapping:

• If type is Data­Buffer.TYPE_DOUBLE, returns DOUBLE.
• If type is Data­Buffer.TYPE_FLOAT, returns FLOAT.
• If type is Data­Buffer.TYPE_INT, TYPE_SHORT, TYPE_USHORT or TYPE_BYTE, returns INT.
• If type is Data­Buffer.TYPE_UNDEFINED or any other value, throws Illegal­Argument­Exception.

The type argument given to this method is typically the Raster.get­Transfer­Type() value.

Parameters:

type - one of Data­Buffer constant.

Returns:

the enumeration value for the given constant.

Throws:

Illegal­Argument­Exception - if (@code type} is not a supported Data­Buffer constant.

toString

public String toString()

Returns the name of this enumeration constant.

Overrides:

to­String in class Object

Returns:

the enumeration constant name.