Package loci.formats.codec

Class PassthroughCodec

java.lang.Object

loci.formats.codec.BaseCodec

loci.formats.codec.PassthroughCodec

All Implemented Interfaces:

loci.formats.codec.Codec

public class PassthroughCodec
extends BaseCodec

A codec which just returns the exact data it was given, performing no compression or decompression.

Field Summary

Fields

Modifier and Type	Field	Description
protected Codec	codec

Fields inherited from class loci.formats.codec.BaseCodec

LOGGER

Constructor Summary

Constructors

Constructor	Description
PassthroughCodec()

Method Summary

Modifier and Type	Method	Description
byte[]	compress(byte[][] data, loci.formats.codec.CodecOptions options)	2D data block encoding default implementation.
byte[]	compress(byte[] data, loci.formats.codec.CodecOptions options)
byte[]	decompress(byte[] data)
byte[]	decompress(byte[][] data)
byte[]	decompress(byte[][] data, loci.formats.codec.CodecOptions options)	2D data block decoding default implementation.
byte[]	decompress(byte[] data, loci.formats.codec.CodecOptions options)
byte[]	decompress(RandomAccessInputStream in, loci.formats.codec.CodecOptions options)
protected static CodecOptions	getOptions(loci.formats.codec.CodecOptions options)

Methods inherited from class loci.formats.codec.BaseCodec

test

Methods inherited from class java.lang.Object

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

Field Details

codec

protected Codec codec

Constructor Details

PassthroughCodec

public PassthroughCodec()

Method Details

compress

public byte[] compress(byte[] data,
 loci.formats.codec.CodecOptions options)
                throws loci.formats.FormatException

Throws:

loci.formats.FormatException

compress

public byte[] compress(byte[][] data,
 loci.formats.codec.CodecOptions options)
                throws loci.formats.FormatException

Description copied from class: BaseCodec

2D data block encoding default implementation. This method simply concatenates data[0] + data[1] + ... + data[i] into a 1D block of data, then calls the 1D version of compress.

Specified by:

compress in interface loci.formats.codec.Codec

Overrides:

compress in class BaseCodec

Parameters:

data - The data to be compressed.

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

Returns:

The compressed data.

Throws:

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

decompress

public byte[] decompress(byte[] data,
 loci.formats.codec.CodecOptions options)
                  throws loci.formats.FormatException

Specified by:

decompress in interface loci.formats.codec.Codec

Overrides:

decompress in class BaseCodec

Throws:

loci.formats.FormatException

decompress

public byte[] decompress(byte[][] data,
 loci.formats.codec.CodecOptions options)
                  throws loci.formats.FormatException

Description copied from class: BaseCodec

2D data block decoding default implementation. This method simply concatenates data[0] + data[1] + ... + data[i] into a 1D block of data, then calls the 1D version of decompress.

Specified by:

decompress in interface loci.formats.codec.Codec

Overrides:

decompress in class BaseCodec

Parameters:

data - The data to be decompressed.

Returns:

The decompressed data.

Throws:

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

decompress

public byte[] decompress(byte[] data)
                  throws loci.formats.FormatException

Specified by:

decompress in interface loci.formats.codec.Codec

Overrides:

decompress in class BaseCodec

Throws:

loci.formats.FormatException

decompress

public byte[] decompress(byte[][] data)
                  throws loci.formats.FormatException

Specified by:

decompress in interface loci.formats.codec.Codec

Overrides:

decompress in class BaseCodec

Throws:

loci.formats.FormatException

decompress

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

Specified by:

decompress in interface loci.formats.codec.Codec

Specified by:

decompress in class BaseCodec

Throws:

loci.formats.FormatException

IOException

getOptions

protected static CodecOptions getOptions(loci.formats.codec.CodecOptions options)
                                  throws loci.formats.FormatException

Throws:

loci.formats.FormatException