Mosaic from Orthos module


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

Back to top

Description


The Mosaic from Orthos module reads the input-scenes folder for valid image scenes and creates an output mosaic from each scene found.
Back to top

Parameters


Name Caption
Input Scenes Input file, folder, or text file
Output Folder Output folder
NoData Value NoData value
Overwrite Results Overwrite existing results
Send Email Email notification settings
Output Channels Output channels
Output Background Value Output background value
Output File Type Output file type
Output File Options Output file options
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
Local Color Balance Mask Layer Local color-balancing mask layer
Local Color Balance Mask Segment Local color-balancing mask segment
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
Local Cutline Avoidance Mask Layer Local cutline-avoidance mask
Local Cutline Avoidance Mask Segment Local cutline-avoidance mask segment
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
Buffer Distance Size of buffer
Coordinate Type Type of coordinates in script
Tile Position Transformation Defines grid to align mosaic tiles
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
Resampling Method Resampling method
Back to top

Parameter descriptions

Input Scenes

The data to mosaic.

Input images can vary in projection, spatial resolution, or both. When the projection varies, the default output projection will be that which occurs most commonly in the input imagery.

You can specify the value of the parameter by using any of the following options:

When you use a text file, the following general rules apply:

Output Folder

The path and name of the folder to which to write the output files.

NoData Value

The background value of the input images.

A pixel you designate as NoData is excluded from normalization, color balancing, and cutline generation. Images often have NoData defined in their metadata so this parameter can be defaulted.

When you specify a text file as input, you can specify the NoData value of an image in the file. The NoData value specified in the input text file takes precedence over all other sources. When a value is not specified in the text file, precedence is applied to the NO_DATA_VALUE metadata tag of the input image. If NO_DATA_VALUE metadata exists for an input channel, its value is used; otherwise, the NO_DATA_VALUE at the file level is used. Finally, if a NoData value is available in neither the text file nor the metadata, you can specify the value for this parameter.

To summarize, the order of precedence for handling NoData is as follows:
  1. Text file
  2. Channel metadata
  3. File metadata
  4. NoData parameter value

If necessary, you can enter more than one NoData value for your input images. For example, to specify that channel 1 has a NoData value of -9999, channel 2 is 0, and channel 3 is 255, enter -9999,0,255.

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.

Output Channels

The output channels to receive the generated results.

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".

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.

Sorting Method

The order in which the images is sorted and added to the mosaic.

Available options are:

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.

The available normalization methods are as follows:

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.

The available color-balancing methods are as follows:

Color Balancing Extra Options

Additional color-balancing options. The options apply to the Bundle, LUT, Histogram, Reference, and Neighborhood color-balancing methods.

The available options, based on the color-balancing specification, are:

Local Color Balance Mask Layer

The layer in the input scene to use as the local color-balancing mask to exclude specified pixels from any color-balancing calculations.

Exclusion masks are useful where the same features appear radically different from one image to the other. When an exclusion mask is used for color balancing, image pixels within the masked regions are excluded from color-balancing calculations. A local exclusion mask applies only to the image that contains the mask layer.

Available options are:

Local Color Balance Mask Segment

When Specific Segment is specified for Local Color Balance Mask, this parameter specifies the number of the segment that contains polygons or bitmaps to be used to mask pixels to exclude from the color-balancing computations.

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.

Available options are:

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.

Supported methods are:

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.

With all options for Cutline Method, except File Extents, you can constrain the cutlines by specifying the following extra options:
[<vector_file>], [<field_name>], [<segment_number>]
Where:
The values in the attribute field, field_name, must correspond to the identity of one input source image. An input source image's identity is determined by:
  1. the value of its file level metadata tag: SourceID, or if that tag does not exist, then
  2. the base name, without the extension, of the input source image's file name.

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 select from:

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.

Local Cutline Avoidance Mask Layer

The layer in the input scene to use as the local cutline-avoidance mask.

A local cutline-avoidance mask is used to restrict specific areas from cutline calculations; for example, to avoid cutlines crossing through clouds. When used, the image pixels in the masked regions are excluded from the cutline calculations wherever possible; if no area is more suitable in which to place a cutline, the cutline passes through the masked region. A local cutline-avoidance mask applies only to the image that contains the mask layer.

Available options are:

