colorspace

Class PalettizedColorSpaceMapper

java.lang.Object

jj2000.j2k.image.ImgDataAdapter

colorspace.ColorSpaceMapper

colorspace.PalettizedColorSpaceMapper

All Implemented Interfaces:

BlkImgDataSrc, ImgData

public class PalettizedColorSpaceMapper
extends ColorSpaceMapper

This class provides decoding of images with palettized colorspaces. Here each sample in the input is treated as an index into a color palette of triplet sRGB output values.

Version:

1.0

Author:

Bruce A. Kern

See Also:

jj2000.j2k.colorspace.ColorSpace

Nested Class Summary

Nested classes/interfaces inherited from class colorspace.ColorSpaceMapper

ColorSpaceMapper.ComputedComponents

Field Summary

Fields inherited from class colorspace.ColorSpaceMapper

computed, csMap, dataFloat, dataInt, eol, fixedPtBitsArray, inFloat, inInt, maxValueArray, ncomps, OPT_PREFIX, pl, shiftValueArray, src, srcBlk, workDataFloat, workDataInt, workFloat, workInt

Fields inherited from class jj2000.j2k.image.ImgDataAdapter

imgdatasrc, tIdx

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PalettizedColorSpaceMapper(BlkImgDataSrc src, ColorSpace csMap) Ctor which creates an ICCProfile for the image and initializes all data objects (input, working, and output).

Method Summary

Methods

Modifier and Type	Method and Description
static BlkImgDataSrc	createInstance(BlkImgDataSrc src, ColorSpace csMap) Factory method for creating instances of this class.
DataBlk	getCompData(DataBlk out, int c) Returns, in the blk argument, a block of image data containing the specifed rectangular area, in the specified component.
int	getCompImgHeight(int c) Returns the number of bits, referred to as the "range bits", corresponding to the nominal range of the image data in the specified component.
int	getCompImgWidth(int c) Returns the width in pixels of the specified component in the overall image.
int	getCompSubsX(int c) Returns the component subsampling factor in the horizontal direction, for the specified component.
int	getCompSubsY(int c) Returns the component subsampling factor in the vertical direction, for the specified component.
int	getCompULX(int c) Returns the horizontal coordinate of the upper-left corner of the specified component in the current tile.
int	getCompULY(int c) Returns the vertical coordinate of the upper-left corner of the specified component in the current tile.
DataBlk	getInternCompData(DataBlk out, int c) Returns, in the blk argument, a block of image data containing the specifed rectangular area, in the specified component.
int	getNomRangeBits(int c) Returns the number of bits, referred to as the "range bits", corresponding to the nominal range of the image data in the specified component.
int	getNumComps() Returns the number of components in the image.
int	getTileCompHeight(int t, int c) Returns the height in pixels of the specified tile-component.
int	getTileCompWidth(int t, int c) Returns the width in pixels of the specified tile-component
String	toString() Return a suitable String representation of the class instance, e.g.

Methods inherited from class colorspace.ColorSpaceMapper

copyGeometry, getFixedPoint, getParameterInfo, setInternalBuffer

Methods inherited from class jj2000.j2k.image.ImgDataAdapter

getImgHeight, getImgULX, getImgULY, getImgWidth, getNomTileHeight, getNomTileWidth, getNumTiles, getNumTiles, getTile, getTileHeight, getTileIdx, getTilePartULX, getTilePartULY, getTileWidth, nextTile, setTile

Methods inherited from class java.lang.Object

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

Methods inherited from interface jj2000.j2k.image.ImgData

getImgHeight, getImgULX, getImgULY, getImgWidth, getNomTileHeight, getNomTileWidth, getNumTiles, getNumTiles, getTile, getTileHeight, getTileIdx, getTilePartULX, getTilePartULY, getTileWidth, nextTile, setTile

Constructor Detail

PalettizedColorSpaceMapper

protected PalettizedColorSpaceMapper(BlkImgDataSrc src,
                          ColorSpace csMap)
                              throws ColorSpaceException

