ENVIDeepLearningObjectDetectionRaster::WriteMetadata

The WriteMetadata method saves all metadata associated with a raster to a header file (.hdr) on disk. The header file is in the same directory as the data file. If you do not have permission to write the metadata file to that directory, the file is written to an auxiliary location specified by the Auxiliary File Directory preference.

This method does not write the 'read procedures' metadata field to an ENVIRasterMetadata object in custom file readers.

This method is part of ENVI Deep Learning, which requires a separate license and installation.

Example

See the example for ENVIDeepLearningObjectDetectionRaster::Encode. That example shows how to use the WriteMetadata method.

Syntax

ENVIDeepLearningObjectDetectionRaster.WriteMetadata [, ERROR=variable]

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 the Manage Errors topic in ENVI Help for more information on error handling.

Version History

1.2	Introduced