Local Cutline Avoidance Mask Segment

When Specific Segment is selected for Local 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.

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.

Available options are:

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.

Note: The value for this parameter cannot be the same as that of Input Scene File.

Tile Specification

The tiling scheme to use for the output mosaic.

Available schemes are:

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.

Note: The Width parameter value is considered sacrosanct and is always honored. Thus, setting the Vertical Overlap to something other than zero causes the mosaic tile positions to be adjusted, rather than changing the tile widths.

Horizontal Overlap

The horizontal overlap of each tile, in pixels.

Note: The Height parameter value is considered sacrosanct and is always honored. Thus, setting the Horizontal Overlap to something other than zero causes the mosaic tile positions to be adjusted, rather than changing the tile heights.

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 values specified in the text file can be in one of these coordinate types:

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.

Buffer Distance

The distance, in the units of the vector-layer coordinates, by which to extend the polygons. That is, when a polygon abuts another, the buffer distance extends the polygon such that the mosaic pieces overlap by the specified distance.

Coordinate Type

When Tile Specification is Script File, the type of coordinates in the script.

You can select from the following:

Tile Position Transformation

With this parameter you can define a grid where each top-left corner of a tile is aligned to one of the vertices in the grid.

You specify this parameter by entering a keyword and either two or four values. The keyword indicates the relative positioning of the values:
After specifying the keyword, the general form of the remaining values is:

These values define the position of the corner or center in the raster grid.

Of the four values, only Stride_X is required. If not specified, Stride_Y defaults to the Stride_X value, and Ref_X and Ref_Y default to zero.

In the following example, the upper-left corner of the upper-left pixel of each tile is an even 20-meter multiple from the reference point (432345.000, 5438882.000). Depending on the distance of the tile from that point, its upper-left corner coordinate could be 432345.000, 432045.000, or any other multiple, but is never 432346.000 or 432355.000.

Example:

"CORNER, 20, 20, 432345.000, 5438882.000"

If specified, this parameter is applied in all scenarios, whether the image-corner coordinates come from the input file (MFILE), ULX and ULY, or through automatic computation.

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 polygon layer contains three attributes (fields):

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:

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.

Resampling Method

The resampling method to use during processing.

Available resampling options are:
Back to top

Details

General job details

The Mosaic from Orthos module provides a series of predefined configuration files that define the type of output to generate. These are defined in the settings.py file located in the PROHOME\exe\PGS\config folder of your CATALYST Enterprise installation. With the configuration file, you can specify whether the output file is a linked file (in PCIDSK format) or a standalone file.

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 Mosaic from Orthos module produces a mosaicked image product from the valid scenes in the specified input-scenes folder. This module is a workflow that chains together the Mosaic Preparation module and the Mosaic Generation module.

With this module, you can define how the output mosaic will be tiled (if at all), which channels to output, the name of the mosaic, the blend width, and the image-format type.

You can control the tiling of the mosaic by specifying an optional tile-definition file that defines the mosaic boundaries, tile boundaries, or both; that is, the tile-definition file can be a gridded file, where each cell in the grid represents a single output tile. Alternatively, you can also specify the number of tiles to produce in the x and y directions.

The Mosaic from Orthos module currently provides output to the GDB-supported file formats GeoTIFF, PCIDSK, and JPEG2000. For GeoTIFF files, the tiling scheme will not produce GeoTIFFs exceeding the GeoTIFF standard of 2 GB per image. If you suspect that the tiling scheme will produce GeoTIFF images that do not conform to the standard, select a different tiling scheme, or choose a different output-file format (PCIDSK, for example).

With the Mosaic from Orthos module, you can also specify the blend width (in pixels) to use when producing the image mosaic. Blending helps to reduce the appearance of seams by mixing the pixels values on either side of the cutline to achieve a gradual transition between the images. In areas containing bright or significantly different features, setting the blend width too high may cause "ghosting" or doubling of the features.

This module supports processing using GPUs and multi-core processors.

Job results

The Mosaic from Orthos module produces a series of output files or subfolders in the specified output folder, depending on the specified options. 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 specified tile base name.

Results produced by this module are written to subfolders created in the specified output folder, as follows:
  • mosprep: contains all results of the mosaic preparation process
  • mosgen: contains final output mosaic files
For more information on the results of each individual module in this workflow:

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