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  >  EMITTANCE_CALC_DOIT

EMITTANCE_CALC_DOIT

EMITTANCE_CALC_DOIT

Use this procedure to convert data to emissivity using either reference channel emissivity, emissivity normalization, or alpha residuals. Using the keywords DATA_SCALE and WL_SCALE, you can convert input data and wavelengths on the fly to [W/m2* sr * µm] and µm, respectively. Optionally, you can output a temperature image using the reference channel emissivity or emissivity normalization method.

Syntax


ENVI_DOIT, 'EMITTANCE_CALC_DOIT' [, CONSTANT_BAND=long integer], DATA_SCALE=value, DIMS=array [, EMISSIVITY_VALUE=value], FID=file ID, /IN_MEMORY, METHOD={0 | 1 | 2} [, OUT_BNAME=string array] [, OUT_NAME=string], POS=array [, R_FID=variable] [, /TEMP_IN_MEMORY] [, TEMP_OUT_NAME=string], WL_SCALE=value

Keywords


CONSTANT_BAND (optional)

Use this keyword to specify the band position of the constant band used in the reference channel method only. CONSTANT_BAND is a single long integer ranging from 0 to number of bands minus 1.

DATA_SCALE

Use this keyword to specify the scale factor applied to the data, prior to calculating the emissivity. DATA_SCALE converts the input data to [W/m2* sr * µm].

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

EMISSIVITY_VALUE (optional)

Use this keyword to specify the assumed emissivity value. EMISSIVITY_VALUE is only used when METHOD=0 or 1.

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

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

METHOD

Set this keyword to one of the following values to specify the algorithm for calculating emissivity.

  • 0: Reference channel
  • 1: Emissivity normalization
  • 2: Alpha residuals

OUT_BNAME (optional)

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

OUT_NAME (optional)

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 (optional)

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.

TEMP_IN_MEMORY (optional)

Set this keyword to specify that output temperature images should be stored in memory.

TEMP_OUT_NAME (optional)

Use this keyword to specify an output filename for the temperature image, which is automatically saved. TEMP_OUT_NAME is only valid when METHOD=0 or 1.

WL_SCALE

Use this keyword to specify the scale factor applied to the wavelengths, prior to calculating the emissivity. WL_SCALE converts the input wavelength to µm.

API Version


3.2



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