colorspace
Class EnumeratedColorSpaceMapper

java.lang.Object
  |
  +--jj2000.j2k.image.ImgDataAdapter
        |
        +--colorspace.ColorSpaceMapper
              |
              +--colorspace.EnumeratedColorSpaceMapper

All Implemented Interfaces:

BlkImgDataSrc, ImgData

public class EnumeratedColorSpaceMapper

extends ColorSpaceMapper

This class provides Enumerated ColorSpace API for the jj2000.j2k imaging chain by implementing the BlkImgDataSrc interface, in particular the getCompData and getInternCompData methods.

See Also:

jj2000.j2k.colorspace.ColorSpace

Nested Class Summary

Nested classes 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

protected

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

Method Summary

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.
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.
java.lang.String	toString()

Methods inherited from class colorspace.ColorSpaceMapper

copyGeometry, getFixedPoint, getParameterInfo, setInternalBuffer

Methods inherited from class jj2000.j2k.image.ImgDataAdapter

getCompImgHeight, getCompImgWidth, getCompSubsX, getCompSubsY, getCompULX, getCompULY, getImgHeight, getImgULX, getImgULY, getImgWidth, getNomRangeBits, getNomTileHeight, getNomTileWidth, getNumComps, getNumTiles, getNumTiles, getTile, getTileCompHeight, getTileCompWidth, 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

getCompImgHeight, getCompImgWidth, getCompSubsX, getCompSubsY, getCompULX, getCompULY, getImgHeight, getImgULX, getImgULY, getImgWidth, getNomRangeBits, getNomTileHeight, getNomTileWidth, getNumComps, getNumTiles, getNumTiles, getTile, getTileCompHeight, getTileCompWidth, getTileHeight, getTileIdx, getTilePartULX, getTilePartULY, getTileWidth, nextTile, setTile

Constructor Detail

EnumeratedColorSpaceMapper

protected EnumeratedColorSpaceMapper(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

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:

EnumeratedColorSpaceMapper instance

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:

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)

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:

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

Returns:

The requested DataBlk

See Also:

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object