ENVIRPCRasterSpatialRef

This is a reference to an ENVIRPCRasterSpatialRef object, which contain properties that describe a Rational Polynomial Coefficient (RPC) spatial reference associated with an ENVIRaster.

Example

The most common programmatic use for ENVIRPCRasterSpatialRef is retrieving spatial properties from an ENVIRaster that contains an RPC spatial reference. This is stored in the raster's SPATIALREF property. The following code shows a general example:

; Open a raster that contains an RPC spatial reference

File = 'MyRaster.dat'

Raster = e.OpenRaster(File)

; Retrieve and print the properties of the spatial reference

Print, Raster.SPATIALREF

Syntax

Result = ENVIRPCRasterSpatialRef([, Properties=value, ERROR=value])

Methods

ConvertLonLatToLonLat

Properties

Properties marked as (Get) can be retrieved, but not set.

COORD_SYS_CODE (Get)

Use this property to get a geographic (GEOGCS) or projected (PROJCS) coordinate system code.

For a full list of coordinate system strings and codes, refer to the following text files in the \IDLxx\resource\pedata\predefined directory of the ENVI distribution:

EnviPEProjcsStrings.txt: PROJCS codes and strings
EnviPEGeogcsStrings.txt: GEOGCS codes and strings

COORD_SYS_STR (Get)

Use this property to get a geographic (GEOGCS) or projected (PROJCS) coordinate system string.

For a full list of coordinate system strings and codes, refer to the following text files in the \IDLxx\resource\pedata\predefined directory of the ENVI distribution:

EnviPEProjcsStrings.txt: PROJCS codes and strings
EnviPEGeogcsStrings.txt: GEOGCS codes and strings

PIXEL_SIZE (Get)

This is a two-element array [X Pixel Size, Y Pixel Size] specifying the pixel size of the data. The pixel sizes must be in the same units as the coordinate system.

RPC_LINE_DEN_COEFF (Init, Get)

A 20-element, double-precision array of RPC line denominator coefficients.

RPC_LINE_NUM_COEFF (Init, Get)

A 20-element, double-precision array of RPC line numerator coefficients.

RPC_OFFSETS (Init, Get)

A five-element, double-precision array that specifies the Line_Offset, Sample_Offset, Latitude_Offset, Longitude_Offset, and Height_Offset values.

RPC_SAMP_DEN_COEFF (Init, Get)

A 20-element, double-precision array of RPC sample denominator coefficients.

RPC_SAMP_NUM_COEFF (Init, Get)

A 20-element, double-precision array of RPC sample numerator coefficients.

RPC_SCALES (Init, Get)

A five-element, double-precision array that specifies the Line_Scale, Sample_Scale, Latitude_Scale, Longitude_Scale, and Height_Scale.

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.

Version History

ENVI 5.1	Introduced; Added ability to serve as a constructor function for creating new RPC spatial reference objects.
ENVI 5.3.1	Added Dehydrate method
ENVI 5.4	Added Hydrate method
ENVI 5.6.3	Added NorthIsUpAngle and UpIsUpAngle methods.

API Version

4.2