| Back to top |
| Back to top |
| Name | Caption |
|---|---|
| Input Folder | Input folder |
| Output Folder | Output folder |
| Overwrite Results | Overwrite existing results |
| Send Email | Email notification settings |
| Band-to-Band Coregistration Method | Method of band-to-band coregistration |
| Reference Channel | Reference channel |
| Maximum Shift Between Bands | Maximum shift between bands (pixels) |
| DEM Source | DEM tile source |
| Source Background Type | Source background type |
| Source Background Value | Source background pixel value |
| Output Map Units | Output projection |
| Multispectral Pixel Output Size | Multispectral output pixel size |
| Resampling Method | Resampling method |
| Back to top |
Input Folder
The path and name of the folder containing multispectral images to band coregister.
Images can be the output from the Data Ingest module, the GCP Collection module, or both. Images must contain a math model that can be used for precise band coregistration. Images from other sources are also supported, provided they are in either GeoTIFF or PCIDSK format.
This parameter is mandatory.
Output Folder
The path and name of the folder to which to write the output bands of coregistered images. This must be a folder other than that specified for the Input Folder parameter.
This parameter is mandatory.
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.
Send Email
If necessary, you can set up CATALYST Enterprise to send an email notification on job start and job completion.
With this check box selected, an email message is sent to each address specified in the Email Addresses box after the job starts and on completion.
You can specify one or more addresses, and each must be separated by a comma or a semi-colon. The email address of the user currently logged in displays by default.
Band-to-Band Coregistration Method
The method to use to coregister bands in an image.
Reference Channel
The channel to use as reference to coregister the other bands.
If no value is specified for this parameter, the module uses the channel number set in the B2B Master Band metadata tag, if it exists; otherwise, it uses the first channel.
Maximum Shift Between Bands
The estimated maximum shift between bands, in pixels. If no value is specified for this parameter, the module uses the value set in the B2B Misregistration Shift metadata tag, if it exists; otherwise, the value defaults to 20 pixels.
This estimate helps in the search for ground control points (GCPs) between bands for coregistration.
DEM Source
The name of a single digital elevation model (DEM) file or a folder containing one or more DEM tiles.
The index.txt file lists the DEM files contained in the specified folder and provides information describing each DEM tile. The information in the DEM index file supersedes other DEM parameters in the module; all other DEM-related parameters are ignored. For more information about the format of the index.txt file and specific requirements for the individual DEM tiles, see Format of the DEM index file.
When the value of DEM Source is the name of an existing folder, the module searches that folder for a file named index.txt, and a set of DEM raster tiles. The index.txt file contains a single vector channel that lists the DEM files contained in the specified folder and provides information describing each DEM tile.
If no value is specified for this parameter, the module uses the default global DEM installed with CATALYST Enterprise (gmted2010).
Source Background Type
The method to use to determine which pixels in the source image to process as background (NoData) pixels. In general, if a pixel is considered NoData, the module processes it in a specific manner.
If the Any option or the All option is selected, a value must be specified for the Source Background Value parameter.
File Metadata, else None: reads the NoData value from the input-file metadata. The module first checks for the file-level metadata tag NO_DATA_VALUE in the source raster. If the tag is present, this value is used as a default for all channels in the file. Next, the module checks for channel-level NoData tags; if one is found, the channel-level value overrides the file-level value for that channel.
If there are channel-level NoData tags, but no file-level tag, a pixel is considered as NoData if each of the channels with a NoData tag corresponds to its NoData value. In this case, channels without a NoData tag are ignored when identifying background pixels.
If the file does not contain NoData tags, all pixels in the source image are considered valid.
For specific examples, see the Source Background Value parameter description.
Source Background Value
The source background value is provided as either a single number (applied to all channels) or as a pixel "stack" (a comma-delimited list of values). If a pixel stack is provided, but the number of values does not equal the number of channels, the list is truncated or the last value is repeated as necessary. The background values provided is truncated to the range allowed by the source image data type.
Source Background Type set to All and Source Background Value set to 0: a pixel is considered background if all three channels are zero.
Output Map Units
The projection of the output imagery.
The value of this parameter must be in the PCI Projection String format.
UTM: Universal Transverse Mercator
The value specified can be the UTM grid zone number and row, and Earth model, as follows:
UTM [mm] [r] [Ennn]
SPCS: State Plane Coordinate System
The SPCS zone number and Earth model can be specified as follows:
SPCS [mmmm] [Ennn]
LONG/LAT: Longitude and latitude
The Earth model can be specified for LONG/LAT (and other units except PIXEL), as follows:
LONG/LAT [Ennn]
If the Earth model is not specified, it is assumed to be E000 (Clarke 1866).
EPSG: European Petroleum Survey Group code
You can specify the projection by entering an EPSG code defined by the Open Geospatial Consortium (OGC). For information on the code definitions, visit epsg.org and spatialreference.org.
The EPSG code is specified using the EPSG keyword followed by an integer and separated by a colon; for example:
EPSG:4326
Most common EPSG codes are supported.
METER: Image along-row and along-column meters
FEET: Image along-row and along-column feet
LCC D350 | 0 0 3.0 46.5 44.0 49.0 700000 6600000 0 0 0 0 0 0 0 0 0 -1
If you do not specify a value for Output Map Units, the map unit of the input image is used for the output image. If the input data is a variety of map units, the map unit of each output image is that of its corresponding input image. In such a case, it is recommended that you specify the output map units.
You can also specify the label of a projection defined in the userproj.txt file.
Multispectral Pixel Output Size
The output spatial resolution for the multispectral imagery to be orthorectified.
The units for the pixel size must match the units specified for the Map Units parameter; for example, if the value of Map Units is specified as UTM, the multispectral pixel output size is in meters.
If no value for this parameter is specified, the pixel output size is based on the input math model associated with each scene in the input-scenes folder.
Resampling Method
The resampling method to use during processing.
| Back to top |
Preprocessing requirements
Before running this module, the following requirements must be met to ensure the job processes successfully and produces accurate results:
Module details
The Band Coregistration module finds valid images in the specified input folder and creates a child job for each valid image found. Valid images are those with multiple bands and in PCIDSK or GeoTIFF format.
The coregistration process consists of collecting ground control points (GCP) between bands. With the Nominal Coregistration (NC) method, the collected GCPs are used to compute a first-order polynomial model and warp the bands. With the Precise Coregistration (PC) method, the collected GCPs are used to refine the math model and generate an orthorectified product for the bands.
Job results
© PCI Geomatics Enterprises, Inc.®, 2026. All rights reserved.