loci.formats.codec

Class HuffmanCodec

java.lang.Object

loci.formats.codec.BaseCodec

loci.formats.codec.HuffmanCodec

All Implemented Interfaces:

Codec

public class HuffmanCodec
extends BaseCodec

This class implements Huffman decoding.

Author:

Melissa Linkert melissa at glencoesoftware.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	HuffmanCodec.Decoder

Field Summary

Fields

Modifier and Type	Field and Description
private HashMap<short[],HuffmanCodec.Decoder>	cachedDecoders
private int	leafCounter
private static int	LEAVES_OFFSET

Fields inherited from class loci.formats.codec.BaseCodec

LOGGER

Constructor Summary

Constructors

Constructor and Description
HuffmanCodec()

Method Summary

Modifier and Type	Method and Description
byte[]	compress(byte[] data, CodecOptions options) Compresses a block of data.
byte[]	decompress(loci.common.RandomAccessInputStream in, CodecOptions options) The CodecOptions parameter must be an instance of HuffmanCodecOptions, and should have the following fields set: table bitsPerSample maxBytes
int	getSample(BitBuffer bb, CodecOptions options) Deprecated.
int	getSample(loci.common.RandomAccessInputStream bb, CodecOptions options)

Methods inherited from class loci.formats.codec.BaseCodec

compress, decompress, decompress, decompress, decompress, test

Methods inherited from class java.lang.Object

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

Field Detail

LEAVES_OFFSET

private static final int LEAVES_OFFSET

See Also:

Constant Field Values

leafCounter

private int leafCounter

cachedDecoders

private HashMap<short[],HuffmanCodec.Decoder> cachedDecoders

Constructor Detail

HuffmanCodec

public HuffmanCodec()

Method Detail

compress

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

Description copied from interface: Codec

Compresses a block of data.

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.

decompress

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

The CodecOptions parameter must be an instance of HuffmanCodecOptions, and should have the following fields set: table bitsPerSample maxBytes

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)

getSample

@Deprecated
public int getSample(BitBuffer bb,
                                 CodecOptions options)
                          throws FormatException

Deprecated.

Throws:

FormatException

getSample

public int getSample(loci.common.RandomAccessInputStream bb,
                     CodecOptions options)
              throws FormatException

Throws:

FormatException