Mosaic Update Preparation module


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

Back to top

Description


With the Mosaic Update Preparation module, you can automatically prepare an existing mosaic to be updated using new imagery. The output is a mosaic project (.mos) file, which describes the update process, and is similar to that produced by the Mosaic Preparation module.
Back to top

Parameters


Name Caption
New Scene Folder New input scenes folder
Existing Mosaic Folder Existing mosaic folder
Output Mosaic Project Mosaic project file to create
New Scene Order New scene order
NoData Value NoData value
Overwrite Results Overwrite existing results
Normalization Method Normalization method
Normalization Method Extra Options Normalization options
Color Balancing Reference Image Color-balancing reference image
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

New Scene Folder

The path and name of the folder containing new image scenes to add to the mosaic. The input imagery must conform to the preprocessing requirements.

Existing Mosaic Folder

The path and name of the folder containing the existing mosaic tiles to modify.

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.

New Scene Order

Select the order in which to add new image scenes to the mosaic.

You can select from the following:

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.

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 Reference Image

The path and file name of the low-resolution mosaic image file to use for color balancing. This file is located typically in the mosaic-preparation folder related to the initial mosaic generated, and the mosaic that is being updated.

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

With the Mosaic Update Preparation module, you can update an existing mosaic by adding new scenes or changing color-balancing and normalization options, among others. The output is a mosaic project (.mos) file, which you can use as input to the Mosaic Update Generation module.

The module does not run in parallel across multiple computers; rather, it runs on a single computer. It is always registered as a single job in the Job Processing System (JPS).

Job results

On successful job completion, the module creates a mosaic project (.mos) file, and auxiliary output files and folders. The output files are similar to those created by the Mosaic Preparation module. The files created refer only to tiles affected by the new scenes.

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