AUTOTIE

Automatic tie-point collection


EnvironmentsPYTHON :: EASI :: MODELER
Quick linksDescription :: Parameters :: Parameter descriptions :: Details :: Example :: Related

Back to top

Description


AUTOTIE automatically collects tie points (TP) from a set of overlapping images.
Back to top

Parameters


autotie(mfile, oeprojo, imgset, loclmask, extprule, dbic, filedem, dbec, backelev, elevref, elevunit, elfactor, smplsrc, distrib, algo, searchr, searchun, minscore, proc)

Name Type Caption Length Value range
MFILE * str Input OrthoEngine project file 1 -    
OEPROJO * str Output OrthoEngine project file 1 -    
IMGSET str Set of working images 0 -   See Parameter Details.
Default: ALL
LOCLMASK str Local exclusion mask 0 -   Default: NONE
EXTPRULE str How to process existing tie points 0 -   REPLACE | ADD
Default: REPLACE
DBIC List[int] Input image channels 0 -   Default: 1
FILEDEM str Input DEM file or folder 0 -    
DBEC List[int] Input elevation channel 0 -   Default: 1
BACKELEV List[float] Background elevation value 0 - 1 Default: 
ELEVREF str Vertical reference for elevation values 0 -   See Parameter Details
Default: MSL
ELEVUNIT str Units of elevation values and accuracy 0 - 12 METER | FEET | US_FEET
Default: METER
ELFACTOR List[float] Elevation offset and scale 0 - 2  
SMPLSRC str Source of sample points 0 -   SUSAN | GRID
Default: SUSAN
DISTRIB str Area of distribution 0 - 15 ENTIRE | OVERLAP
Default: ENTIRE
ALGO str Algorithm to use for matching 0 -   FFTP| NCC
Default: FFTP
SEARCHR List[int] Size of area to search 0 - 1 1 -
Default: 100
SEARCHUN str Unit of measure for search radius 0 - 7 PIXEL | METER | FEET | US_FEET
Default: PIXEL
MINSCORE List[float] Threshold of minimum acceptance 0 - 1 0.0 - 1.0
Default: 0.75
PROC str Processing algorithm 0 -   See Parameter Details.

* Required parameter
Back to top

Parameter descriptions

MFILE

The name of the input CATALYST Professional OrthoEngine project file, a specification of files by using a wildcard (*), or a text file in which each line is the path and file name of an OrthoEngine project. When you specify two or more OrthoEngine projects, they are merged into a single project to perform TP matching.

Images in the input project file or files must have an approximate math model, based on either existing information in the math-model segment or the orbit segment.

When your input is several projects, which are merged subsequently, the images must have a one-to-one mapping with photo ID. That is, a single image file referenced in more than one project must have the same photo ID in all projects, and the photo ID must be unique to that one image file.

OEPROJO

The name of the OrthoEngine project file to which to write the TPs collected automatically by AUTOTIE .

If a file with the same name exists in the folder you specify, an error message is displayed.

If you do not enter a path name, or you enter a relative path, the file is saved relative to the current working folder.

IMGSET

The processing method to use for overlapping images.

Available options are as follows:

If no value is specified for this parameter, AUTOTIE searches for TPs between any two overlapping images in the project.

LOCLMASK

Specify whether to apply a local mask to prevent points from being collected in those locations. If no value is specified for this parameter (default), or you specify a value, but one or more of the images do not contain a bitmap or vector segment, no local exclusion mask will be applied for those images.

The syntax for LOCLMASK is:
LOCLMASK = (NONE | BIT | VEC | <n>)
You can specify the value of LOCLMASK using the following:

This parameter is optional.

EXTPRULE

The rule to apply for processing existing TPs in the input project or projects.

Available options are as follows:

DBIC

The channel or channels in the input image file to use for matching TPs in a pair of images. When you specify two or more channels, averaging is used to determine matching.

FILEDEM

The name of a file, folder, or DEM index file that contains digital elevation model (DEM) tiles.

If FILEDEM is the name of a single raster DEM file, the values of DBEC and BACKELEV are applied, if defined.

