fmeobjects.FMERasterTools.createNodataMask

FMERasterTools.createNodataMask(nodataValue, realDataValue, raster, parms)

Creates a new band to represent the grouped single nodata value of all selected bands on the raster.

A cell is considered to be nodata when, for each selected band, the value for that cell is equal to that band’s nodata value. If any cell value is not equal to that band’s nodata value, the cell will be considered data.

The new band will be appended to the end of the raster. All selected bands are required to have a nodata value. The nodataValue and realDataValue tiles must be the same interpretation. The new band will be created with this interpretation.

Parameters:

  • nodataValue (FMETile) – Nodata value to set.

  • realDataValue (FMETile) – Data value to set.

  • raster (FMERaster) – The raster to create nodata mask.

  • parms (dict[str, str]) – (Optional) Name-value pairs, representing additional parameters.

Possible parms are :

kFME_CreateNodataMask_removeNodata

  • Yes or No (Default is No)

  • Specifies whether the nodata value should be removed from the selected bands after generating the mask.

Return type:

FMERaster

Returns:

The raster after creating nodata mask.

Raises:

FMEException – An exception is raised if an error occurred.