Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


  >  Docs Center  >  ENVI API  >  ENVI Classic Processing  >  SIRC_POLSIG_DOIT

SIRC_POLSIG_DOIT

SIRC_POLSIG_DOIT

Use this procedure to calculate polarization signatures from a SIR-C compressed data products file.

Syntax


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

Keywords


BANDS

Use this keyword to specify an array of ones and zeros indicating whether the C and L bands were used. A value of 1 indicates the band was used. BANDS must be two elements long, regardless of the size of FNAME.

BFNAME

Use this keyword to specify a string array where each element specifies C and L annotations for the header description. BFNAME must be two elements long, regardless of the size of FNAME.

FNAME

Use this keyword to specify a string array of compressed data products filenames for C and/or L bands, respectively. A phase image will be calculated for each file in FNAME.

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).

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.

OFFSET

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

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.

ROI_ID

Use this keyword to specify an array of ROI IDs returned from a call to ENVI_GET_ROI_IDS. Each ID in the array will use the corresponding ROI to calculate both a co-polarization and cross-polarization image.

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.

  • 0: MLS quad-polarized
  • 1: MLC dual-polarized HH VV
  • 2: MLC dual-polarized HH HV
  • 3: MLC dual-polarized VH VV
  • 4: SLC quad-polarized
  • 5: SLC dual-polarized HH VV
  • 6: SLC dual-polarized HH HV
  • 7: SLC dual-polarized VH VV
  • 8: SLC single-polarized HH
  • 9: SLC single-polarized HH

API Version


3.2



© 2018 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us