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_SYNTH_DOIT

SIRC_SYNTH_DOIT

SIRC_SYNTH_DOIT

Use this procedure to synthesize images from SIR-C compressed data product files.

Syntax


ENVI_DOIT, 'SIRC_SYNTH_DOIT', COMBO=array, DIMS=array, FNAME=string array, FNL=integer, FNS=integer, /IN_MEMORY [, MAX_VAL=value] [, MIN_VAL=value], OUT_DT={1 | 4}, OUT_NAME=string, OFFSET=array, R_FID=variable, /STDMULT, /SIGMA_ZERO, SLH=array, TOTAL_POWER=array, TYPE={0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9}, XFAC=value, YFAC=value

Keywords


COMBO

Use this keyword to specify a 5 x n array of ellipticity and orientation angles for each image synthesized. The format for the array is:

  • [0, i] - Transmit ellipticity for ith image
  • [1, i] - Transmit orientation for ith image
  • [2, i] - Receive ellipticity for ith image
  • [3, i] - Receive orientation for ith image
  • [4, i] - Stokes band number (0=C, 1=L)

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

  • 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

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

MAX_VAL (optional)

Use this keyword to set a maximum value for output data.

MIN_VAL (optional)

Use this keyword to set a minimum value for output data.

OFFSET

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

OUT_DT

This keyword indicates the IDL data type of the output data. Set the keyword to one of the following integer values:

  • 1: Byte (8 bits)
  • 4: Floating-point (32 bits)

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.

SIGMA_ZERO

Set this keyword to convert the output values to sigma zero, 10*log10(data).

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.

STDMULT

Set this keyword to specify the standard deviation multiplier for byte output data types. Plus and minus the STDMULT determines the output minimum and maximum.

TOTAL_POWER

Use this keyword to specify a three-element array of ones and zeros indicating whether the total power should be computed for the C and/or L bands, respectively. A value of 1 causes the synthesis of the total power image.

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

XFAC

Use this keyword to specify an x subsampling factor used to compute image data statistics prior to the conversion to byte. Only use this keyword when the output data type is byte.

YFAC

Use this keyword to specify a y subsampling factor used to compute image data statistics prior to the conversion to byte. Only use this keyword when the output data type is byte.

API Version


3.2



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