Ctor which creates an ICCProfile for the image and initializes all data objects (input, working, and output).

Parameters:

src - -- Source of image data

csm - -- provides colorspace info

Throws:

ColorSpaceException

Method Detail

createInstance

public static BlkImgDataSrc createInstance(BlkImgDataSrc src,
                           ColorSpace csMap)
                                    throws ColorSpaceException

Factory method for creating instances of this class.

Parameters:

src - -- source of image data

csMap - -- provides colorspace info

Returns:

PalettizedColorSpaceMapper instance

Throws:

ColorSpaceException

getCompData

public DataBlk getCompData(DataBlk out,
                  int c)

Returns, in the blk argument, a block of image data containing the specifed rectangular area, in the specified component. The data is returned, as a copy of the internal data, therefore the returned data can be modified "in place".

The rectangular area to return is specified by the 'ulx', 'uly', 'w' and 'h' members of the 'blk' argument, relative to the current tile. These members are not modified by this method. The 'offset' of the returned data is 0, and the 'scanw' is the same as the block's width. See the 'DataBlk' class.

If the data array in 'blk' is 'null', then a new one is created. If the data array is not 'null' then it is reused, and it must be large enough to contain the block's data. Otherwise an 'ArrayStoreException' or an 'IndexOutOfBoundsException' is thrown by the Java system.

The returned data has its 'progressive' attribute set to that of the input data.

Specified by:

getCompData in interface BlkImgDataSrc

Overrides:

getCompData in class ColorSpaceMapper

Parameters:

blk - Its coordinates and dimensions specify the area to return. If it contains a non-null data array, then it must have the correct dimensions. If it contains a null data array a new one is created. The fields in this object are modified to return the data.

c - The index of the component from which to get the data. Only 0 and 3 are valid.

Returns:

The requested DataBlk

See Also:

getInternCompData(jj2000.j2k.image.DataBlk, int)

toString

public String toString()

Return a suitable String representation of the class instance, e.g.

[PalettizedColorSpaceMapper ncomps= 3, scomp= 1, nentries= 1024 column=0, 7 bit signed entry column=1, 7 bit unsigned entry column=2, 7 bit signed entry]

Overrides:

toString in class Object

getInternCompData

public DataBlk getInternCompData(DataBlk out,
                        int c)

Returns, in the blk argument, a block of image data containing the specifed rectangular area, in the specified component. The data is returned, as a reference to the internal data, if any, instead of as a copy, therefore the returned data should not be modified.

The rectangular area to return is specified by the 'ulx', 'uly', 'w' and 'h' members of the 'blk' argument, relative to the current tile. These members are not modified by this method. The 'offset' and 'scanw' of the returned data can be arbitrary. See the 'DataBlk' class.

This method, in general, is more efficient than the 'getCompData()' method since it may not copy the data. However if the array of returned data is to be modified by the caller then the other method is probably preferable.

If possible, the data in the returned 'DataBlk' should be the internal data itself, instead of a copy, in order to increase the data transfer efficiency. However, this depends on the particular implementation (it may be more convenient to just return a copy of the data). This is the reason why the returned data should not be modified.

If the data array in blk is null, then a new one is created if necessary. The implementation of this interface may choose to return the same array or a new one, depending on what is more efficient. Therefore, the data array in blk prior to the method call should not be considered to contain the returned data, a new array may have been created. Instead, get the array from blk after the method has returned.

The returned data may have its 'progressive' attribute set. In this case the returned data is only an approximation of the "final" data.

Specified by:

getInternCompData in interface BlkImgDataSrc

Overrides:

getInternCompData in class ColorSpaceMapper

Parameters:

blk - Its coordinates and dimensions specify the area to return, relative to the current tile. Some fields in this object are modified to return the data.

c - The index of the component from which to get the data.

Returns:

The requested DataBlk

See Also:

getCompData(jj2000.j2k.image.DataBlk, int)

getNomRangeBits

public int getNomRangeBits(int c)

