TIFFFaxDecompressor (SCIFIO Javadocs 0-SNAPSHOT API)

java.lang.Object
- io.scif.media.imageio.plugins.tiff.TIFFDecompressor
- - io.scif.media.imageioimpl.plugins.tiff.TIFFFaxDecompressor

public class TIFFFaxDecompressor
extends TIFFDecompressor

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`compression`
`protected int`	`fillBits` EOL padding flag: 1 if fill bits have been added before an EOL such that the EOL ends on a byte boundary, 0 otherwise.
`protected int`	`fillOrder` The logical order of bits within a byte.
`protected int`	`oneD` Coding dimensionality: 1 for 2-dimensional, 0 for 1-dimensional.
`protected int`	`uncompressedMode` Uncompressed mode flag: 1 if uncompressed, 0 if not.

Fields inherited from class io.scif.media.imageio.plugins.tiff.TIFFDecompressor
activeSrcHeight, activeSrcMinX, activeSrcMinY, activeSrcWidth, bitsPerSample, byteCount, colorConverter, colorMap, destinationBands, dstHeight, dstMinX, dstMinY, dstWidth, dstXOffset, dstYOffset, extraSamples, image, metadata, offset, photometricInterpretation, planar, rawImage, reader, sampleFormat, samplesPerPixel, sourceBands, sourceXOffset, sourceYOffset, srcHeight, srcMinX, srcMinY, srcWidth, stream, subsampleX, subsampleY

Constructor Summary

Constructors
Constructor and Description

TIFFFaxDecompressor()

Constructors
Constructor and Description
`TIFFFaxDecompressor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`beginDecoding()` Invokes the superclass method and then sets instance variables on the basis of the metadata set on this decompressor.
`void`	`decodeNextScanline(int lineIndex)`
`void`	`decodeRaw(byte[] b, int dstOffset, int pixelBitStride, int scanlineStride)` Decodes the source data into the provided `byte` array `b`, starting at the offset given by `dstOffset`.
`void`	`decodeRLE()`
`void`	`decodeT4()`
`void`	`decodeT6()`

Methods inherited from class io.scif.media.imageio.plugins.tiff.TIFFDecompressor
createRawImage, decode, decodeRaw, decodeRaw, decodeRaw, getRawImageType, getRawImageTypeSpecifier, setActiveSrcHeight, setActiveSrcMinX, setActiveSrcMinY, setActiveSrcWidth, setBitsPerSample, setByteCount, setColorConverter, setColorMap, setCompression, setDestinationBands, setDstHeight, setDstMinX, setDstMinY, setDstWidth, setDstXOffset, setDstYOffset, setExtraSamples, setImage, setMetadata, setOffset, setPhotometricInterpretation, setPlanar, setReader, setSampleFormat, setSamplesPerPixel, setSourceBands, setSourceXOffset, setSourceYOffset, setSrcHeight, setSrcMinX, setSrcMinY, setSrcWidth, setStream, setSubsampleX, setSubsampleY

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - fillOrder
```
protected int fillOrder
```
    The logical order of bits within a byte.
```
 1 = MSB-to-LSB
 2 = LSB-to-MSB (flipped)
 
```
  - compression
```
protected int compression
```
  - uncompressedMode
```
protected int uncompressedMode
```
    Uncompressed mode flag: 1 if uncompressed, 0 if not.
  - fillBits
```
protected int fillBits
```
    EOL padding flag: 1 if fill bits have been added before an EOL such that the EOL ends on a byte boundary, 0 otherwise.
  - oneD
```
protected int oneD
```
    Coding dimensionality: 1 for 2-dimensional, 0 for 1-dimensional.
- Constructor Detail
  - TIFFFaxDecompressor
```
public TIFFFaxDecompressor()
```
- Method Detail
  - beginDecoding
```
public void beginDecoding()
```
    Invokes the superclass method and then sets instance variables on the basis of the metadata set on this decompressor.
    
    Overrides:
    
    beginDecoding in class TIFFDecompressor
  - decodeRaw
```
public void decodeRaw(byte[] b,
                      int dstOffset,
                      int pixelBitStride,
                      int scanlineStride)
               throws IOException
```
    Description copied from class: TIFFDecompressor
    
    Decodes the source data into the provided byte array b, starting at the offset given by dstOffset. Each pixel occupies bitsPerPixel bits, with no padding between pixels. Scanlines are separated by scanlineStride bytes.
    
    Specified by:
    
    decodeRaw in class TIFFDecompressor
    
    Parameters:
    
    b - a byte array to be written.
    
    dstOffset - the starting offset in b to be written.
    
    pixelBitStride - the number of bits for each pixel.
    
    scanlineStride - the number of bytes to advance between that starting pixels of each scanline.
    
    Throws:
    
    IOException - if an error occurs reading from the source ImageInputStream.
  - decodeRLE
```
public void decodeRLE()
               throws IIOException
```
    Throws:
    
    IIOException
  - decodeNextScanline
```
public void decodeNextScanline(int lineIndex)
                        throws IIOException
```
    Throws:
    
    IIOException
  - decodeT4
```
public void decodeT4()
              throws IIOException
```
    Throws:
    
    IIOException
  - decodeT6
```
public void decodeT6()
              throws IIOException
```
    Throws:
    
    IIOException

Class TIFFFaxDecompressor

Field Summary

Fields inherited from class io.scif.media.imageio.plugins.tiff.TIFFDecompressor

Constructor Summary

Method Summary

Methods inherited from class io.scif.media.imageio.plugins.tiff.TIFFDecompressor

Methods inherited from class java.lang.Object

Field Detail

fillOrder

compression

uncompressedMode

fillBits

oneD

Constructor Detail

TIFFFaxDecompressor

Method Detail

beginDecoding

decodeRaw

decodeRLE

decodeNextScanline

decodeT4

decodeT6