DEM Index File Creator module


Quick linksDescription :: Parameters :: Parameter descriptions :: Details

Back to top

Description


The DEM Index File Creator module reads the DEM folder for tiled digital elevation model (DEM) files and writes the file names of each to a PCIDSK ( index.pix ) file and a text file ( index.txt ). These index files are used by the DEM Source parameter in other CATALYST Enterprise modules, when required.
Back to top

Parameters


Name Caption
DEM Folder Input DEM folder
Search Pattern Pattern for file searching
Include Subfolders Include subfolders in search
Overwrite Results Overwrite existing results
Indexing Method Method used for generating the index
Stored Path Type Path type of files stored in index
Create Index PIX Create an index.pix file
Elevation Channel Input elevation channel
Background Elevation DEM background elevation value
Elevation Reference/Datum Elevation model
Elevation Unit Elevation unit
Elevation Scale Elevation scale
Elevation Offset Elevation offset
Vertical Accuracy Theoretical vertical accuracy of elevation data
Back to top

Parameter descriptions

DEM Folder

The path and name of the folder containing tiled digital elevation models (DEMs) to include in the index files ( index.pix and index.txt ).

Note: This folder must be write-enabled; that is, it cannot have a read-only attribute.

This parameter is mandatory.

The search pattern to use when scanning the folder of reference imagery.

For example, to search PCIDSK files, you can specify *.pix, or to search .TIFF (or .tif) files, you can specify *.tiff or *.tif, as applicable. You can also combine two or more patterns separated by a comma, such as *.pix, *.tif.

Include Subfolders

Select this check box to include subfolders in the search.

Overwrite Results

Select this check box to overwrite the existing output files, if any exist. If this check box is left clear, and an output file exists in the relevant folder, the status of the job displays a message informing you of the existence and name of the output file. The message is also written to the event log of the job.

Indexing Method

There are two options available for indexing: Fast and Accurate. With the Fast option selected, the four corners of the scene are detected, including areas where there is no data. This option performs indexing the fastest. With the Accurate option selected, the system attempts to find the inner four corners where data exists, and excludes most of the no-data area.

When indexing orthos that have no-data values in the corners, choosing the Accurate option is recommended, though it takes longer than the Fast option.

Stored Path Type

From the list, select one of the following:

The benefit of using a relative path is that you can move the index along with the images to another folder or computer, and the files are still be recognized. With an absolute path, the exact path of the image must always exist.

Create Index PIX

Select this check box to have the job create a file named index.pix. The index.txt is always created.

Elevation Channel

The image channel that contains the DEM data to include in the index. If no value is specified, channel 1 is used as a default.

Background Elevation

The pixel value representing background elevation (pixels where no elevation value is present) in the input digital elevation model (DEM).

If no value is specified for this parameter, the module checks for ELEVATION_BACKGROUND or NO_DATA_VALUE metadata tags, first at the channel level, and then at the file level. If a value is neither specified nor found in the metadata, the default value of -32768 is used for 16S and 32R data, 65535 for 16U, and 0 for 8U.

Elevation Reference/Datum

The vertical reference for the elevation values in the source digital elevation model (DEM), or for the constant value of the Elevation Offset and Elevation Scale parameters, when available, and specified.

Available values are as follows:

Elevation Unit

The unit for the elevation values in the source digital elevation model (DEM).

Available values are as follows:

Elevation Scale

The elevation scale used by the digital elevation model (DEM).

If no value is specified for this parameter, the module searches for an ELEVATION_SCALE metadata tag at the file level, then again at the channel level of the input DEM. If a value is neither specified nor found in the metadata, a default value of 1.0 is used, indicating that the scale is one to one.

Elevation Offset

The elevation offset used by the digital elevation model (DEM).

If no value is specified for this parameter, the module searches for an ELEVATION_OFFSET metadata tag at the file level, and then again at the channel level of the input DEM. If a value is neither specified nor found in the metadata, the offset defaults to 0.0, indicating that there is no offset.

Vertical Accuracy

The vertical accuracy or uncertainty for each pixel in the specified DEM. Units for this value are the same as those specified for the DEM Units parameter.

For example, for a given pixel in the DEM, the elevation is 25 meters above mean sea level (MSL), but plus or minus five meters. In this case, the vertical accuracy is 5 meters; the true value of the selected pixel ranges from 20 meters through 30 meters.

The accuracy of the DEM is stipulated typically with the DEM. For example, Landsat imagery is available freely online, with the stipulation that the data is accurate 90 percent of the time; its vertical accuracy is 23 meters.

The specified accuracy levels are included as ORTHO_X_ACCURACY and ORTHO_Y_ACCURACY metadata tags in the output index files. These tags are read and interpreted by other CATALYST Enterprise modules.

This parameter is optional.

Back to top

Details

General job details

Preprocessing requirements

All DEMs must meet the following conditions:
  • All tiles must be of the same data type

    Supported data types are:
    • 16S
    • 16U
    • 32R
    Note:

    For DEMs, 16S and 32R are best. Negative elevations can be achieved with 16U by specifying the Elevation Offset parameter and the Elevation Scale parameter to produce negative elevations.

    If using an integer data type, consider applying an elevation offset and scaling.

    All tiles must be in the same projection, have the same pixel resolution, and be aligned on the same grid.

Module details

The DEM Index File Creator module reads the DEM folder for tiled digital elevation model (DEM) files and writes the file names of each to a PCIDSK ( index.pix ) file and a text file ( index.txt ). These index files are used by the DEM Source parameter in other CATALYST Enterprise modules, when required.

Job results

The index files created by the DEM Index File Creator module are written to the specified DEM folder. These index files are read by the DEM Source parameter in other CATALYST Enterprise modules, when required.

© PCI Geomatics Enterprises, Inc.®, 2026. All rights reserved.