| Package | Description | 
|---|---|
| loci.formats | 
 Bio-Formats: a library for reading and writing popular microscopy file
formats. 
 | 
| loci.formats.codec | 
 Package containing Bio-Formats compression and decompression logic. 
 | 
| loci.formats.tiff | 
 Package containing Bio-Formats TIFF code of general utility. 
 | 
| Modifier and Type | Field and Description | 
|---|---|
protected CodecOptions | 
FormatWriter.options
The options if required. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
WriterWrapper.setCodecOptions(CodecOptions options)  | 
void | 
ImageWriter.setCodecOptions(CodecOptions options)  | 
void | 
IFormatWriter.setCodecOptions(CodecOptions options)
Sets the codec options. 
 | 
void | 
FormatWriter.setCodecOptions(CodecOptions options)  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
HuffmanCodecOptions
Options for compressing and decompressing Huffman data. 
 | 
class  | 
JPEG2000CodecOptions
Options for compressing and decompressing JPEG-2000 data. 
 | 
class  | 
MJPBCodecOptions
Options for compressing and decompressing MJPB data. 
 | 
class  | 
NikonCodecOptions
Options for compressing and decompressing Nikon NEF data. 
 | 
| Modifier and Type | Field and Description | 
|---|---|
private CodecOptions | 
JPEGTileDecoder.TileCache.options  | 
| Modifier and Type | Method and Description | 
|---|---|
static CodecOptions | 
CodecOptions.getDefaultOptions()
Return CodecOptions with reasonable default values. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
byte[] | 
BaseCodec.compress(byte[][] data,
        CodecOptions options)
2D data block encoding default implementation. 
 | 
byte[] | 
Codec.compress(byte[][] data,
        CodecOptions options)
Compresses a block of data. 
 | 
byte[] | 
ZlibCodec.compress(byte[] data,
        CodecOptions options)  | 
byte[] | 
TargaRLECodec.compress(byte[] data,
        CodecOptions options)  | 
byte[] | 
RPZACodec.compress(byte[] input,
        CodecOptions options)  | 
byte[] | 
QTRLECodec.compress(byte[] data,
        CodecOptions options)  | 
byte[] | 
PassthroughCodec.compress(byte[] data,
        CodecOptions options)  | 
byte[] | 
PackbitsCodec.compress(byte[] data,
        CodecOptions options)  | 
byte[] | 
NikonCodec.compress(byte[] data,
        CodecOptions options)  | 
byte[] | 
MSVideoCodec.compress(byte[] data,
        CodecOptions options)  | 
byte[] | 
MSRLECodec.compress(byte[] data,
        CodecOptions options)  | 
byte[] | 
MJPBCodec.compress(byte[] data,
        CodecOptions options)  | 
byte[] | 
LuraWaveCodec.compress(byte[] data,
        CodecOptions options)  | 
byte[] | 
LosslessJPEGCodec.compress(byte[] data,
        CodecOptions options)  | 
byte[] | 
LZWCodec.compress(byte[] input,
        CodecOptions options)  | 
byte[] | 
LZOCodec.compress(byte[] data,
        CodecOptions options)  | 
byte[] | 
JPEGCodec.compress(byte[] data,
        CodecOptions options)
The CodecOptions parameter should have the following fields set:
   
width
  height
  channels
  bitsPerSample
  interleaved
  littleEndian
  signed | 
byte[] | 
JPEG2000Codec.compress(byte[] data,
        CodecOptions options)
The CodecOptions parameter should have the following fields set:
   
width
  height
  bitsPerSample
  channels
  interleaved
  littleEndian
  lossless | 
byte[] | 
HuffmanCodec.compress(byte[] data,
        CodecOptions options)  | 
byte[] | 
Base64Codec.compress(byte[] input,
        CodecOptions options)  | 
byte[] | 
JPEGXRCodec.compress(byte[] data,
        CodecOptions options)  | 
byte[] | 
Codec.compress(byte[] data,
        CodecOptions options)
Compresses a block of data. 
 | 
byte[] | 
BaseCodec.decompress(byte[][] data,
          CodecOptions options)
2D data block decoding default implementation. 
 | 
byte[] | 
Codec.decompress(byte[][] data,
          CodecOptions options)
Decompresses a block of data. 
 | 
byte[] | 
QTRLECodec.decompress(byte[] data,
          CodecOptions options)
The CodecOptions parameter should have the following fields set:
   
width
  height
  bitsPerSample
  previousImage | 
byte[] | 
PassthroughCodec.decompress(byte[] data,
          CodecOptions options)  | 
byte[] | 
LuraWaveCodec.decompress(byte[] buf,
          CodecOptions options)
The CodecOptions parameter should have the following fields set:
   
maxBytes | 
byte[] | 
JPEG2000Codec.decompress(byte[] buf,
          CodecOptions options)
The CodecOptions parameter should have the following fields set:
  
interleaved
 littleEndian | 
byte[] | 
BaseCodec.decompress(byte[] data,
          CodecOptions options)  | 
byte[] | 
JPEGXRCodec.decompress(byte[] buf,
          CodecOptions options)
The CodecOptions parameter should have the following fields set:
   
maxBytes | 
byte[] | 
Codec.decompress(byte[] data,
          CodecOptions options)
Decompresses a block of data. 
 | 
byte[] | 
ZlibCodec.decompress(loci.common.RandomAccessInputStream in,
          CodecOptions options)  | 
byte[] | 
TargaRLECodec.decompress(loci.common.RandomAccessInputStream in,
          CodecOptions options)
