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

ENVI_AVHRR_WARP_DOIT

ENVI_AVHRR_WARP_DOIT

Use this procedure to warp AVHRR data or resulting AVHRR data products. This procedure requires the file ID from the file to warp and the corresponding AVHRR file ID from the original dataset. For example, you can warp a calibrated image cube or an AVHRR SST image by specifying the file ID of the product and the file ID of the original AVHRR dataset. In order to warp a raw AVHRR dataset, you supply the same file ID. The original AVHRR dataset must be an AVHRR Level 1B or KLM file. The information in the file header is used to compute the warp points.

Syntax


ENVI_DOIT, 'ENVI_AVHRR_WARP_DOIT', AVHRR_FID=variable, BACKGROUND=integer, DEGREE=value, DIMS=array, FID=file ID [, GCP_OUT_NAME=string], GRID=array [, /IN_MEMORY], METHOD={0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8} [, OUT_BNAME=string array], OUT_NAME=string, PIXEL_SIZE=array, POS=array, PROJ=structure [, R_FID=variable] [, /ZERO_EDGE]

Keywords


AVHRR_FID

Use this keyword to specify the file ID for the original AVHRR dataset, either an AVHRR Level 1B or KLM file. This is the value returned from the keyword R_FID in the ENVI_OPEN_DATA_FILE procedure (be sure to set the keyword AVHRR when you call ENVI_OPEN_DATA_FILE). FID is a long integer with a value greater than 0. An invalid file ID is specified as –1.

BACKGROUND

Use this keyword to specify the output image background value.

DEGREE

Use this keyword to specify the degree of the warp to perform. This keyword is unnecessary when METHOD=0, 1, 2, 6, 7, or 8.

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

GCP_OUT_NAME (optional)

Use this keyword to specify a single string with the output filename for the warp-points file.

GRID

Use this keyword to specify the number of points in the x and y warping grid. GRID is a two-element array of long integers specifying the number of x and y points, respectively, used to form an equally spaced set of warp points.

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

METHOD

Set this keyword to one of the following integers to specify the warping method to use.

  • 0: RST with nearest neighbor
  • 1: RST with bilinear
  • 2: RST with cubic convolution
  • 3: Polynomial with nearest neighbor
  • 4: Polynomial with bilinear
  • 5: Polynomial with cubic convolution
  • 6: Triangulation with nearest neighbor
  • 7: Triangulation with bilinear
  • 8: Triangulation with cubic convolution

OUT_BNAME (optional)

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.

PIXEL_SIZE

Use this keyword to specify the x and y pixel size. PIXEL_SIZE is a two-element, double- precision array of the output x and y pixel sizes, respectively.

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'

PROJ

Use this keyword to specify the projection for the warped file. PROJ is a projection structure returned from ENVI_GET_PROJECTION or ENVI_PROJ_CREATE.

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.

ZERO_EDGE (optional)

Set this keyword to set the edges outside any triangles to the value specified by BACKGROUND. Use this keyword only with triangulation (METHOD=6, 7, or 8).

API Version


3.2



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