Routines (alphabetical) > Object Classes > Network Object Classes > IDLnetJPIP Properties

# IDLnetJPIP Properties

IDLnetJPIP objects have the following properties.

Note: For a discussion of the property description tables shown below, see About Object Property Descriptions.

- BIT_DEPTH
- CACHE_DIRECTORY
- COLOR_SPACE
- DIMENSIONS
- FILENAME
- GML
- IS_ALIVE
- N_COMPONENTS
- N_LAYERS
- N_LEVELS
- N_TILES
- PROGRESSION
- PROGRESSIVE_CALLBACK_DATA
- PROGRESSIVE_CALLBACK_FUNCTION
- PROGRESSSIVE_UPDATES_COMPLETE
- PROXY_NAME
- PROXY_PORT
- REVERSIBLE
- SERVER_NAME
- SERVER_PORT
- SERVER_SCHEME
- SIGNED
- STATUS_CALLBACK_DATA
- STATUS_CALLBACK_FUNCTION
- TILE_DIMENSIONS
- TILE_RANGE
- UUIDS
- XML
- YCC

### BIT_DEPTH

Read Only. Contains the bit depth for each image component. Call the Open method before accessing this property or IDL will throw an error.

Type | Integer vector
Default | N/A
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

### CACHE_DIRECTORY

This property sets a local cache directory and defaults to a null string. A cache directory is not used unless this property is set by the user during the OBJ_NEW call. This cache directory will hold wavelets for the portions of images that have been streamed in from the remote server. If the user goes back to the same portion of the image, the wavelet cache will be used instead requesting the same wavelets from the remote server. An application can obtain a path to a temporary directory by using the FILEPATH function. If CACHE_DIRECTORY is set, we recommend that all of the files the cache directory be deleted periodically (such as each time the application is started) to avoid filling up the disk with cache files. You can only set this property during the OBJ_NEW call.

Type | String
Default | null string
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

### COLOR_SPACE

Read Only. This property has the following values:

sLUM | A luminance (monochrome) space.
sRGB | The sRGB space is a reasonably good model for color imagery which has been corrected to look good on a monitor.
sYCC | A three-component color space derived by applying the standard YCbCr color transform to sRGB data.
iccLUM |
iccRGB |
unKnown |

Call the Open method before accessing this property or IDL will throw an error.

Type | String
Default | N/A
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

### DIMENSIONS

Read Only. A two element array giving the dimensions `[width, height]` of the entire image.

Call the Open method before accessing this property or IDL will throw an error.

Type | Long
Default | N/A
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

### FILENAME

Read Only. A string containing the path and name of the file associated with the image being streamed from the remote server. The path is relative to the root directory used by the server. IDL sets this property when the ::Open method is called.

Call the Open method before accessing this property or IDL will throw an error.

Type | String
Default | N/A
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

### GML

Read Only. A string vector in which each string contains the contents of a single ASOC/GML box. A JPEG2000 file can contain 0 to n number of ASOC/GML boxes. If the JPEG2000 file does not have any ASOC/GML boxes, this property returns a null string.

Call the Open method before accessing this property or IDL will throw an error.

The XML box under ASOC box with a label of “gml.root-instance” is returned.

asoc

|----lbl = gml.data

|----asoc

|----lbl = gml.root-instance

|----xml = “gml_data_string” <----------- this gml string is returned

Type | String
Default | See description above
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

### IS_ALIVE

Read Only. Use IS_ALIVE to determine if a connection to a JPIP server has timed out. Prior to calling the Open method, this property will always return 0. After calling Open, this property will return 1 while the connection to the JPIP server is alive and will return 0 when the connection to the JPIP server has timed out.

If this property returns 0 then it necessary to call the Open method again to reestablish the connection to the server.

Type | Long
Default | N/A
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

### N_COMPONENTS

Read Only. The number of components (or bands or channels) in the image.

Call the Open method before accessing this property or IDL will throw an error.

Type | Long
Default | N/A
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

