Mosaic Preparation module


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

Back to top

Description


The Mosaic Preparation module applies the color balancing, cutline generation, image normalization, and scene-order specification you define.
Back to top

Parameters


Name Caption
Input Scenes Input file, folder, or text file
Output Mosaic Project Mosaic project file to create
Output Map Units Output projection
NoData Value NoData value
Overwrite Results Overwrite existing results
Send Email Email notification settings
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
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 Mosaic Project

The name of the mosaic project file (.mos) to create.

An accompanying folder, with the same base name, is also created. The folder contains auxiliary information that makes up the mosaic project created by the mosaic-preparation process. Unique image IDs are created automatically based on the names of the source files and listed in the project file.

If you have an existing file of the same name, and you want to overwrite it, make sure the Overwrite Results check box is selected. All existing output folders and files will be overwritten.

You can open the output mosaic project in CATALYST Professional Mosaic Tool to enhance the mosaic and perform quality-control procedures.

Output Map Units

The projection of the output imagery.

The value of this parameter must be in the PCI Projection String format.

The standard definitions are:

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.

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.

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.

Back to top

Details

General job details

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 Preparation module prepares imagery for mosaicking by defining key elements, such as the sort order, automated normalization, automated color balancing, and automated cutline generation. The module creates a mosaic project file (.mos) and a folder of various other files. You can, if necessary, open the mosaic project file in CATALYST Professional Mosaic Tool to modify the mosaic prior to generating it.

With Mosaic Tool, you can modify color balancing, image normalization, sort order, and cutlines. The advantage of modifying your mosaic project with Mosaic Tool is that you can perfect it prior to generating the mosaic, thereby reducing the overall time and effort. The Mosaic Preparation module facilitates the process by reading previously orthorectified data and applying any normalization, color balancing, and cutline methods you specify to generate a mosaic project. You can then use the mosaic project as input with the Mosaic Generation module.

The first image serves as a "template" for mosaicking; specifically, the first channel. Each subsequent image that has a first channel that matches the bit depth of the first channel of the template is included in the mosaic. Images in which the bit depth of the first channel does not match the template are excluded. The number of channels in the mosaic will equal that of each valid input image of the same bit depth.

The sort order is important to the production of an image mosaic: it defines how images will be added to the mosaic, and the order thereof. Typically, the highest-quality images should be the top-most images in the output mosaic, with the lower-quality images at the bottom.

Color balancing is also important: without it, the final product will have a "patchwork" appearance, which may not be suitable as a final product. The Mosaic Preparation module provides several methods of color balancing to alleviate the effects of differences in gain and bias among the input imagery that can contribute to a patchwork mosaic.

When producing a mosaic, it is important to crop the images such that the best portions of the images are joined seamlessly. Cutlines are essentially polygons that outline the portion of the image or images to use in the mosaic. When the cropped images are added to the mosaic, the data in overlapping areas is covered by the most recent addition. Areas in which several images overlap provide more opportunities to find the best locations for cutlines. The Mosaic Preparation module provides several methods of automatically determining the best possible cutlines. Later, you can, if necessary, refine the cutlines in CATALYST Professional Mosaic Tool.

Because all the input images are processed collectively, the Mosaic Preparation module does not run in parallel on multiple computers; rather, it runs on a single computer and is always registered as a single job in the Job Processing System (JPS).

Job results

The following is an example of the output created for a mosaic project with Halifax specified as the name of the output mosaic project:

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