ENVIRasterSeries

This is a reference to a raster series object, which is a series of images for spatiotemporal analysis. The raster series does not contain any raster data, only references to the rasters. Here are some additional considerations:

If you export the raster series to a file, it will be in JSON metadata format and will have a .series extension.
To display rasters in the ENVI interface, use the Raster method.
You cannot interactively add or remove rasters from the series. You must create a new series if you need to revise the list of rasters.

Example

This example opens a spatiotemporal series from the ENVI installation path. It then prints the contents of the raster series file.

; 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

; Traverse the rasters in the series

FOREACH raster, series DO BEGIN

  Print, raster

ENDFOREACH

For additional steps in working with the spatiotemporal series, see the code examples for the various methods to ENVIRasterSeries.

Syntax

Result = ENVIRasterSeries([Filename] [, Keywords=value])

Return Value

This function returns a reference to a raster series object. If the associated file is a MIE4NITF file that contains multiple series, this method returns an array of raster series objects.

Arguments

Filename (required)

Specify the path and name of a raster series file (.series) that lists the raster files used for a spatiotemporal series. Use the Build Raster Series tool in the ENVI application, or the BuildRasterSeries or BuildTimeSeries task to create a raster series file.

You can also specify the following file inputs. This routine will open these files as a raster series:

Multi-page TIFF (.tif)
DigitalGlobe/Maxar Analysis Ready Data (.json):

Methods

Properties

Properties marked as (Init) can be set during the initial creation of the object. Properties marked as (Get) can be retrieved. Properties marked as (Set) can be set after initial creation.

AUXILIARY_URI (Get)

This property retrieves a string array containing the URIs for the raster files (including .hdr files) contained in an ENVIRasterSeries.

COUNT (Get)

The number of rasters in the series.

RASTER (Get)

The current raster.

Keywords

DATASET_INDEX (optional)

This keyword applies to file formats with multiple raster series per file, such as MIE4NITF. Specify a zero-based index number that corresponds to a specific raster series dataset that you want to open. For example, DATASET_INDEX=0 will open the first raster series.

Version History

ENVI 5.2	Introduced
ENVI 5.3.1	Added Dehydrate method
ENVI 5.4	Added Hydrate method
ENVI 5.5	Added AUXILIARY_URI property
ENVI 5.6.1	Added support for DigitalGlobe/Maxar ARD file input

API Version

4.2