ENVICatalog

This is a reference to an ENVICatalog object that enables you to access, query, and manipulate an ENVI Catalog.

Instantiating objects of this class requires a separate license for the ENVI Catalog Module; contact your sales representative for more information. However, objects of this class can be instantiated without a license by pointing to the Internal Catalog using the /INTERNAL keyword.

Example

; Start the application

e = ENVI()

; Instantiate ENVI's Internal Catalog

catalog = ENVICatalog(/INTERNAL)

; print the number of entries contained in the catalog.

print, catalog.n_entries

Syntax

Result = ENVICatalog(File [, Properties=value] [, Keywords=value])

Return Value

This routine returns a reference to an ENVICatalog object.

Methods

Arguments

File

The .sqlite database catalog file to open. If this is not set, a new catalog in a temporary folder will be created. If the keyword /INTERNAL is used, this argument is ignored and ENVI's Internal Catalog will be used.

Properties

NAME (Get, Set)

A string representing the name of the catalog.

DESCRIPTION (Get, Set)

A string representing the description of the catalog.

URI (Get)

The location of the catalog file.

THUMBNAILS_URI (Get)

The location of the catalog's thumbnails directory.

N_ENTRIES (Get)

The number of current entries in the catalog.

Keywords

ERROR (optional)

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.

INTERNAL (optional)

If set, the File argument will be ignored and ENVI's Internal Catalog will be used.

Version History

ENVI 6.3

Introduced