This routine is obsolete and has been replaced with the CreateTileIterator method to ENVIRaster.

This function is used to initialize processing of tile data. The returned value is the tile ID used to access the data.

Note: You must run ENVI_INIT_TILE before requesting tiled data.

Syntax

Result = ENVI_INIT_TILE(FID, POS [, /COMPLEX] [, INTERLEAVE={0 | 1 | 2}] [, MATCH_ID=value] [, NUM_TILES=variable] [, OVERLAP=value] [, TILE_SCALE=integer] [, XE=value] [, XS=value] [, YE=value] [, YS=value])

Arguments

FID

This is the file ID of the file to process.

POS

This is the array of band positions to process.

Keywords

COMPLEX (optional)

Set this keyword to return the output data type as complex.

INTERLEAVE (optional)

Set this keyword to one of the following integer values to specify the interleave output. The default is to perform the same type of interleave as the file.

  • 0: BSQ
  • 1: BIL
  • 2: BIP

MATCH_ID (optional)

Set this keyword equal to the tile ID of a previously initialized piece of tile data to match the tile size of the current data to the size of the previously initialized data. MATCH_ID acquires the same spatial tile from multiple bands or images so that processing is done on the same area in each case. Do not use this keyword in combination with the XE, XS, YE, and YS keywords.

NUM_TILES (optional)

Use this keyword to specify a named variable that contains the number of tiles in the request.

OVERLAP (optional)

Use this keyword to specify the pixel overlap wanted for each spatial tile. Use OVERLAP only when INTERLEAVE=0.

TILE_SCALE (optional)

Use this keyword to adjust the size (in bytes) of the default spatial tile size in ENVI Classic. A value of 2 causes the tile to be half as large. A value of 4 causes the tile to be a quarter as large. This keyword overrides the Image Tile Size preference in ENVI.

XE (optional)

Use this keyword to specify the x ending index. The default is the last sample.

XS (optional)

Use this keyword to specify the x starting index. The default is the first sample.

YE (optional)

Use this keyword to specify the y ending index. The default is the last line.

YS (optional)

Use this keyword to specify the y starting index. The default is the first line.