If no value is specified for FILEDEM , the offset value specified for ELFACTOR is used for the elevation. If a value is specified neither for FILEDEM nor ELFACTOR , an approximated elevation value is calculated from the system DEM file gmted2010.

If the value of FILEDEM is the name of an existing folder, the specified folder is read for a index.txt file. The index.txt file must be in the DEM index format.

If the value of FILEDEM is the name of a text file ( *.txt ), the file must be in the DEM index format.

For more information about the format of the DEM index file, see DEM index file .

Note: Elevation values obtained from the DEM are used only to assist in finding matching TPs. The height information obtained from the DEM is not incorporated into the math model.

DBEC

The channel that contains the digital elevation model (DEM).

If the value of FILEDEM is an empty string or a DEM index text file, this parameter is ignored.

BACKELEV

The background elevation (NoData) value of the input DEM. Areas that are defined as NoData in the DEM are excluded from consideration while searching for TPs.

If no value is specified for this parameter, AUTOTIE scans for ELEVATION_BACKGROUND or NO_DATA_VALUE metadata tags, first at the channel level, and then at the file level. If this value is neither specified nor found in the metadata, a default value of -32768 is used.

If the value of FILEDEM is an empty string or a DEM index text file, this parameter is ignored.

ELEVREF

The vertical reference for the elevation values in the source DEM, or for the constant Elevation Offset and Elevation Scale ( ELFACTOR ) value or values, if defined.

Acceptable values are as follows:

If the value of FILEDEM is an empty string or a DEM index text file, this parameter is ignored.

ELEVUNIT

The unit of measure for the elevation values of the input DEM file. If necessary, you can specify the second value as the vertical accuracy of the DEM to use for TP collection. This DEM will also be used during TP collection by changing the TPs to elevation TPs.

Acceptable values are as follows:

If elevation values are specified by using FEET , the conversion factor to meters is 0.3048 (corresponding to International Feet). With US_FEET , the conversion factor to meters is 1200/3937 (corresponding to U.S. Survey Feet).

If no value is specified for this parameter, AUTOTIE scans for an ELEVATION_UNITS metadata tag at the file level, and then again at the channel level. If this value is neither specified for the parameter nor found in the metadata, METER is applied.

If FILEDEM is an empty string or a DEM index text file, this parameter is ignored.

ELFACTOR

When you specify an input DEM, the scale and offset values you specify for ELFACTOR are used to shift and scale the DEM pixel values to those of ELEVUNIT .

With this parameter, you specify two values: the first number defines the offset while the second, optionally, specifies the scale.

The conversion formula is as follows:

scale × (DEM_pixel_value + offset) = elevation_value

If no value is specified for FILEDEM , only the offset value of ELFACTOR is significant. The value is interpreted as a uniform elevation value in the units of ELEVUNIT and using the vertical reference specified for ELEVREF . If a value is specified neither for ELFACTOR nor FILEDEM , an approximate DEM based on the global DEM file (located in the etc folder of your CATALYST Professional installation) will be used.

If FILEDEM is an empty string or a DEM index text file, this parameter is ignored.

If a value is specified neither for ELFACTOR nor FILEDEM , default values of 0.0 and 1.0 are used for offset and scale, respectively.

SMPLSRC

The source of sample points for matching TPs, and the number of points to use. Sample points may be generated automatically by using the SUSAN or GRID option.

Available options are as follows:

If no value is specified for this parameter, a default value of SUSAN:64 is used.

The SUSAN and GRID options determine how to find the initial candidate positions in one image—the source image—for collecting sample points. AUTOTIE builds a patch around each candidate position for which it searches in overlapping images.

When collecting TPs, the SUSAN option is often preferred, because it facilitates performing quality assurance on the collected TPs; that is, you can visualize a recognizable feature (a building corner or specific tree, for example) and look at another image to see if it matches correctly.

Note: Previous versions of AUTOTIE included basic support for the sample source along with the number of samples, similar to the following:
  • SUSAN:64
  • GRID:64
Previously, you specified the method and number of samples by separating the values with a single colon (:). For backward compatibility, the SMPLSRC parameter supports the previous and new format of specifying the source information.

DISTRIB

The area of each image in which to distribute the number of TPs per SMPLSRC:[num_samples] .

