loci.formats.codec

Class JPEG2000Codec

java.lang.Object

loci.formats.codec.BaseCodec

loci.formats.codec.JPEG2000Codec

All Implemented Interfaces:

Codec

public class JPEG2000Codec
extends BaseCodec

This class implements JPEG 2000 compression and decompression.

Source code:

Trac, Gitweb

Field Summary

Fields inherited from class loci.formats.codec.BaseCodec

LOGGER

Constructor Summary

Constructors

Constructor and Description
JPEG2000Codec()

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	compress(byte[] data, CodecOptions options) The CodecOptions parameter should have the following fields set: width height bitsPerSample channels interleaved littleEndian lossless
byte[]	decompress(byte[] buf, CodecOptions options) The CodecOptions parameter should have the following fields set: interleaved littleEndian
byte[]	decompress(RandomAccessInputStream in, CodecOptions options) The CodecOptions parameter should have the following fields set: interleaved littleEndian

Methods inherited from class loci.formats.codec.BaseCodec

compress, decompress, decompress, decompress, test

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JPEG2000Codec

public JPEG2000Codec()

Method Detail

compress

public byte[] compress(byte[] data,
              CodecOptions options)
                throws FormatException

The CodecOptions parameter should have the following fields set: width height bitsPerSample channels interleaved littleEndian lossless

Parameters:

data - The data to be compressed.

options - Options to be used during compression, if appropriate.

Returns:

The compressed data.

Throws:

FormatException - If input is not a compressed data block of the appropriate type.

See Also:

Codec.compress(byte[], CodecOptions)

decompress

public byte[] decompress(RandomAccessInputStream in,
                CodecOptions options)
                  throws FormatException,
                         IOException

The CodecOptions parameter should have the following fields set: interleaved littleEndian

Specified by:

decompress in interface Codec

Specified by:

decompress in class BaseCodec

Parameters:

in - The stream from which to read compressed data.

options - Options to be used during decompression.

Returns:

The decompressed data.

Throws:

FormatException - If data is not valid compressed data for this decompressor.

IOException

See Also:

Codec.decompress(RandomAccessInputStream, CodecOptions)

decompress

public byte[] decompress(byte[] buf,
                CodecOptions options)
                  throws FormatException

The CodecOptions parameter should have the following fields set: interleaved littleEndian

Specified by:

decompress in interface Codec

Overrides:

decompress in class BaseCodec

Parameters:

buf - the data to be decompressed

options - Options to be used during decompression.

Returns:

the decompressed data.

Throws:

FormatException - If data is not valid.

See Also:

Codec.decompress(byte[], CodecOptions)