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


  >  Docs Center  >  ENVI API  >  Processing  >  ENVI_SMACC_DOIT

ENVI_SMACC_DOIT

ENVI_SMACC_DOIT

The ENVI_SMACC_DOIT procedure performs Sequential Maximum Angle Convex Cone (SMACC) processing on an input file. This procedure is designed for use with previously calibrated hyperspectral data or multispectral data.

This procedure applies the SMACC process to a radiance- or reflectance-calibrated hyperspectral image, and it returns the following outputs:

  • A spectral library of derived endmembers
  • An abundance image with N_ENDMEMBERS number of bands. This is an optional output.
  • ROIs representing the set of endmembers. This is an optional output.

Example


; Start ENVI
e = ENVI()
 
; Open a data file
File = Filepath('cup95eff.int', Root_Dir = e.Root_Dir, $
   Subdir = ['classic', 'data'])
Raster = e.OpenRaster(File)
 
; Determine an output file
OutFile = e.GetTemporaryFilename()
 
; Return a file ID
fid = ENVIRasterToFID(Raster)
 
; Query the file
ENVI_File_Query, fid, DIMS=dims, NB=nb, WL=wl
 
; Run the SMACC process
ENVI_Doit, 'ENVI_SMACC_Doit', $
   FID = fid, $
   DIMS = dims, $
   POS = Lindgen(nb), $
   N_ENDMEMBERS = 10, $
   OUT_NAME = OutFile

Syntax


ENVI_DOIT, 'ENVI_SMACC_DOIT' [, /ABUND_IN_MEMORY] [, ABUND_NAME=string] [, ABUND_R_FID=variable] [, COALESCE=value] , DIMS=array, FID=file ID, /IN_MEMORY [, M_FID=file ID] [, M_POS=integer], [, METHOD={0 | 1 | 2}], N_ENDMEMBERS=integer, OUT_NAME=string [, PLOT_FLAG=bitwise operator], POS=array, R_FID=variable [, ROI_NAME=string] [, THRESH=value]

Keywords


ABUND_IN_MEMORY (optional)

Set this keyword to generate an abundance image and save it in memory only. If you do not set ABUND_IN_MEMORY and you specify a filename for ABUND_NAME, the abundance image is generated and stored on disk.

ABUND_NAME (optional)

Use this keyword to specify a filename for the abundance image output. If you specify a filename for this keyword, an abundance image is generated and saved to a file with the filename. If you do not use ABUND_NAME and you set ABUND_IN_MEMORY, an abundance image is generated and stored in memory.

ABUND_R_FID (optional)

Set this keyword to a named variable that contains the file ID of the output abundance image. This image is only generated if you specify either the ABUND_IN_MEMORY or ABUND_NAME keywords. If you specify neither keyword, an abundance image is not generated, and a value of –1 is returned for ABUND_R_FID.

COALESCE

Use this keyword to specify the maximum Spectral Angle Mapper (SAM) threshold value above which endmember spectra are considered unique. The default value is 0.0.

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

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

M_FID (optional)

Use this keyword to specify the file ID of the mask file. This value is returned from the keyword R_FID in the ENVI_OPEN_FILE procedure. M_FID is a long integer with a value greater than 0. An invalid file ID has a value of -1.

M_POS (optional)

Use this keyword to specify the band position of the mask band. M_POS is a long integer with a value greater than or equal to 0.

METHOD

Use this keyword to specify an integer value that indicates the unmixing constraint for the SMACC method. The following list shows the integer values that represent each possible constraint and their related conditions.

  • 0: Positivity only (default). Inputs should be calibrated to reflectance.
  • 1: Sum to unity or less. Inputs should be calibrated to reflectance.
  • 2: Sum to unity. Inputs should be calibrated to radiance or thermal IR emissivity.

All of these options also impose a positivity constraint. In the unmixing model, negative fractional abundances are not allowed and are set to 0.

If you specify METHOD=0 or 1, the SMACC method begins with an endmember value of 1.0 (total reflectance). If you specify METHOD=2, the SMACC method begins with an endmember value of 0.0 (zero radiance). Regardless, both of these endmembers are presumed to lie at an extreme point (or even outside) of a plausible convex hull. This point becomes a reasonable baseline for the SMACC method.

N_ENDMEMBERS

Use this keyword to specify the maximum number of desired endmembers.

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.

PLOT_FLAG (optional)

Use this keyword to specify an integer value that determines which resulting plot window is provided.

  • 0: The endmember and residual error plots are not displayed (default).
  • 1: The endmember plot is displayed.
  • 2: The residual error plot is displayed.
  • 3: Both plot windows are displayed.

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.

ROI_NAME (optional)

Use this keyword to generate ROIs and to specify the name of the file that contains these ROIs. The generated ROIs contain the endmember pixels. If you do not set this keyword, the ROIs are not generated.

THRESH (optional)

Use this keyword to specify the residual RMS error threshold at which the SMACC process is terminated.

Note: Data units should be considered when choosing the tolerance. For example, RMS errors for reflectance units should be lower than for radiance units.

API Version


3.2



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