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

  >  Docs Center  >  ENVI API  >  ENVI Classic Processing  >  SIRC_PHASE_IMAGE_DOIT



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


ENVI_DOIT, 'SIRC_PHASE_IMAGE_DOIT' [, /DEGREE], 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}


DEGREE (optional)

Set this keyword to output the phase images in degrees. The default is radians.


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

  • DIMS[0]: A pointer to an open ROI; use only in cases where ROIs define the spatial subset. Otherwise, set to -1L.
  • DIMS[1]: The starting sample number. The first x pixel is 0.
  • DIMS[2]: The ending sample number
  • DIMS[3]: The starting line number. The first y pixel is 0.
  • DIMS[4]: The ending line number

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


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.


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


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


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


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


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


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.


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.


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.


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


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