Module io.scif

Package io.scif.codec

Class LuraWaveCodec

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

io.scif.AbstractSCIFIOPlugin

io.scif.codec.AbstractCodec

io.scif.codec.LuraWaveCodec

All Implemented Interfaces:

Codec, SCIFIOPlugin, Comparable<org.scijava.Prioritized>, org.scijava.Contextual, org.scijava.Identifiable, org.scijava.Locatable, org.scijava.log.Logged, org.scijava.plugin.HasPluginInfo, org.scijava.plugin.RichPlugin, org.scijava.plugin.SciJavaPlugin, org.scijava.plugin.SingletonPlugin, org.scijava.Prioritized, org.scijava.Versioned

public class LuraWaveCodec
extends AbstractCodec

This class provides LuraWave decompression, using LuraWave's Java decoding library. Compression is not supported. Decompression requires a LuraWave license code, specified in the lurawave.license system property (e.g., -Dlurawave.license=XXXX on the command line).

Author:

Curtis Rueden

Constructor Summary

Constructors

Constructor	Description
LuraWaveCodec()

Method Summary

Modifier and Type	Method	Description
byte[]	compress(byte[] data, CodecOptions options)	Compresses a block of data.
byte[]	decompress(byte[] buf, CodecOptions options)	The CodecOptions parameter should have the following fields set: maxBytes
byte[]	decompress(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> in, CodecOptions options)	Decompresses data from the given DataHandle.

Methods inherited from class io.scif.codec.AbstractCodec

compress, decompress, decompress, decompress, test

Methods inherited from class io.scif.AbstractSCIFIOPlugin

getVersion, log

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

getInfo, getPriority, setInfo, setPriority, toString

Methods inherited from class org.scijava.AbstractContextual

context, getContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier

Methods inherited from interface io.scif.SCIFIOPlugin

getVersion, log

Constructor Detail

LuraWaveCodec

public LuraWaveCodec()

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(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> in,
                         CodecOptions options)
                  throws FormatException,
                         IOException

Description copied from interface: Codec

Decompresses data from the given DataHandle.

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

decompress

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

The CodecOptions parameter should have the following fields set: maxBytes

Specified by:

decompress in interface Codec

Overrides:

decompress in class AbstractCodec

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)