### N_LAYERS

Read Only. Indicates the number of quality layers used to build each image. When an image has more than one layer, the previous layers are used to build the image at the requested layer value. If the REVERSIBLE property is "true" then the last layer, in conjunction with the previous layers (if there are any), will produce a lossless image.

Call the Open method before accessing this property or IDL will throw an error.

Type | Long
Default | N/A
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

### N_LEVELS

Read Only. Represents the number of wavelet decomposition levels or stages.

Call the Open method before accessing this property or IDL will throw an error.

Type | Long
Default | N/A
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

### N_TILES

Read Only. Indicates the number of tiles in a component.

Call the Open method before accessing this property or IDL will throw an error.

Type | Long
Default | N/A
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

### PROGRESSION

A read-only string defining the progression order. When reading a file, this property indicates the progression order used when the file was created.

For example, "LRCP" means that the image was encoded in the following order, with quality being the outermost loop:

L - a series of one or more quality layers, each contributing a quality increment for the entire image at full resolution. The quality layers may be interpreted as sub-bitplanes containing the image data at a specified, possibly fractional, bit-rate.

R - each resolution level of a image, which corresponds to the N_LEVELS keyword used in encoding, and can be considered to contain the image data at a given size or resolution. Each level adds another level of detail to the previous levels.

C - each image component of the above.

P - each position (tile) within the image component.

In this example, if an image consists of 2 quality layers, 5 resolution levels, 3 components, and 16 positions or tiles, the image would be encoded in a series of packets as follows:

P0C0R0L0, P1C0R0L0, P2C0R0L0, ..., P15C0R0L0

P0C1R0L0, P1C1R0L0, P2C1R0L0, ..., P15C1R0L0

P0C2R0L0, P1C2R0L0, P2C2R0L0, ..., P15C2R0L0

P0C0R1L0, P1C0R1L0, P2C0R1L0, ..., P15C0R1L0

P0C1R1L0, P1C1R1L0, P2C1R1L0, ..., P15C1R1L0

P0C2R1L0, P1C2R1L0, P2C2R1L0, ..., P15C2R1L0

... ... ...

... ... ...

... ... ...

P0C2R4L0, P1C2R4L0, P2C2R4L0, ..., P15C2R4L0

P0C0R0L1, P1C0R0L1, P2C0R0L1, ..., P15C0R0L1

P0C1R0L1, P1C1R0L1, P2C1R0L1, ..., P15C1R0L1

P0C2R0L1, P1C2R0L1, P2C2R0L1, ..., P15C2R0L1

This encodes all components over the entire image at a given quality level, before sending the next quality refinement.

Call the Open method before accessing this property or IDL will throw an error.

Type | String
Default | N/A
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

### PROGRESSIVE_CALLBACK_DATA

This property contains data to pass to the caller when a progressive callback is made. The caller sets and defines the data contained in this variable. The variable is passed, unmodified, directly to the caller as a parameter in the callback function.

If this property is not set the GetData method will pass an IDL variable of the Int type set to zero.

Type | Any IDL variable
Default | Integer set to 0
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### PROGRESSIVE_CALLBACK_FUNCTION

Set to the name of the PRO code function to be called when the ::GetData method is retrieving image data from the remote server. The callback can be used to provide progressive image updates to the user, and to provide a way to cancel an operation underway.

If this property is not set, the GetData method will not make a progressive callback to the PRO code caller.

Type | String
Default | '' (null string)
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### PROGRESSIVE_UPDATES_COMPLETE

Read only. Use in a Progressive Callback Function to determine if all the progressive callbacks have completed. This property is only valid when the GetData method has been called in the asynchronous mode. When this property is 1 during a GetData call, then all of the progressive updates have been completed. When this property is 0 during a GetData call, then more progressive updates will be issued before the GetData call completes.

Type | String
Default | N/A
Name String | not displayed
Get: Yes | Set: No | Init: No | Registered: No

### PROXY_NAME

