Water Colorization module

Description

The Water Colorization module assigns a fixed value to all of the pixels that are considered to be water.

Parameters

Name	Caption
Input Folder	Input folder
Output Folder	Output folder
Output File Type	Output file type
Output File Options	Output file options
Overwrite Results	Overwrite existing results
Water Body Mask Vector File	Input water body mask file name
Vector Segment	Input water body mask segment
Water Colorization Channels	Output image channels
Pixel Value	Mask pixel value

Parameter descriptions

Input Folder

The path of the folder containing mosaic tiles to process.

This parameter is mandatory.

Output Folder

The path of the folder in which to create the colorized output images.

This parameter is mandatory.

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.

Water Body Mask Vector File

The path and name of the vector file containing polygons that define the water bodies.

This parameter is mandatory.

Vector Segment

The vector segment containing polygons that define the water bodies.

This parameter is optional.

Water Colorization Channels

A comma-delimited list of the mosaic tile image channels to be output in the final process.

If no value is specified for this parameter, all channels are processed by default.

Pixel Value

The value of the pixels under the polygon for each band.

You can enter the values as a single number (applied to all input channels) or as a pixel "stack". If you enter a pixel stack, but the number of values does not equal the number of input channels, the list will be truncated or the last value will be repeated as necessary.

For example, if you specify a value of 65535,0,0,0,0, all the pixels under the water polygons will be pure blue.

This parameter is optional.

Details

General job details

Preprocessing requirements

Before running the job, and for it to complete successfully, the following requirements must be met:

The value assigned for the water pixels should be compatible with the radiometric resolution of the input imagery (mosaic tiles). For example, if the source imagery is 8-bit unsigned, the valid values are any between 0 and 255.

Module details

You can use the Water Colorization module to assign a uniform color to all the water bodies in an image or a mosaic tile. Water bodies are defined by polygons in the specified water body mask vector file. The parameter Pixel Value defines the color assigned to the pixels beneath the water body mask polygons.

Job results

For each image in the specified input folder, the Water Colorization module creates a new image in which all of the water pixels are of the same color.