org.gridfour.compress

Interface ICompressionEncoder

All Known Implementing Classes:

CodecDeflate, CodecFloat, CodecHuffman, LsEncoder08, LsEncoder12

public interface ICompressionEncoder

An interface defining a coder-decoder (codec) for use by a Gridfour raster data compression implementation.

Method Summary

Modifier and Type	Method and Description
byte[]	encode(int codecIndex, int nRows, int nCols, int[] values) Encodes the specified tile data in a compressed form.
byte[]	encodeFloats(int codecIndex, int nRows, int nCols, float[] values) Encodes the specified tile data in a compressed form.
boolean	implementsFloatingPointEncoding() Indicates whether the implementation can encode floating-point values
boolean	implementsIntegerEncoding() Indicates whether the implementation can encode integral data types

Method Detail

encode

byte[] encode(int codecIndex,
              int nRows,
              int nCols,
              int[] values)

Encodes the specified tile data in a compressed form.

Parameters:

codecIndex - the index assigned by the application to associate a codec with an entry in the raster file.

nRows - a value of 1 or greater giving the number of rows in the tile

nCols - a value of 1 or greater giving the number of columns in the tile

values - the values of the tile in row-major order

Returns:

if successful, an array of bytes of length greater than 1; if unsuccessful, a null.

encodeFloats

byte[] encodeFloats(int codecIndex,
                    int nRows,
                    int nCols,
                    float[] values)

Encodes the specified tile data in a compressed form.

Parameters:

codecIndex - the index assigned by the application to associate a codec with an entry in the raster file.

nRows - a value of 1 or greater giving the number of rows in the tile

nCols - a value of 1 or greater giving the number of columns in the tile

values - the values of the tile in row-major order

Returns:

if successful, an array of bytes of length greater than 1; if unsuccessful, a null.

implementsFloatingPointEncoding

boolean implementsFloatingPointEncoding()

Indicates whether the implementation can encode floating-point values

Returns:

true if direct encoding of floats is supported, otherwise false.

implementsIntegerEncoding

boolean implementsIntegerEncoding()

Indicates whether the implementation can encode integral data types

Returns:

true if the encoding of integral data types is supported, otherwise false.