Returns the number of bits, referred to as the "range bits", corresponding to the nominal range of the image data in the specified component. If this number is n then for unsigned data the nominal range is between 0 and 2^b-1, and for signed data it is between -2^(b-1) and 2^(b-1)-1. In the case of transformed data which is not in the image domain (e.g., wavelet coefficients), this method returns the "range bits" of the image data that generated the coefficients.

Specified by:

getNomRangeBits in interface ImgData

Overrides:

getNomRangeBits in class ImgDataAdapter

Parameters:

c - The index of the component.

Returns:

The number of bits corresponding to the nominal range of the image data (in the image domain).

getNumComps

public int getNumComps()

Returns the number of components in the image.

Specified by:

getNumComps in interface ImgData

Overrides:

getNumComps in class ImgDataAdapter

Returns:

The number of components in the image.

getCompSubsX

public int getCompSubsX(int c)

Returns the component subsampling factor in the horizontal direction, for the specified component. This is, approximately, the ratio of dimensions between the reference grid and the component itself, see the 'ImgData' interface desription for details.

Specified by:

getCompSubsX in interface ImgData

Overrides:

getCompSubsX in class ImgDataAdapter

Parameters:

c - The index of the component (between 0 and N-1)

Returns:

The horizontal subsampling factor of component 'c'

See Also:

ImgData

getCompSubsY

public int getCompSubsY(int c)

Returns the component subsampling factor in the vertical direction, for the specified component. This is, approximately, the ratio of dimensions between the reference grid and the component itself, see the 'ImgData' interface desription for details.

Specified by:

getCompSubsY in interface ImgData

Overrides:

getCompSubsY in class ImgDataAdapter

Parameters:

c - The index of the component (between 0 and N-1)

Returns:

The vertical subsampling factor of component 'c'

See Also:

ImgData

getTileCompWidth

public int getTileCompWidth(int t,
                   int c)

Returns the width in pixels of the specified tile-component

Specified by:

getTileCompWidth in interface ImgData

Overrides:

getTileCompWidth in class ImgDataAdapter

Parameters:

t - Tile index

c - The index of the component, from 0 to N-1.

Returns:

The width in pixels of component c in tilet.

getTileCompHeight

public int getTileCompHeight(int t,
                    int c)

Returns the height in pixels of the specified tile-component.

Specified by:

getTileCompHeight in interface ImgData

Overrides:

getTileCompHeight in class ImgDataAdapter

Parameters:

t - The tile index.

c - The index of the component, from 0 to N-1.

Returns:

The height in pixels of component c in tile t.

getCompImgWidth

public int getCompImgWidth(int c)

Returns the width in pixels of the specified component in the overall image.

Specified by:

getCompImgWidth in interface ImgData

Overrides:

getCompImgWidth in class ImgDataAdapter

Parameters:

c - The index of the component, from 0 to N-1.

Returns:

The width in pixels of component c in the overall image.

getCompImgHeight

public int getCompImgHeight(int c)

Returns the number of bits, referred to as the "range bits", corresponding to the nominal range of the image data in the specified component. If this number is n then for unsigned data the nominal range is between 0 and 2^b-1, and for signed data it is between -2^(b-1) and 2^(b-1)-1. In the case of transformed data which is not in the image domain (e.g., wavelet coefficients), this method returns the "range bits" of the image data that generated the coefficients.

Specified by:

getCompImgHeight in interface ImgData

Overrides:

getCompImgHeight in class ImgDataAdapter

Parameters:

c - The index of the component.

Returns:

The number of bits corresponding to the nominal range of the image data (in the image domain).

getCompULX

public int getCompULX(int c)

Returns the horizontal coordinate of the upper-left corner of the specified component in the current tile.

Specified by:

getCompULX in interface ImgData

Overrides:

getCompULX in class ImgDataAdapter

Parameters:

c - The index of the component.

getCompULY

public int getCompULY(int c)

Returns the vertical coordinate of the upper-left corner of the specified component in the current tile.

Specified by:

getCompULY in interface ImgData

Overrides:

getCompULY in class ImgDataAdapter

Parameters:

c - The index of the component.