IDLffJPEG2000::GetTileProperty

The IDLffJPEG2000::GetTileProperty procedure method returns information describing the properties of a tile in an IDLffJPEG2000 object in the supplied variable-keyword pairs. The object must be open for reading. An error is produced if the object is open for writing.

Syntax

Obj->[IDLffJPEG2000::]GetTileProperty [, TileIndex [, TileComponent]], [, N_LAYERS=variable] [, N_LEVELS=variable] [, PROGRESSION=variable] [, REVERSIBLE=variable] [, TILE_DIMENSIONS=variable] [, TILE_OFFSET=variable] [, YCC=variable]

Arguments

TileIndex

This argument specifies the index of the tile whose attributes are to be returned. JPEG2000 tiles are numbered in raster scan fashion, starting from 0 and going up to a maximum of 65535. The default value for this argument is 0.

TileComponent

This argument specifies the component index of the tile whose attributes are to be queried. Indices range from 0 to N_COMPONENTS-1. The default value for this argument is 0.

Keywords

N_LAYERS

Set this keyword to a named variable in which to return the number of quality layers available for the tile. If this keyword is set, the TileComponent argument is ignored.

N_LEVELS

Set this keyword to a named variable in which to return the total number of available resolution levels for this tile component.

PROGRESSION

Set this keyword to a named variable in which to return a string containing the progression order for that tile. The returned value will be one of: LRCP, RLCP, RPCL, PCRL, CPRL.

See PROGRESSION under Properties for the definition of these values.

REVERSIBLE

Set this keyword to a named variable in which to return 1 if the tile-component is compressed reversibly, 0 if irreversible.

TILE_DIMENSIONS

Set this keyword to a named variable in which to return a two-element vector containing the width and height of the tile, taking into account any clipping of the tile to the image.

TILE_OFFSET

Set this keyword to a named variable in which to return a two-element vector containing the horizontal and vertical offset of the tile, taking into account any clipping of the tile to the image.

YCC

Set this keyword to a named variable in which to return 1 if a component color transform was used for the first 3 components of the tile specified by the TileIndex argument, 0 otherwise.

Version History

6.1	Introduced