Syntax

   @RasterNodata([REJECTABLE],<mode>[,<nodata_value>[,<replace_cell_values>]])

Arguments

   REJECTABLE

      Specifies if the function will supply a rejection code and message
      to the invalid feature and output it to the rejected port, or will
      fail upon being supplied invalid features.

      A feature can be rejected for the following reasons:
         - The feature has invalid geometry
         - The raster has no bands

   <mode>

      BAND | PALETTE | REMOVE

      A string that specifies whether the function will operate on the band
      level or the palette level, or will remove the nodata value.

   <nodata_value>

      Reals or Integers

      A numeric value specifying the nodata value to be set on the input raster.
      Optional if the <mode> is REMOVE.

   <replace_cell_values>

      ReplaceCellValues | DoNotReplaceCellValues

      The DoNotReplaceCellValues or ReplaceCellValues options specifying tagging
      the nodata value and optionally replacing the cell values as well when
      <mode> is set to BAND. If this parameter is not specified,
      DoNotReplaceCellValues is the default.

Description

   The @RasterNodata function is used to set or flag the nodata value on a
   raster's bands or palettes. The nodata value to be used should be specified
   in the <nodatavalue> parameter. The function operates on either the band
   level or the palette level depending on the value of the <mode> parameter.

   In BAND mode, the function sets the nodata value and discards the original
   nodata value if it exists. If a band has a palette, the function will succeed
   in setting a new nodata value only if the value is of a key that already
   exists. In this mode, the function supports tagging the nodata value and
   optionally replacing the cell values as well.

   In PALETTE mode, the function will succeed in setting the specified nodata
   value only if the input band(s) have at least one palette and a nodata key
   (on the band level) has already been set.

   In REMOVE mode, the function will remove any nodata classification from the
   raster's bands and palettes. The <nodata_value> parameter is optional in this
   mode of operation.

   Input features must contain raster geometries only.

   This function currently does not support full color models or string
   interpretations.

   If REJECTABLE parameter is specified, the feature to be rejected will be provided
   with fme_rejection_code.