BuildRasterPyramids Task

This task creates pyramid files for rasters. Pyramids are copies of the data at various reduced resolutions, used to speed image display.

Example

; Start the application

e = ENVI()

; 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('BuildRasterPyramids')

; Define inputs

Task.INPUT_RASTER = Raster

; Run the task

Task.Execute

; Verify that the pyramid exists

Print, Raster.PYRAMID_EXISTS

Syntax

Result = ENVITask('BuildRasterPyramids')

Input properties (Set, Get): INPUT_RASTERS, INCLUDE_FULL_RESOLUTION

Output properties (Get only): None

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

Methods

This task inherits the following methods from ENVITask:

Properties

This task inherits the following properties from ENVITask:

COMMUTE_ON_DOWNSAMPLE

INPUT_RASTERS (required)

Specify an array of rasters from which to build the pyramid files.

INCLUDE_FULL_RESOLUTION (optional)

Set this property to have the pyramid include the full-resolution level.

Version History

ENVI 5.6.3

Introduced

API Version

4.2