Available options are as follows:

ALGO

The algorithm used for automated matching of TPs.

The supported methods are as follows:

If no value is specified for this parameter, FFTP: Fast Fourier Transform Phase Matching is used by default.

When the two images being matched have similar gray values and appearances, NCC generally produces acceptable results. When there is a rotation or image-size error in the initial math models, NCC may produce better matching results than FFTP. Because the template size that NCC uses is smaller than that of FFTP, NCC also typically generates faster results.

For more consistently accurate results, one of the FFTP-based methods is recommended. An FFTP-based method uses a larger template size than NCC and, because it works in the frequency domain, it looks at the patterns of details in the image rather than the gray values in a small neighborhood, which NCC uses. This makes it more robust than NCC when there is a large difference in brightness between images or when a major land-use change has occurred. FFTP-based methods also better match images of the same area from different sensors or spectral bands.

SEARCHR

The size of the area to search in a target image. The unit of measure for this value is determined by the value of Search radius units ( SEARCHUN ).

Matching candidate points in the source image are projected to the ground, and then reprojected to the target image. You must have a good initial position for the two correlation windows. With an aerial project, a good initial position can be determined when the exterior orientation (EO) parameters of the images are accurate.

The following factors can affect automatic collection of TPs:

The search radius specifies the distance from a starting location on the target image over which to conduct the search for the best match with a fixed point on the source image.

The search radius is also an estimation of error with the positional information of the raw image and the accuracy of the DEM. If you know that your images are accurate to 80 meters, and your DEM is accurate to 200 meters, set the search radius to 280 meters. A larger search radius—for example, 300 or greater is recommended for hilly or mountainous terrain—will require more processing time, because more locations are evaluated to determine the best match for a TP.

If no value is specified for this parameter, AUTOTIE uses a default search radius of 100 pixels.

SEARCHUN

The unit of measure of the value of Search radius ( SEARCHR ).

Acceptable values are as follows:

With PIXEL , the value is interpreted as the number of pixels in the reference image. With METER , FEET , or US_FEET , the search radius represents meters or feet in the reference image.

MINSCORE

The threshold value to use to control acceptance or rejection of a candidate TP as valid. The value is the minimum match quality to consider as an acceptable match, with 1.0 indicating a perfect match.

When using the FFTP matching method, the value is converted internally to a minimum-acceptable value for peak phase-shift.

When using the NCC matching method, the value specifies the minimum match score required to accept a local match between the input and reference images as a TP. The default value is 0.75 .

PROC

The amount of memory (in megabytes) for AUTOTIE to use during processing.

If a memory limit is not specified, AUTOTIE uses a default of 1 GB or half the available physical memory, whichever is smaller.

Back to top

Details

AUTOTIE automatically collects TPs from a set of overlapping images. If no specific input files are defined, AUTOTIE searches for TPs between any two overlapping images in the specified folder.

Using AUTOTIE with radar data

When the input data contains image layers written as complex values, the total power in decibels is computed temporarily and used for matching. When possible, it is also recommended that you calibrate the data in sigma, beta, or gamma naught. FFTP matching is also recommended when working with SAR data.

DEM index file

With the FILEDEM parameter, you can specify the name of a file, a folder, or a text file. When you specify a folder, AUTOTIE reads the folder for an index.txt file. If found, the file must be in the required format for a DEM index. If you specified a text file, the file must also be in the required format for a DEM index. The format of the DEM index file is read as a single virtual DEM, eliminating the need to merge the DEM tiles into a single file.

The DEM index file (index.txt) and each DEM tile must meet the following conditions. Each tile must:
  • Be in the same coordinate system
  • Be raster-aligned; that is, the geocoding for all tiles is defined so that all pixels fall on a common raster grid
  • Use the same data type
  • Be based on the same height datum
  • Use the same NoData value
  • Use the same ELFACTOR value

The following text shows an example of a DEM index file.