The CodecOptions parameter should have the following fields set:
   
maxBytes
  bitsPerSample | 
byte[] | 
RPZACodec.decompress(loci.common.RandomAccessInputStream in,
          CodecOptions options)
 | 
byte[] | 
QTRLECodec.decompress(loci.common.RandomAccessInputStream in,
          CodecOptions options)  | 
byte[] | 
PassthroughCodec.decompress(loci.common.RandomAccessInputStream in,
          CodecOptions options)  | 
byte[] | 
PackbitsCodec.decompress(loci.common.RandomAccessInputStream in,
          CodecOptions options)
The CodecOptions parameter should have the following fields set:
   
maxBytes | 
byte[] | 
NikonCodec.decompress(loci.common.RandomAccessInputStream in,
          CodecOptions options)
The CodecOptions parameter must be an instance of
  
NikonCodecOptions, and should have the following fields set:
  lossless
  vPredictor
  curve
  split
  bitsPerSample
  maxBytes
  width
  height | 
byte[] | 
MSVideoCodec.decompress(loci.common.RandomAccessInputStream in,
          CodecOptions options)
The CodecOptions parameter should have the following fields set:
   
width
  height
  bitsPerSample
  previousImage | 
byte[] | 
MSRLECodec.decompress(loci.common.RandomAccessInputStream in,
          CodecOptions options)
 | 
byte[] | 
MJPBCodec.decompress(loci.common.RandomAccessInputStream in,
          CodecOptions options)
The CodecOptions parameter must be an instance of  
MJPBCodecOptions,
 and should have the following fields set:
  interlaced
  width
  height
  bitsPerSample
  littleEndian
  interleaved | 
byte[] | 
LuraWaveCodec.decompress(loci.common.RandomAccessInputStream in,
          CodecOptions options)  | 
byte[] | 
LosslessJPEGCodec.decompress(loci.common.RandomAccessInputStream in,
          CodecOptions options)
The CodecOptions parameter should have the following fields set:
   
interleaved
  littleEndian | 
byte[] | 
LZWCodec.decompress(loci.common.RandomAccessInputStream in,
          CodecOptions options)
The CodecOptions parameter should have the following fields set:
   
maxBytes | 
byte[] | 
LZOCodec.decompress(loci.common.RandomAccessInputStream in,
          CodecOptions options)  | 
byte[] | 
JPEGCodec.decompress(loci.common.RandomAccessInputStream in,
          CodecOptions options)
The CodecOptions parameter should have the following fields set:
   
interleaved
  littleEndian | 
byte[] | 
JPEG2000Codec.decompress(loci.common.RandomAccessInputStream in,
          CodecOptions options)
The CodecOptions parameter should have the following fields set:
  
interleaved
 littleEndian | 
byte[] | 
HuffmanCodec.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 | 
abstract byte[] | 
BaseCodec.decompress(loci.common.RandomAccessInputStream in,
          CodecOptions options)  | 
byte[] | 
Base64Codec.decompress(loci.common.RandomAccessInputStream in,
          CodecOptions options)  | 
byte[] | 
JPEGXRCodec.decompress(loci.common.RandomAccessInputStream in,
          CodecOptions options)  | 
byte[] | 
Codec.decompress(loci.common.RandomAccessInputStream in,
          CodecOptions options)
Decompresses data from the given RandomAccessInputStream. 
 | 
static JPEG2000CodecOptions | 
JPEG2000CodecOptions.getDefaultOptions(CodecOptions options)
Return JPEG2000CodecOptions using the given CodecOptions as the default. 
 | 
int | 
HuffmanCodec.getSample(BitBuffer bb,
         CodecOptions options)
Deprecated.  
 | 
int | 
HuffmanCodec.getSample(loci.common.RandomAccessInputStream bb,
         CodecOptions options)  | 
| Constructor and Description | 
|---|
CodecOptions(CodecOptions options)
Construct a new CodecOptions using the given CodecOptions. 
 | 
JPEG2000CodecOptions(CodecOptions options)
Creates a new instance with options. 
 | 
| Modifier and Type | Field and Description | 
|---|---|
private CodecOptions | 
TiffParser.codecOptions
Codec options to be used when decoding compressed pixel data. 
 | 
private CodecOptions | 
TiffSaver.options
The codec options if set. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
CodecOptions | 
TiffParser.getCodecOptions()
Retrieves the current set of codec options being used to decompress pixel
 data. 
 | 
CodecOptions | 
TiffCompression.getCompressionCodecOptions(IFD ifd)
Creates a set of codec options for compression. 
 | 
CodecOptions | 
TiffCompression.getCompressionCodecOptions(IFD ifd,
                          CodecOptions opt)
Creates a set of codec options for compression. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
byte[] | 
TiffCompression.compress(byte[] input,
        CodecOptions options)
Encodes a strip of data. 
 | 
byte[] | 
TiffCompression.decompress(byte[] input,
          CodecOptions options)
Decodes a strip of data. 
 | 
CodecOptions | 
TiffCompression.getCompressionCodecOptions(IFD ifd,
                          CodecOptions opt)
Creates a set of codec options for compression. 
 | 
void | 
TiffSaver.setCodecOptions(CodecOptions options)
Sets the codec options. 
 | 
void | 
TiffParser.setCodecOptions(CodecOptions codecOptions)
Sets the codec options to be used when decompressing pixel data. 
 | 
Copyright © 2017 Open Microscopy Environment