| Back to top |
| Back to top |
| Name | Caption |
|---|---|
| Scene Folder | Input scene folder |
| Output Folder | Output folder |
| Output File Type | Output file type |
| Output File Options | Output file options |
| Overwrite Results | Overwrite existing results |
| Send Email | Email notification settings |
| Camera Calibration File | File of camera-calibration parameters |
| Exterior Orientation File | File of exterior-orientation parameters |
| EO File Format | Format of the exterior-orientation file |
| EO Map Units | Exterior orientation file projection |
| EO Elevation Reference | Exterior orientation vertical datums |
| EO Angular Unit | Exterior orientation file angular unit |
| Rotate Kappa Angle | Kappa-value rotation angle |
| DEM Source | DEM tile source |
| Output Map Units | Output projection |
| Source Background Type | Source background type |
| Source Background Value | Source background pixel value |
| Output Pixel Size | Output pixel size |
| Output Background Value | Output background value |
| Clip Amount | DEM clipping |
| Clip Units | Clipping units |
| Resampling Method | Resampling method |
| Resampling Method Extra Options | Extra options for resampling method |
| Sorting Method | Image sorting method |
| Starting Image | Starting image |
| Normalization Method | Normalization method |
| Normalization Method Extra Options | Normalization options |
| Color Balancing Method | Color-balancing method |
| Color Balancing Extra Options | Color-balancing options |
| Global Color Balance Mask File | Global color-balancing mask file |
| Global Color Balance Mask Layer | Global color-balancing mask layer |
| Global Color Balance Mask Segment | Global color-balancing mask segment |
| Cutline Method | Cutline method |
| Cutline Method Extra Options | Cutline options |
| Auto Constrain | Constrain cutlines to image centers |
| Factor | Auto Constrain Factor value |
| Simplify Cutlines | Simplify generated cutlines |
| Simplification Level | Level of simplification |
| Global Cutline Avoidance Mask File | Global cutline-avoidance mask file |
| Global Cutline Avoidance Mask Layer | Global cutline-avoidance mask |
| Global Cutline Avoidance Mask Segment | Global cutline-avoidance mask segment |
| Area of Interest File | Area-of-interest vector file |
| Crop Tiles to AOI | Crop tiles to area of interest |
| Tile Base Name | Base name |
| Tile Specification | Mosaic tile specification |
| Height | Height of the mosaic tile, in pixels |
| Width | Width of the mosaic tile, in pixels |
| Vertical Overlap | Vertical overlap between tiles |
| Horizontal Overlap | Horizontal overlap between tiles |
| Tile File | File containing tile-definition layer |
| Segment Number | Vector segment in tile file |
| Field Name | File containing tile-definition layer |
| Coordinate Type | Type of coordinates in script |
| Blend Width | Cutline blend width |
| Create Source Map | Create source map |
| Existing Tile Rule | Rule for processing existing tile |
| Delete Empty Tiles | Whether to delete empty tiles |
| Back to top |
Scene Folder
The path and name of the folder containing scenes to ingest.
Output Folder
The path and name of the folder to which to write the output files.
If tiled output is specified, tiles are processed by the processing nodes configured by the CATALYST Enterprise, and are stored in the specified output folder. Local copies of the tiles on processing nodes are automatically deleted. The output tile file names are generated automatically according to the Tile Base Name.
Output File Type
The format of the output file.
For more information on the supported file formats, see GDB-supported file formats.
Output File Options
The options to apply when creating the output file or files. The available options are specific to the file format; in each case, the default of no options is allowed.
For more information on the options available for the output file type you specify, see GDB-supported file formats.
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.
Camera Calibration File
The path and name of the file containing camera-calibration parameters for all input scenes.
For more information about camera calibration, see Data structure of aerial imagery.
If no value is specified for this parameter, the module reads the scene folder for a file named camera_calib.xml.
Exterior Orientation File
The path and name of the file containing the exterior-orientation (EO) parameters required for each scene.
The value you specify can be an absolute or a relative path. A relative path is relative to the scene folder.
The EO file (eo.txt) should contain, at a minimum, the ID (PhotoID), position (easting, northing, height), and orientation (omega, phi, kappa).
If no value is specified for this parameter, the Airphoto Ingest module reads the scene folder for the default eo.txt file. If this file is not found, an error message displays, and processing of the job stops.
EO File Format
The encoding method of the exterior orientation (EO) information.
With the text format, ID represents the PhotoID; x, y, z represent the position (easting, northing, height); omega, phi, and kappa represent the orientation.
EO Map Units
The projection for the EO.
UTM: Universal Transverse Mercator
MAPUNITS (Output Projection) can specify the UTM grid-zone number and row, and Earth model, as follows:
UTM [mm] [r] [Ennn]
For example, if the value of the EO Map Unit parameter is specified as UTM, then with the EO Map Unit parameter, you can enter 10 U D000. This means the final map unit of the EO information is UTM 10 U D000.
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, as defined by the OGC at epsg.org and spatialreference.org.
You specify the EPSG code using the EPSG keyword followed by an integer and separated by a colon, as shown in the following example.
EPSG:4326
Most common EPSG codes are supported.
You can also specify the label of a user-defined projection, if the projection exists in the userproj.txt file.
EO Elevation Reference
The flying height of the airphoto camera (vertical data) at the time the image was taken.
If the vertical data of the digital elevation model (DEM) and the flying height of the camera differ, the EGM2008 geoid model is used for the conversions during the orthorectification process.
EO Angular Unit
The angular unit of the EO angles.
Rotate Kappa Angle
The angle of rotation to add to the input kappa values, in units specified by the EO Angular Unit parameter.
In some cases, the kappa values in the EO file must be rotated (for example, by 90, -90 or 180 degrees). You apply the correction by specifying the angle of rotation.
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).
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.
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 Pixel Size
The sample size of the output imagery.
The output pixel size must be specified in the value (units) of Output Map Units; for example, when the value of Output Map Units is specified as a UTM zone, the pixel output size must be in meters. When the value is specified as Long/Lat, the pixel size must be in decimal degrees.
If a single value is specified, that value applies to both x and y values.
If no value is specified for this parameter, the pixel output size is based on the input math model associated with each scene in the input folder.
Output Background Value
The background (NoData) value to use for pixels that are not populated.
The specified background value is truncated to the range allowed by the source image data type.
When you specify one value, all channels are set to the same NoData value. If you want to specify different values for various channels, separate the values with commas. For example, to specify -32768 for channel 1 and zero for channel 2 (and any subsequent channels), enter "-32768, 0".
Clip Amount
The amount of data to clip from the epipolar digital elevation models (DEM) before merging and geocoding.
This parameter specifies the amount of the actual image data that is clipped, either as a number of pixels or as a percentage of the image size.
You can select between Pixels or Percent using the Clip Units parameter.
For example:
The default is blank, which means no clipping occurs. The maximum percentage value is 49 percent.
Clip Units
The unit to use for the value of the Clip Amount parameter.
When you specify a value for the Clip Amount parameter, this parameter is mandatory; otherwise, it is not required.
Resampling Method
The resampling method to use during processing.
Resampling Method Extra Options
SHAPINGWINDOW=[sw],BETA=[beta]
where:
SHAPINGWINDOW specifies a window to attenuate the SINC coefficients to reduce resampling artifacts. The value can be KAISER, HAMMING, HANN, LANCZOS, PARABOLA, or NONE. SHAPINGWINDOW is optional; the default value is KAISER. BETA is applicable only when SHAPINGWINDOW is KAISER. SHAPINGWINDOW determines the shape of the KAISER window; a larger BETA value produces greater attenuation of the SINC coefficients. Its value can be between 1.0 and 10.0. BETA is optional.
NUMCOLS=[nc],NUMROWS=[nr]
NUMCOLS=[nc],NUMROWS=[nr]
where:
NUMCOLS and NUMROWS can be any value between 1 and 11.
DSFACTORCOL=[dc],DSFACTORROW=[dr]
where:
DSFACTORCOL is the fraction downsampling factor in col (>=1). If not specified, a default factor is computed automatically based on the output and input pixel sizes. DSFACTORROW is the fraction downsampling factor in row (>=1). If not specified, default to the value of DSFACTORCOL.
Sorting Method
The order in which the images is sorted and added to the mosaic.
Starting Image
When you select Nearest to Center or Maximum Intersection for Sort Method, the first image to add to the mosaic.
If you do not specify a starting image, the image that is most central is processed first.
When you select None for Sorting Method, this parameter is ignored.
Normalization Method
The normalization to apply to each source image before color balancing, cutline generation, or mosaicking.
When Hot Spot is selected as the normalization method, hot spots are removed from the images by normalizing the brightness over the image by fitting a Gaussian surface to the brightness values. It does not remove the smaller spot reflections from lakes, cars, or buildings.
The adaptive filter adjusts the brightness and contrast over local areas, thereby improving image detail, while reducing the bright-and-dark pattern over the entire image. It applies an adaptive enhancement using a moving window to calculate the adjustment for each pixel value. The filter calculates the mean and standard deviation of the gray levels within the window and adjusts the values to match the overall mean and standard deviation of the image. The mean is used to adjust the brightness and the standard deviation is used to adjust the contrast.
Normalization Method Extra Options
When you select Adaptive for Normalization Method, you can define additional options for normalization.
To define the filter size for the adaptive normalization, enter the image_percent value to use
The default is 20 (20 percent).
Color Balancing Method
The color-balancing method to apply to the final mosaic.
Color balancing evens out the color contrasts from one image to another to reduce the visibility of the seams and produce a visually appealing mosaic. All color-balancing methods (except None) result in some parameters that define an adjustment of pixel values in the source image. The adjustments are applied when the image is added to the mosaic and stored as part of the mosaic project.
Color Balancing Extra Options
Additional color-balancing options. The options apply to the Bundle, LUT, Histogram, Reference, and Neighborhood color-balancing methods.
Autoscale can be specified for all input images to be stretched linearly and have a common scale. This can improve the results when different input images have significantly different dynamic ranges.
LUT: <LUT_segment_number>
LUT_segment_numbers explicitly specify the LUT-segment numbers to use for color balancing. The first LUT is used for the first image channel, the second LUT for the second channel, and so on. All input images must have the specified LUT segments; otherwise processing of the job stops and a message detailing the event appears.
Reference: <fili_ref>
fili_ref specifies the reference image file
Global Color Balance Mask File
The file used to define a global color-balance mask, which identifies regions in the source images to omit from any color-balancing computation.
A global mask is useful when imagery contains, for example, massive water bodies. The global color-balance mask applies to all images in the mosaic project.
If you specify a value for this parameter, you must specify a value for Global Color Balance Mask Layer.
Global Color Balance Mask Layer
The layer in file specified for Global Color Balance Mask File that contains a global color-balance mask identifying regions in the source images to omit from any color-balancing computation.
Global Color Balance Mask Segment
When Specific Segment is selected for Global Color Balance Mask Layer, this parameter specifies the number of the segment that contains polygons or bitmaps to use to mask pixels during color-balancing calculations.
Cutline Method
The cutline method used to generate polygons that enclose all the data from an image to be included in the output mosaic.
Cutline Method Extra Options
Additional options for Cutline Method.
You can specify options related to constraining polygons, which define regions where cutlines are allowed for each image, so that the generated cutlines do not cross the specified boundaries.
Values you specify for this parameter take precedence over Auto Constrain and Factor.
[<vector_file>], [<field_name>], [<segment_number>]
If the field_name is not specified, MOSPREP searches the vector-segment attributes for a field named ImageSource. If the specified field name or ImageSource does not exist, an error occurs.
If the segment number is not specified, the algorithm uses the last segment from the vector file you specified. If the constraining polygon is larger than the image being processed, cutline generation is not constrained.
Auto Constrain
Select whether and how to automatically generate and apply constraint polygons when creating cutlines. Constraint polygons define regions where cutlines are allowed for each image, so that the generated cutlines do not cross the specified boundaries. You can opt to have them generated automatically based on the layout and arrangement of the images being mosaicked.
You can adjust the effect of Auto Constrain by specifying an appropriate percentage value for Factor.
When a constraining layer is specified for Cutline Method Extra Options, do not use Auto Constrain; that is, select No.
Factor
The Factor is a percentage by which to adjust effect of the Auto Constrain option.
This is a value between 1 and 100, with larger values causing more overlap between the generated constraint polygons; that is, the cutlines is less constrained.
Simplify Cutlines
Selected by default, this check box causes the module to simplify the cutlines for the mosaic. Simplification is to remove unsuitable vertices from the cutline shapes computed initially.
You can use this parameter in conjunction with Simplification Level to set the degree of simplification you want.
Simplification Level
Available when the Simplify Cutlines check box is selected, you can set the level of simplification you want to use.
When the Simpify Cutlines check box is clear, no simplification level is applied. When the check box is selected, a default value of 1.75 for Simplification Level is applied; otherwise, the value you specify is applied.
To create cutlines from all of the vertices computed initially, enter a value of 0. A number greater than zero increases the amount of vector reduction; the cutlines will have fewer vertices. Generally, a value of n results in 1/n of the vertices being computed. For example, a value of 2 results in approximately one half of the vertices.
Global Cutline Avoidance Mask File
The file that, in conjunction with Global Cutline Avoidance Mask Layer and Global Cutline Avoidance Mask Segment, can be used to identify common regions in all source images to omit from cutline calculations. When a global cutline-avoidance mask is used, the image pixels in the masked regions are excluded from the cutline calculations wherever possible; if there is no better area in which to place a cutline, the cutline passes through the masked region.
When you specify a value for this parameter, you must also specify a value for Global Cutline Avoidance Mask Layer.
Global Cutline Avoidance Mask Layer
The layer in the file specified for Global Cutline Avoidance Mask File to use as the global cutline-avoidance mask. When no value is specified for Global Cutline Avoidance Mask File, this parameter is ignored.
Global cutline-avoidance masks are used to restrict specific areas from cutline calculations; for example, to avoid cutlines crossing through buildings. When a global cutline-avoidance mask is used, the image pixels in the masked regions are excluded from the cutline calculations wherever possible; if there is no better area in which to place a cutline, the cutline passes through the masked region. A global cutline-avoidance mask applies to all source images that intersect the global mask layer.
Global Cutline Avoidance Mask Segment
When Specific Segment is selected for Global Cutline Avoidance Mask Layer, this parameter specifies the number of the segment that contains polygons or bitmaps to use to mask pixels to avoid when calculating cutlines.
Area of Interest File
A file that contains a single vector layer that defines the area to which the output mosaic is clipped.
The vector layer can contain one or more polygons.
Crop Tiles to AOI
Selected by default, this check box controls whether to crop the tiles to the area of interest (AOI) during processing.
Tile Base Name
The base name for file names of all tiles created during the mosaicking process.
Tile Specification
The tiling scheme to use for the output mosaic.
Height
The height of the mosaic tile, in pixels.The union of the extents of all of the source images is divided into a series of evenly sized and abutting rectangular tiles with the specified dimension.
Only tiles that actually intersect at least one of the source images is present in the output. The tiles at the far right and on the far bottom may overhang the extents of the source images. This is done to ensure that all tiles have the same dimensions.
TileID values are generated using the convention <column_number>_<row_number>. For example, the upper-left tile always has a TileID of "1_1", while the one immediately below it is "1_2", and so on.
For example:
10000
Width
The width of the mosaic tile, in pixels.The union of the extents of all of the source images is divided into a series of evenly sized and abutting rectangular tiles with the specified dimension.
Only tiles that actually intersect at least one of the source images is present in the output. The tiles at the far right and on the far bottom may overhang the extents of the source images. This is done to ensure that all tiles have the same dimensions.
TileID values are generated using the convention <column_number>_<row_number>. For example, the upper-left tile always has a TileID of "1_1", while the one immediately below it is "1_2", and so on.
For example:
10000
Vertical Overlap
The vertical overlap of each tile, in pixels.
Horizontal Overlap
The horizontal overlap of each tile, in pixels.
Tile File
The name of the text file containing the tile-definition layer.Each line in the text file contains five elements separated by spaces: the first two define the upper-left coordinate in the x and y dimension, respectively. The next two define the lower-right coordinate in the x and y dimensions, respectively. The last one specifies the output file name of the tile. If the file name includes an extension, the extension is removed when the value is stored as the 'TileID' attribute in the tile-definition polygon. If the file name includes a path, the entire path is transferred and appended to the output folder.
The RASEXT and RASOFFSZ coordinate types make use of pixel/line raster, as defined by the union of the extents of all input source images. If a coordinate type is not specified, it is assumed to be GEOEXT. For example:
Segment Number
In the tile file you specified, the number of the vector segment to use. If no segment number is specified, the last segment in the specified tile file is used.Field Name
Name of the field (attribute) that has unique identifiers for each tile. The module uses the values in the field to form the names of the mosaic tile files. If no field name is specified, the attribute ShapeID is used.Coordinate Type
When Tile Specification is Script File, the type of coordinates in the script.
Blend Width
The perpendicular distance from the cutlines over which image blending occurs.
Image blending is to average the gray value of each pixel in the blending strip along a cutline from both overlapping input images. If no value is specified for this parameter, no blending is performed.
Create Source Map
Select this check box to create a source map on output along with the mosaic.
A source map is a polygon layer created and stored in a separate file, which contains an attribute that identifies the predominant source input image used for each pixel in the output mosaic. As images are added to the mosaic, the source image is recorded in a separate raster, which is converted to a polygon layer at the end of the process.
The source map layer is created in a file with the same name as the output mosaic file(s), but with _SourceMap.pix appended to it.
Existing Tile Rule
Select an action to perform when an output tile already exists.
Available options are:
Skip: No change is made to the existing tile and no new processing is performed. This option is useful when you do not want to modify your existing mosaic output.
Delete Empty Tiles
Select whether to delete empty tiles. A tile is considered to be empty if all pixels in it have the value defined as NoData.
| 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:
Exterior orientation
The minimum EO information required is the photo ID (ID), the exposure position (x, y, z), and the orientation of the exposure platform (omega, phi, kappa).
The EO information must be in a format suitable for reading by PCI technology. It must be in one of several formats in a text file, as described in Data structure of aerial imagery, and stored in the scene folder with the file name eo.txt.
The EO information must be refined previously with a rigorous aerial triangulation. By doing so, it is assumed that the EO information is as accurate as required and, therefore, collection of neither ground control points (GCP) nor tie points (TP) is necessary.
For more information on EO, see Data structure of aerial imagery.
Camera calibration
Camera-calibration information must be stored in an XML file conforming to the PCI format, and have the file name camera_calib.xml; this file must be stored in the scene folder.
For more detailed information about camera-calibration parameters and format, see Data structure of aerial imagery.
Data structure
Data must be organized in the structure outlined in Data structure of aerial imagery.
Scene folder
The scene folder contains images from the same camera. This implies that the scene folder does not contain a mixture of RGB and PAN data, for example.
Format of ingested data
Data being ingested must be in TIFF (.tif), JPEG 2000 (.jp2), JPEG (.jpg), or PIX format (.pix).
Module details
The Mosaic from Level 3 Airphotos module imports aerial imagery from a frame-based airborne sensor and produces mosaic images as output.
Job results
For each Level 3 scene found in the input-scene folder, the Mosaic from Level 3 Airphotos module produces a series of output files in the specified output folder, depending on the options defined by the module parameters. For example, if you specified tiled output, the output folder will contain the mosaicked result in a series of tile files. The file names for the tiles are generated automatically according to the value specified for the Tile Base Name parameter.
© PCI Geomatics Enterprises, Inc.®, 2026. All rights reserved.