MAPUNITS       LONG/LAT D000
DATATYPE       16S
DBEC           1
BACKELEV       -32768.000
ELEVREF        MSL
ELEVUNIT       METER
ELFACTOR       0.000 1.000000000000
RES_XY         0.0008333333333333 0.0008333333333333
#Filename                ULX                    ULY                     LRX                   LRY
srtm_01_02.tif   -180.000416666676760    55.000416618227803   -174.999583333343420    49.999583284894470
srtm_01_07.tif   -180.000416690891140    30.000417247801863   -174.999583357557810    24.999583914468531
srtm_01_12.tif   -180.000416690891140     5.000416642442191   -174.999583357557810    -0.000416690891143
srtm_01_15.tif   -180.000416666676760    -9.999582994342006   -174.999583333343420   -15.000416327675339
srtm_01_16.tif   -180.000416666676760   -14.999583115413941   -174.999583333343420   -20.000416448747274
srtm_01_17.tif   -180.000416666676760   -19.999583236485876   -174.999583333343420   -25.000416569819208
srtm_01_18.tif   -180.000416666676760   -24.999583357557810   -174.999583333343420   -30.000416690891143
		  

The first eight lines of the file describe common values that apply to each image; they must be in the order shown in the example with no comments or blank lines between them. The remaining lines describe the image boundary records for each image in the DEM tile data set. Comments (lines beginning with a #) are allowed in the list of DEM tiles in the file.

The format of the eight header lines is:
  • MAPUNITS: The EPSG projection code or PCI map-units string for the coordinate system.
  • DATATYPE: The data type of the files.

    Acceptable values are:
    • 8U
    • 8S
    • 16U
    • 16S
    • 32U
    • 32S
    • 32R
    • 64U
    • 64S
    • 64R
  • DBEC: The channel number for the input digital elevation model (DEM) elevation channel to be processed.

  • BACKELEV: The background elevation (NoData) value in the input DEM elevation layer.

  • ELEVREF: The vertical reference for the elevation values contained in the source DEM, or for the constant ELFACTOR value, if it is used.

  • ELEVUNIT: The units of the elevation values that are stored as pixel values in the input DEM, as specified either by FILEDEM or by the first entry in ELFACTOR.

  • ELFACTOR: When an input digital elevation model (FILEDEM) is specified, the value of this parameter is used to shift and scale the DEM pixel values to values in the units indicated by the value of the ELEVUNIT parameter.

  • RES_XY: The x and y image-resolution values.

Each line following the header lines is treated as either a comment line or as a raster-tile description. Empty lines or those beginning with a number sign (#) are treated as comment lines. Each raster-tile description line contains four parameters separated by white space:
  • DEM raster-file name: path to the DEM raster file. This may be an absolute path or a relative path. A relative path is relative to the DEM index file itself.
  • Upper-left x-coordinate: the x-coordinate at raster-column location 0.0, raster-row location 0.0
  • Upper-left y-coordinate: the y-coordinate at raster-column location 0.0, raster-row location 0.0
  • Lower-right x-coordinate: the x-coordinate at raster-column location 'numPixels', raster-row location 'numLines', where numPixels and numLines are the dimensions of the raster.
  • Lower right y-coordinate: the y-coordinate at raster-column location 'numPixels', raster-row location 'numLines', where numPixels and numLines are the dimensions of the raster.
Note: This description of the raster boundary provides coordinates at the outer extents of the pixels; with butt-joined tiles, the tile records should indicate gap-free coverage.

As individual raster tiles are accessed, their properties are compared with the values listed in the DEM index file. If they do not conform to the indicated values, an error message appears in the log.

Note: If the specified OrthoEngine project includes any inactive images, they are excluded from processing.
Back to top

Example

from pci.autotie import autotie


mfile = "input.prj"
oeprojo = "output.prj"
imgset = ""
loclmask = ""
extprule = "REPLACE"
dbic = [1]
filedem = "dem.pix"
dbec = []
backelev = []
elevref = ""
elevunit = ""
elfactor = []
smplsrc = "SUSAN:samples=64"
distrib = "OVERLAP"
algo = "NCC"
searchr = [100]
searchun = "PIXEL"
minscore = [0.75]
proc = ""

autotie(mfile, oeprojo, imgset, loclmask, extprule, dbic, filedem, dbec, backelev, elevref, elevunit, elfactor, smplsrc, distrib, algo, searchr, searchun, minscore, proc)

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