BURNMASK

Description

BURNMASK will burn a provided mask into provided rasters. The mask could be a vector polygon, a bitmap, or simply a rectangular window. The value to be burned can be a number provided or, when processing multiple rasters, can be multiple values.

Parameters

Name	Type	Length	Value range
Input: Original raster *	Raster port	1 - 1024
InputVEC: Polygon mask	Vector port	0 - 1
InputBIT: Bitmap mask	Bitmap port	0 - 1
Burn values *	Float	1 - 1024
INCLUS	String	0 - 1	Yes | No Default: Yes
Use current selection	Boolean	0 - 1
Output: Burned raster	Raster port	0 - 1024

* Required parameter

Parameter descriptions

Input: Original raster

Specifies the original rasters to be processed.

InputVEC: Polygon mask

Specifies the areas of the data to be processed. Specify the polygon segment that you want to use as a polygon mask. The masked pixels will be the ones within the provided polygons.

Only one of InputVec or InputBIT should be specified. If both are specified, an error will occur.

InputBIT: Bitmap mask

Specifies the areas of the data to be processed. Specify the bitmap segment that you want to use as a bitmap mask. All the pixels within the specified segment, having a pixel value of 1, define the area where input data must exist to be processed.

Only one of InputVec or InputBIT should be specified. If both are specified, an error will occur.

Burn values

Specifies numbers to burn to the input channels. Regardless of the type of mask you are using, you can always specify a single value to update all of the pixels under the provided mask to this number. You can provide the burn values as a single number (applied to all input channels) or as a pixel "stack". If you provide 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. With complex data, you must specify a pair of values for each channel as real and imaginary parts; otherwise, the last value will be repeated for the remaining parts of each channel.

INCLUS

Whether or not the mask is inclusive.

By default, only pixels inside of the mask will be burned, but if this parameter is set to "No" then mask is inverted automatically.

Use current selection

By default (when this check box is not selected), the entire input polygon mask is used to identify areas to process. When this check box is selected, only the areas covered by the currently selected polygons in the input polygon mask layer in Focus are used to identify areas to process.

Output: Burned raster

Optionally specifies the output channels to receive the burned raster.

Details

BURNMASK will alter pixels in a raster that are covered by the provided mask (that is, it burns a mask into a raster). The mask, which can be one of three types, will spatially dictate which pixels are to be affected. All pixels that are outside of the mask will be present in the output, unchanged. Any number of channels in the input raster can be processed.

When the mask is a bitmap or polygon layer it can be in a different projection than the input raster data and the mask will be reprojected on-the-fly to determine the pixels to alter.

In the simplest case, a single value specified using the BURNVAL (Burn Values) parameter will be written to the raster under the entire mask. If the value being burned is outside of the values of the raster's bit depth, an error will be generated. For example, if trying to burn a value of 500 into an 8U channel, BURNMASK will error and not create any output.

BURNMASK is aware of NoData values in the input raster. If a pixel is defined to be NoData via the NO_DATA_VALUE metadata tag, that pixel will not be adjusted even if it is covered by the provided mask (that is, any pixel that is NoData in the input will be in the output).