ENVIBoundingBoxSet::AddBoundingBox

The AddBoundingBox method adds a bounding box to an ENVIBoundingBoxSet.

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

Example

See the example for ENVIBoundingBox.

Syntax

ENVIBoundingBoxSet.AddBoundingBox, Keywords=value

Arguments

None

Keywords

BOUNDING_BOX (required)

Set this keyword to a [2,5] array with bounding box information to add. The values represent X/Y pixel coordinates. The first and last entry should be the same. The array should be in this format:

[[Upper Left XY], [Upper Right XY], [Lower Right XY], [Lower Left XY], [Upper Left XY]]

Example:

  BOUNDING_BOX = [[755, 283], [768, 283], [768, 739], [755, 739], [755, 283]]

CLASS (required)

Set this keyword to an integer with the class value with which to add a bounding box.

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

SPATIALREF (optional)

Set this keyword to an ENVIStandardSpatialRef, ENVIRPCRasterSpatialRef, ENVIGLTRasterSpatialRef, or ENVIPseudoRasterSpatialRef object if the bounding box was derived from a source raster that has a spatial reference. Set this keyword to that spatial reference. ENVI will internally convert the bounding box coordinates to pixel coordinates. If you do not specify this keyword, no projection conversion will happen, and pixel coordinates will be assumed for the bounding boxes.

Version History

1.2	Introduced