This routine is obsolete and has been replaced by the following tasks: DirectionalFilter, DirectionalKernel, GaussianHighPassFilter, GaussianHighPassKernel, HighPassFilter, HighPassKernel, LaplacianFilter, LaplacianKernel, LowPassFilter, LowPassKernel, MedianFilter, RobertsFilter, RasterConvolution, and SobelFilter.

Use this procedure to perform convolution filtering, including high pass, low pass, laplacian, Gaussian, median, directional, Sobel, Roberts, and user-defined. For METHOD=1 and METHOD=2, the data type is automatically set to integer. For the remaining methods, the data type is converted as follows. Values in parentheses refer to the IDL convention for data types.

  • Input byte (1) converts to integer (2)
  • Input unsigned integer (12) converts to integer (2)
  • Input unsigned long (13) converts to long (3)

Syntax

ENVI_DOIT, 'CONV_DOIT', ADD_BACK=floating point{0.0 to 1.0} [, DIMS=array], FID=file ID, /IN_MEMORY [, KERNEL=value] [, KX=value] [, KY=value], METHOD={0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8}, OUT_BNAME=string array, OUT_NAME=string [, POS=array], R_FID=variable

Keywords

ADD_BACK

Set this keyword equal to a floating-point or double-precision value between 0.0 and 1.0, specifying the filter add-back percentage. A value of 1.0 is equal to 100%.

DIMS (optional)

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

If this keyword is not defined, full convolution will be performed on the image.

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

KERNEL (optional)

Use this keyword to specify a user-defined kernel, when METHOD=9.

  • If this keyword is defined, KX and KY are ignored.
  • If this keyword is not defined and KX and KY are specified, a default kernel will be created based on the specified METHOD.
  • If this keyword is not defined and KX is specified but KY is not, a square kernel will be created, where KY=KX.

KX (optional)

Use this keyword to specify the x kernel size. For METHOD=0, 1, 2, and 3, KX must be equal to KY. For METHOD=0 and 1, KX must be set equal to 3.

KY (optional)

Use this keyword to specify the y kernel size. For METHOD=0, 1, 2, and 3, KY must be equal to KX. For METHOD=0 and 1, KY must be set equal to 3.

METHOD

Use this keyword to specify the type of filter to apply. Choose one of the following:

  • 0: Sobel
  • 1: Roberts
  • 2: Median
  • 3: Low pass
  • 4: High pass
  • 5: Laplacian
  • 6: Directional
  • 7: Gaussian High Pass
  • 8: Gaussian Low Pass
  • 9: User-defined; use this method with the KERNEL keyword set, to use a custom kernel.

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

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'

If this keyword is not defined, a convolution is performed on all bands.

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.