TiledImageCompressionOperation (FITS API)

java.lang.Object
- nom.tam.image.tile.operation.AbstractTiledImageOperation<nom.tam.image.compression.tile.TileCompressionOperation>
- - nom.tam.image.compression.tile.TiledImageCompressionOperation

All Implemented Interfaces:

ITiledImageOperation
```
public class TiledImageCompressionOperation
extends AbstractTiledImageOperation<nom.tam.image.compression.tile.TileCompressionOperation>
```
This class represents a complete tiledImageOperation of tileOperations describing an image ordered from left to right and top down. the tileOperations all have the same geometry only the tileOperations at the right side and the bottom side can have different sizes.

Constructor Summary

Constructors
Constructor and Description

TiledImageCompressionOperation(BinaryTable binaryTable)
create a TiledImageCompressionOperation based on a compressed image data.

Constructors
Constructor and Description
`TiledImageCompressionOperation(BinaryTable binaryTable)` create a TiledImageCompressionOperation based on a compressed image data.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`compress(BinaryTableHDU hdu)`
`ICompressOption`	`compressOptions()`
`java.nio.Buffer`	`decompress()`
`void`	`forceNoLoss(int x, int y, int width, int heigth)`
`protected BinaryTable`	`getBinaryTable()`
`java.nio.ByteBuffer`	`getCompressedWholeArea()`
`ICompressorControl`	`getCompressorControl()`
`ICompressorControl`	`getGzipCompressorControl()`
`protected ImageNullPixelMask`	`getImageNullPixelMask()`
`protected void`	`initializeQuantAlgorithm()`
`TiledImageCompressionOperation`	`prepareUncompressedData(java.nio.Buffer buffer)`
`ImageNullPixelMask`	`preserveNulls(long nullValue, java.lang.String compressionAlgorithm)` preserve null values, where the value representing null is specified as a parameter.
`TiledImageCompressionOperation`	`read(Header header)`
`void`	`readPrimaryHeaders(Header header)`
`TiledImageCompressionOperation`	`setCompressAlgorithm(HeaderCard compressAlgorithmCard)`
`TiledImageCompressionOperation`	`setQuantAlgorithm(HeaderCard quantAlgorithmCard)`

Methods inherited from class nom.tam.image.tile.operation.AbstractTiledImageOperation
areAxesUndefined, areTileAxesUndefined, createTiles, getBaseType, getBufferSize, getImageWidth, getNAxes, getNumberOfTileOperations, getTileAxes, getTileOperation, getTileOperations, setAxes, setBaseType, setTileAxes

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

Constructor Detail
- TiledImageCompressionOperation
```
public TiledImageCompressionOperation(BinaryTable binaryTable)
```
  create a TiledImageCompressionOperation based on a compressed image data.
  
  Parameters:
  
  binaryTable - the compressed image data.

Method Detail

compress

public void compress(BinaryTableHDU hdu)
              throws FitsException

Throws:: FitsException

compressOptions

public ICompressOption compressOptions()

decompress
```
public java.nio.Buffer decompress()
```

forceNoLoss

public void forceNoLoss(int x,
                        int y,
                        int width,
                        int heigth)

getCompressedWholeArea

public java.nio.ByteBuffer getCompressedWholeArea()

getCompressorControl

public ICompressorControl getCompressorControl()

getGzipCompressorControl

public ICompressorControl getGzipCompressorControl()

prepareUncompressedData

public TiledImageCompressionOperation prepareUncompressedData(java.nio.Buffer buffer)
                                                       throws FitsException

Throws:: FitsException

preserveNulls
```
public ImageNullPixelMask preserveNulls(long nullValue,
                                        java.lang.String compressionAlgorithm)
```
preserve null values, where the value representing null is specified as a parameter. This parameter is ignored for floating point values where NaN is used as null value.

Parameters:

nullValue - the value representing null for byte/short and integer pixel values

compressionAlgorithm - compression algorithm to use for the null pixel mask

Returns:

the created null pixel mask

read

public TiledImageCompressionOperation read(Header header)
                                    throws FitsException

Throws:: FitsException

readPrimaryHeaders

public void readPrimaryHeaders(Header header)
                        throws FitsException

Throws:: FitsException

setCompressAlgorithm

public TiledImageCompressionOperation setCompressAlgorithm(HeaderCard compressAlgorithmCard)

setQuantAlgorithm

public TiledImageCompressionOperation setQuantAlgorithm(HeaderCard quantAlgorithmCard)

getBinaryTable

protected BinaryTable getBinaryTable()

getImageNullPixelMask

protected ImageNullPixelMask getImageNullPixelMask()

initializeQuantAlgorithm

protected void initializeQuantAlgorithm()

Class TiledImageCompressionOperation

Constructor Summary

Method Summary

Methods inherited from class nom.tam.image.tile.operation.AbstractTiledImageOperation

Methods inherited from class java.lang.Object

Constructor Detail

TiledImageCompressionOperation

Method Detail

compress

compressOptions

decompress

forceNoLoss

getCompressedWholeArea

getCompressorControl

getGzipCompressorControl

prepareUncompressedData

preserveNulls

read

readPrimaryHeaders

setCompressAlgorithm

setQuantAlgorithm

getBinaryTable

getImageNullPixelMask

initializeQuantAlgorithm