Skip to main content
This sets the no data value for a specified band in the raster. If the band index is not provided, band 1 is assumed by default. Passing a null value for noDataValue will remove the no data value and that will ensure all pixels are included in functions rather than excluded as no data. Since v1.5.1, this function supports the ability to replace the current no-data value with the new noDataValue.
When replace is true, any pixels matching the provided noDataValue will be considered as no-data in the output raster.An IllegalArgumentException will be thrown if the input raster does not already have a no-data value defined. Replacing existing values with noDataValue requires a defined no-data baseline to evaluate against.To use this for no-data replacement, the input raster must first set its no-data value, which can then be selectively replaced via this function.

​
Signatures

RS_SetBandNoDataValue(raster: Raster, bandIndex: Integer, noDataValue: Double, replace: Boolean)

RS_SetBandNoDataValue(raster: Raster, bandIndex: Integer = 1, noDataValue: Double)

​
Parameters

​
raster
Raster
required
The input raster.
​
bandIndex
Integer
required
The band index value.
​
noDataValue
Double
required
The NoData value to use for pixels outside the raster extent.
​
replace
Boolean
The replace value.

​
Return type

The resulting raster.

​
Example

SELECT RS_BandNoDataValue(
        RS_SetBandNoDataValue(
            RS_MakeEmptyRaster(1, 20, 20, 2, 22, 2, 3, 1, 1, 0),
            -999
            )
        )

-999