Home

Quick Links

Software Manual
GitHub
API Reference

Documentation Versions

Latest Release
Dev
8.3.0
8.2.0
8.1.0
8.0.0
7.2.0
7.1.0
7.0.0
6.0.0
3.9.0
3.5.0
USGS

ISIS Application Documentation


autoregtemplate

Printer Friendly View | TOC | Home

Create auto registration group template

Overview Parameters Example 1 Example 2 Example 3

Description

This program creates an auto registration group template for applications such as "coreg", "pointreg", "qnet", "findrx", and other ISIS software with a pattern matching component. Given a specific algorithm name, it will create that specific algorithm group template. If a tolerance is specified, the application will automatically insert the tolerance keyword and value into the auto registration template. The user must enter values for the chip sizes of both the pattern and search chips.

It is highly recommended that users review the Pattern Matching document (in the "Related Objects and Documents" section). This is where you will find the available auto registration algorithms.

NOTE: This program lacks updates for the Gruen pattern matching algorithm. In the future, this program will be deprecated and replaced with a wizard (expert system) which will help guide the user in the selection of the appropriate algorithm and parameter values.

Categories


Related Objects and Documents

Applications

Documents


History

Elizabeth Miller2005-09-28 Original Version
Jacob Danton2006-01-05 Added SubpixelAccuracy option.
Jacob Danton2006-05-17 Added MinimumPatternZScore option and updated appTest.
Brendan George2006-07-19 Moved MininmumPatternZScore keyword to PatternChip Group
Travis Addair2010-04-15 Updated to use the current version of keywords accepted by AutoReg, improved documentation on parameters, and improved error reports.
Travis Addair2010-04-22 Updated tests and examples.
Jeannie Walldren2010-06-16 Added CHIPINTERPOLATOR and INTERPOLATORTYPE parameters to Algorithm group. Updated examples and added error unitTest.
Jeannie Walldren2010-07-20 Changed VALIDPERCENT to SSUBCHIPVALIDPERCENT parameters in SearchChip group. Added PVALIDPERCENT to PatternChip group. Updated examples and unit tests.
Jeff Anderson2011-10-05 Updated documentation
Kimberly Oyama2012-10-03 Removed the ECCENTRICITYRATIO, ECCENTRICITYTESTING, RESIDUALTESTING, and RESIDUALTOLERANCE parameters because they are no longer used due to the new sub-pixel registration algorithm that has replaced the previous surface model algorithm. Also because of the new algorithm, the minimum windowsize was changed from 3 to 5. The CHIPINTERPOLATOR parameter has been removed and the INTERPOLATORTYPE parameter has been renamed INTERP. The TO parameter has been changed to TOPVL. The references to the AutoReg class have been rewritten for better user understanding and helpful documentation has been added for some parameters. The documentation has been updated to reflect these changes. Fixes #1043.

U.S. Department of the Interior | U.S. Geological Survey
ISIS | Privacy & Disclaimers | Astrogeology Research Program
To contact us, please post comments and questions on the USGS Astrogeology Discussion Board
To report a bug, or suggest a feature go to: ISIS Github
File Modified: 02/21/2025 19:28:09
X

Files: TOPVL


Description

This file will contain the auto registration group template.

Type filename
File Mode output
Close Window
X

Algorithm: ALGORITHM


Description

This is the name of the algorithm (AdaptiveGruen, MaximumCorrelation, or MinimumDifference) for the auto registration group being created.

Type string
Close Window
X

Algorithm: TOLERANCE


Description

This is the value of the tolerance for the auto registration, represented in the template as the Tolerance keyword.

Type double
Close Window
X

Algorithm: REDUCTIONFACTOR


Description

Reduction factor used to speed up the pattern matching algorithm. The original pattern and search chips are divided by this factor to get the size of the new pattern and search chips.

Type integer
Internal Default None
Close Window
X

Algorithm: SUBPIXELACCURACY


Description

This option allows the user to specify if sub-pixel accuracy will be used in the registration. Enables the SurfaceModel options, as those tests will only be performed when calculating to sub-pixel accuracy. When this parameter is true, SurfaceModel parameters may be selected.

