ConvertInterleave Task

This task converts the interleave of a raster. If the input raster has one band, the output is always band sequential (BSQ).

Example

; Start the application

e = ENVI(/HEADLESS)

; Open an input file

File = Filepath('qb_boulder_msi', Subdir=['data'], $

Root_Dir=e.Root_Dir)

Raster = e.OpenRaster(File)

; Get the task from the catalog of ENVITasks

Task = ENVITask('ConvertInterleave')

; Define inputs

Task.INPUT_RASTER = Raster

Task.INTERLEAVE = 'BIP'

; Run the task

Task.Execute

; Get the collection of data objects currently available in the Data Manager

DataColl = e.Data

; Add the output to the Data Manager

DataColl.Add, Task.OUTPUT_RASTER

; Compare the two rasters' interleave

Print, 'Original interleave: ', Raster.interleave

Print, 'New interleave: ', Task.OUTPUT_RASTER.interleave

Syntax

Result = ENVITask('ConvertInterleave')

Input parameters (Set, Get): INPUT_RASTER, INTERLEAVE, OUTPUT_RASTER_URI

Output parameters (Get only): OUTPUT_RASTER

Parameters marked as "Set" are those that you can set to specific values. You can also retrieve their current values any time. Parameters marked as "Get" are those whose values you can retrieve but not set.

Input Parameters

INPUT_RASTER (required)

Specify a raster whose interleave you want to convert.

INTERLEAVE (required)

Specify a string with the data interleave of the output raster. The options are:

BSQ: Band sequential
BIL: Band-interleaved-by-line
BIP: Band-interleaved-by-pixel

OUTPUT_RASTER_URI (optional)

Specify a string with the fully qualified filename and path of the associated OUTPUT_RASTER.

If you do not specify this parameter, or set it to an exclamation symbol (!), ENVI creates a temporary file.
If you set it to the hash symbol (#), ENVI creates a file in the temporary directory, but this file will not be deleted when ENVI closes.