ENVIRasterSeries::Set

This method sets the current raster based on its positional index within a raster series. The indices are zero-based.

Example

; Start the application

e = ENVI(/HEADLESS)

 

; Locate a raster series file

seriesFile = Filepath('AirTemp.series', Subdir=['data','time_series'], $

  Root_Dir = e.Root_Dir)

 

; Create a raster series object

series = ENVIRasterSeries(seriesFile)

 

; Print the contents of the series file

PRINT, series

 

; Set the current raster to be the beginning of 31 December (Index #8)

; Indices are zero-based, so set it to 7.

series.Set, 7

 

; Close the series

series.Close

Syntax

ENVIRasterSeries.Set, Index [, ERROR=variable]

Arguments

Index

Specify a zero-based index number (or array of index numbers) of one or more rasters whose data you want to retrieve. If you do not specify this argument, ENVI returns the data for the currently selected raster.

Keywords

ERROR

Set this keyword to a named variable that will contain any error message issued during execution of this routine. If no error occurs, the ERROR variable will be set to a null string (''). If an error occurs and the routine is a function, then the function result will be undefined.

When this keyword is not set and an error occurs, ENVI returns to the caller and execution halts. In this case, the error message is contained within !ERROR_STATE and can be caught using IDL's CATCH routine. See IDL Help for more information on !ERROR_STATE and CATCH.

See Manage Errors for more information on error handling in ENVI programming.

Version History

ENVI 5.2

Introduced

API Version

4.2

See Also

ENVIRasterSeries, ENVIRaster