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


TMCAL_DOIT

TMCAL_DOIT

This routine has been replaced by ENVIRadiometricCalibrationTask. Use that routine to calibrate Landsat data to radiance, top-of-atmosphere reflectance, or brightness temperatures.

Syntax


ENVI_DOIT, 'TMCAL_DOIT', BANDS_PRESENT=array, BIAS=value, CAL_TYPE={0 | 1}, DATE=array, DIMS=array, FID=file ID, GAIN=value, /IN_MEMORY, OUT_BNAME=string array, OUT_NAME=string, POS=array, R_FID=variable, SAT={0 | 1 | 2 | 3 | 4 | 5 | 6 | 7}, SUN_ANGLE=floating point, /USE_METADATA

Keywords


BANDS_PRESENT

Use this keyword to specify an array of band numbers to process from a single Landsat input file. To process multiple bands, set BANDS_PRESENT=[POS]. Use the tables below to determine the appropriate array values.

The following pertains to the MSS sensor on Landsat 4-5. For example, set BANDS_PRESENT=[0] to process Band 1 of a MSS file from Landsat 4 or 5.

Bands

1

2

3

4

Array value

0

1

2

3

The following pertains to the MSS sensor on Landsat 1-3:

Bands

4

5

6

7

Array value

0

1

2

3

The following pertains to Landsat TM:

Bands

1

2

3

4

5

6

7

Array value

0

1

2

3

4

5

6

The following pertains to Landsat ETM+:

Bands

1

2

3

4

5

61

62

7

8

Array value

0

1

2

3

4

5

6

7

8

Set BANDS_PRESENT=[5] or BANDS_PRESENT=[6] to process the thermal bands 61 or 62, respectively, of a Landsat ETM+ file.

Set BANDS_PRESENT=[0] to process Landsat-5 TM band 6 thermal data. This band is handled separately in the Available Bands List and has its own file ID (FID). Set CAL_TYPE to 1 to calibrate thermal data to radiance (in Kelvins).

To process the ETM+ panchromatic band, set BANDS_PRESENT=[8].

BIAS

Use this keyword to specify the calibration bias values. BIAS is used with GAIN to convert the data.

CAL_TYPE

Use this keyword to specify the calibration type. Set CAL_TYPE to 0 to indicate radiance, or to 1 to indicate reflectance. Set CAL_TYPE to 1 to calibrate thermal data to brightness temperatures (in Kelvins).

DATE

Use this keyword to specify the calibration numbers to use, depending on the date the data were collected. If you want to compute the Earth-Sun distance while calibrating Landsat data, set the DATE keyword to an array of [mm, dd, yyyy], specifying the acquisition date.

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

FID

The file ID (FID) is a long-integer scalar with a value greater than 0. An invalid FID has a value of -1. The FID is provided as a named variable by any routine used to open or select a file. Often, the FID is returned from the keyword R_FID in the ENVIRasterToFID routine. Files are processed by referring to their FIDs. If you work directly with the file in IDL, the FID is not equivalent to a logical unit number (LUN).

GAIN

Use this keyword to specify the calibration gain values. GAIN is used with BIAS to convert the data.

result = Input * GAIN + BIAS.

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.

POS

Use this keyword to specify an array of band positions, indicating the band numbers on which to perform the operation. This keyword indicates the spectral subset of bands to use in processing. POS is an array of long integers, ranging from 0 to the number of bands minus 1. Specify bands starting with zero (Band 1=0, Band 2=1, etc.) For example, to process only Bands 3 and 4 of a multi-band file, POS=[2, 3].

POS is typically used with individual files. The example code below illustrates the use of POS for a single file with four bands of data:

  pos=[0,1,2,3]
              
envi_doit, 'envi_stats_doit', dims=dims, fid=fid, pos=pos, $
              
comp_flag=3, dmin=dmin, dmax=dmax, mean=mean, stdv=stdv, hist=hist

But what if you need to create an output file consisting of data from different bands, each from different files? Library routines such as CF_DOIT and ENVI_LAYER_STACKING_DOIT can accomplish this, but they use the POS keyword differently. Suppose you have four files, test1, test2, test3, and test4, with corresponding FIDs of fid1, fid2, fid3, and fid4, respectively. In the following example, you want Band 3 from test1 in the first position, Band 2 from test2 in the second position, Band 6 from test3 in the third position, and Band 4 from test4 in the fourth position. The code should be as follows:

  fid_array = [fid1,fid2,fid3,fid4]
              
pos=[2,1,5,3]
              
envi_doit, 'cf_doit', dims=dims, fid=fid_array
              
out_name='test_composite_file'

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.

SAT

Set this keyword to one of the following values to indicate the satellite and sensor:

  • 0: Landsat-7 ETM+
  • 1: Landsat-5 TM
  • 2: Landsat-4 TM
  • 3: Landsat-5 MSS
  • 4: Landsat-4 MSS
  • 5: Landsat-3 MSS
  • 6: Landsat-2 MSS
  • 7: Landsat-1 MSS

SUN_ANGLE

Use this keyword to specify a floating-point value between 0.0 and 180.0, corresponding to the solar elevation angle. This value is used only used for reflectance calibration.

USE_METADATA

Set this keyword to calibrate Landsat GeoTIFF files that are delivered with metadata. You do not need to specify the BANDS_PRESENT, BIAS, DATE, GAIN, SAT, or SUN_ANGLE keywords if you set USE_METADATA. Use the POS keyword to calibrate a spectral subset.



© 2017 Exelis Visual Information Solutions, Inc. |  Legal
My Account    |    Buy    |    Contact Us