SIRC_PED_HEIGHT_DOIT

Use this procedure to calculate pedestal height images from a SIR-C compressed data products file.

Syntax

ENVI_DOIT, 'SIRC_PED_HEIGHT_DOIT', DIMS=array, FNAME=string array, FNS=integer, FNL=integer, /IN_MEMORY, OUT_BNAME=string array, OUT_NAME=string, OFFSET=array, R_FID=variable, SLH=array, TYPE={0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9}

Keywords

DIMS

The “dimensions” keyword is a five-element array of long integers that defines the spatial subset (of a file or array) to use for processing. Nearly every time you specify the keyword FID, you must also specify the spatial subset of the corresponding file (even if the entire file, with no spatial subsetting, is to be processed).

To process an entire file (with no spatial subsetting), define DIMS as shown in the following code example. This example assumes you have already opened a file using ENVI_SELECT or ENVI_PICKFILE:

envi_file_query, fid, dims=dims

FNAME

Use this keyword to specify a string array of compressed data products filenames for C and/or L bands, respectively. If you do not use a file, then set the array element to ''.

FNS

Use this keyword to specify the number of samples per line in the SIR-C image.

FNL

Use this keyword to specify the number of lines in the SIR-C image.

IN_MEMORY

Set this keyword to specify that output should be stored in memory. If you do not set IN_MEMORY, output will be stored on disk and you must specify OUT_NAME (see below).

OFFSET

Use this keyword to specify an array of long integers representing header offsets for each of the files specified by FNAME.

OUT_BNAME

Use this keyword to specify a string array of output band names.

OUT_NAME

Use this keyword to specify a string with the output filename for the resulting data. If you set the keyword IN_MEMORY, you do not need to specify OUT_NAME.

R_FID

ENVI Classic library routines that result in new images also have an R_FID, or “returned FID.” This is simply a named variable containing the file ID to access the processed data. Specifying this keyword saves you the step of opening the new file from disk.

SLH

Use this keyword to specify an array of long integers indicating which files need to strip the line header. A value of 0 indicates that the line header is not present, and a value of 1 indicates that the 12-byte SIR-C line header must be stripped. SLH must have the same number of elements as FNAME.

TYPE

Use this keyword to specify an array of SIR-C data product types for each of the files specified by FNAME.

API Version

4.2