Type boolean
Default TRUE
Inclusions
  • DISTANCETOLERANCE
  • WINDOWSIZE
Close Window
X

Algorithm: INTERP


Description

Type of interpolator to be used to read and load the pattern and search chips.

Type string
Default CUBICCONVOLUTIONTYPE
Option List:
Option Brief Description
NEARESTNEIGHBORTYPE NearestNeighborType Indicates that a NearestNeighborType interpolator should be used to load chips.
BILINEARTYPE BiLinearType Indicates that a BiLinearType interpolator should be used to load chips.
CUBICCONVOLUTIONTYPE CubicConvolutionType Indicates that a CubicConvolutionType interpolator should be used to load chips.
Close Window
X

PatternChip: PSAMP


Description

The sample size of the pattern chip for the auto registration. The Sample keyword in the PatternChip group will be set to this value in the auto registration template.

Type integer
Close Window
X

PatternChip: PLINE


Description

The line size of the pattern chip for the auto registration. The Line keyword in the PatternChip group will be set to this value in the auto registration template.

Type integer
Close Window
X

PatternChip: PMIN


Description

The minimum value a pixel must have in order to be considered valid and used in the auto registration. This parameter is optional, and does not have to be set. The auto registration algorithm will default to the Isis ValidMinimum, if this parameter is not provided.

Type integer
Internal Default None
Close Window
X

PatternChip: PMAX


Description

The maximum value a pixel must have in order to be considered valid and used in the auto registration. This parameter is optional, and does not have to be set. The auto registration algorithm will default to the Isis ValidMaximum, if this parameter is not provided.

Type integer
Internal Default None
Close Window
X

PatternChip: MINIMUMZSCORE


Description

This option allows the user to specify the minimum z-score range for the minimum and maximum values for the pattern chip that will be used in the registration. The auto registration algorithm will default to 1.0 if this parameter is not provided.

Type double
Internal Default None
Close Window
X

PatternChip: PVALIDPERCENT


Description

The minimum percent of pixels in the pattern chip that must be valid in order for the auto registration of the chip to be used. This parameter is optional, and does not have to be set. The auto registration algorithm will default to 50.0 if this parameter is not provided.

Type double
Internal Default None
Close Window
X

SearchChip: SSAMP


Description

The sample size of the search chip for the auto registration. The Sample keyword in the SearchChip group will be set to this value in the auto registration template.

Type integer
Close Window
X

SearchChip: SLINE


Description

The line size of the search chip for the auto registration. The Line keyword in the SearchChip group will be set to this value in the auto registration template.

Type integer
Close Window
X

SearchChip: SMIN


Description

The minimum value a pixel must have in order to be considered valid and used in the auto registration. This parameter is optional, and does not have to be set. The auto registration algorithm will default to the Isis ValidMinimum if this parameter is not provided.

Type integer
Internal Default None
Close Window
X

SearchChip: SMAX


Description

The maximum value a pixel must have in order to be considered valid and used in the auto registration. This parameter is optional, and does not have to be set. The auto registration algorithm will default to the Isis ValidMaximum, if this parameter is not provided.

Type integer
Internal Default None
Close Window
X

SearchChip: SSUBCHIPVALIDPERCENT


Description

The minimum percent of pixels in the subchip of the search chip that must be valid in order for the auto registration of the chip to be used. This parameter is optional, and does not have to be set. The auto registration algorithm will default to 50.0 if this parameter is not provided.

Type double
Internal Default None
Close Window
X

SurfaceModel: DISTANCETOLERANCE


Description

Set the distance that the surface model is allowed to move away from the best whole pixel fit in the chip.

Type double
Default 1.5
Close Window
X

SurfaceModel: WINDOWSIZE


Description

Set the surface model window size in terms of the length of a square window. The pixels in this window will be used to fit a surface model in order to compute to sub-pixel accuracy. Must be odd and greater than or equal to five.

Type integer
Default 5
Minimum 5 (inclusive)
Close Window