Set to the hostname or IP address of the proxy server, if one is used.

Type | String
Default | '' (null string)
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### PROXY_PORT

Set to the port number to be used on the proxy server (if used).

Type | Long
Default | 8088
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### REVERSIBLE

Read Only. When reading a file and this property is 0, the images are irreversible (lossy). When reading a file and this property is 1, the images are reversible (lossless).

Call the Open method before accessing this property or IDL will throw an error.

Type | Boolean
Default | N/A
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

### SERVER_NAME

Set to the hostname or IP address of the JPIP server. You must set SERVER_NAME prior to calling the Open method or IDL throws an error.

Type | String
Default | ''
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### SERVER_PORT

Set to the port number used by the remote JPIP server. This property defaults to 80.

Type | Long
Default | 80
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### SERVER_SCHEME

Set to: `http`, `http-tcp`, or `none`, and defaults to `http`. This property is the protocol used by the remote JPIP server when communicating with a client.

Type | STRING
Default | http
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### SIGNED

Read Only. An n-element boolean vector where n is the number of components. A value of 1 indicates pixels in that component are interpreted as signed numbers, otherwise the pixels are interpreted as unsigned numbers.

Call the Open method before accessing this property or IDL will throw an error.

Type | Boolean
Default | N/A
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

### STATUS_CALLBACK_DATA

Contains data that to pass to the caller when a status callback is made. The caller defines and sets the data contained in this variable. The variable is passed, unmodified, directly to the caller as a parameter in the callback function. If this property is not set, the GetData method will pass an IDL variable of the Int type set to zero.

Type | Any IDL variable
Default | Integer set to 0
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### STATUS_CALLBACK_FUNCTION

The name of the PRO code function to call when the GetData method retrieves image data from the remote server. Use the callbacks to provide feedback to the user about the operation underway,and to cancel an operation underway. If this property is not set, the GetData method will not make a callback to the PRO code caller.

Type | String
Default | '' (null string)
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### TILE_DIMENSIONS

Read Only. A 2-element vector defining the width and height of each tile.

Call the Open method before accessing this property or IDL will throw an error.

Type | Long Vector
Default | N/A
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

### TILE_RANGE

Read Only. A two-element integer vector giving the number of tiles in the X and Y directions.

Call the Open method before accessing this property or IDL will throw an error.

Type | Long Vector
Default | N/A
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

### UUIDS

Read Only. Provides a mechanism to retrieve the UUIDs (Universally Unique Identifiers) for the UUID boxes in the JPEG2000 file. Call the Open method before accessing this property or IDL will throw an error.

A JPEG2000 file can contain 0 to n number of UUID boxes. A UUID is a 16 byte value. Each UUID box is made up of a UUID field and a user data field. A UUID box allows the user to store application-specific data inside a JPEG2000 file using a universally unique identifier.

The property returns one of the following:

- a scalar value of 0 when the file does not contain any UUID boxes.
- a vector of byte arrays. Each array contains a 16 byte UUID. A UUID box that exists in the file but does not have any data (the data field is empty) is not included in the returned vector of UUIDs.

For example if the file contains 10 UUID boxes then this property returns a vector with 10 UUIDs. Each UUID is a 16 byte array.

Type | Byte Array Vector
Default | See description above
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

### XML

Read Only. A string vector in which each string contains the contents of a single XML box. A JPEG2000 file can contain 0 to n number of XML boxes. If the JPEG2000 file does not have any XML boxes, this property returns a null string.

Call the Open method before accessing this property or IDL will throw an error.

Type | An array of strings
Default | See description above
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

### YCC

Read Only. YCC refers to RGB to Luminance-Chrominance conversion. This property indicates whether the data was originally converted from the RGB color space to the YCC color space during compression. If YCC=1, GetData will automatically transform the YCC data back to RGB while decompressing it.

Call the Open method before accessing this property or IDL will throw an error.

Type | Boolean
Default | N/A
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

## Version History

8.3 | Introduced