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

HIST_EXPORT_DOIT

HIST_EXPORT_DOIT

Use this procedure to output an image using a supplied LUT. An LUT is a method of changing an input image DN to new output DN. Each input pixel is used to calculate the index into the LUT, and the corresponding value in the LUT becomes the new output value. The index into the LUT is calculated from the input data value, the input data minimum (I_MIN), and the input binsize (I_BINSIZE) by the following formula:

Output value = LUT[(input value - I_MIN) / I_BINSIZE]

Additionally, you can adjust the output DNs by the desired output minimum and maximum, using the keywords O_MIN and O_MAX, respectively.

Syntax


ENVI_DOIT, 'HIST_EXPORT_DOIT', DIMS=array, FID=file ID, I_BINSIZE=value, I_MIN=value [, /IN_MEMORY], LUT=array, O_MAX=value, O_MIN=value [, OUT_BNAME=string array], OUT_DT={0 | 1 | 2 | 3 | 4 | 5 | 6 | 9 | 12 | 13 | 14 | 15}, OUT_NAME=string, POS=array [, R_FID=variable]

Keywords


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

I_BINSIZE

Use this keyword to specify the input bin size, which is the width in DN that a group of input pixels will map to a single output pixel. For integer data, I_BINSIZE must be an integer greater than or equal to 1; for floating point data, I_BINSIZE must be greater than 0.

I_MIN

Use this keyword to specify the input data minimum.

IN_MEMORY (optional)

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

LUT

Use this keyword to specify the lookup table array. The number of elements of LUT is determined by the input data range and the input bin size (I_BINSIZE) using the following formula:

# elements lut = (input data maximum - input data minimum) / I_BINSIZE + 1

O_MAX

Use this keyword to specify the desired output data maximum. O_MAX is a single value with the same data type as OUT_DT.

O_MIN

Use this keyword to specify the desired output data minimum. O_MIN is a single value with the same data type as OUT_DT.

OUT_BNAME (optional)

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

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)
  • 2: Integer (16 bits)
  • 3: Long integer (32 bits)
  • 4: Floating-point (32 bits)
  • 5: Double-precision floating-point (64 bits)
  • 6: Complex (2x32 bits)
  • 9: Double-precision complex (2x64 bits)
  • 12: Unsigned integer (16 bits)
  • 13: Unsigned long integer (32 bits)
  • 14: Long 64-bit integer
  • 15: Unsigned long 64-bit integer

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

API Version


3.2



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