diff --git a/docs/api/sql/Raster-Band-Accessors/RS_Count.md b/docs/api/sql/Raster-Band-Accessors/RS_Count.md index ab4f07e0f2f..cfa9cfc1b39 100644 --- a/docs/api/sql/Raster-Band-Accessors/RS_Count.md +++ b/docs/api/sql/Raster-Band-Accessors/RS_Count.md @@ -30,11 +30,11 @@ Introduction: Returns the number of pixels in a given band. If band is not speci Format: -`RS_Count(raster: Raster, band: Integer = 1, excludeNoDataValue: Boolean = true)` +`RS_Count(raster: Raster)` `RS_Count(raster: Raster, band: Integer = 1)` -`RS_Count(raster: Raster)` +`RS_Count(raster: Raster, band: Integer = 1, excludeNoDataValue: Boolean = true)` Return type: `Long` diff --git a/docs/api/sql/Raster-Band-Accessors/RS_SummaryStats.md b/docs/api/sql/Raster-Band-Accessors/RS_SummaryStats.md index 1e5a1786b5e..32470ed3167 100644 --- a/docs/api/sql/Raster-Band-Accessors/RS_SummaryStats.md +++ b/docs/api/sql/Raster-Band-Accessors/RS_SummaryStats.md @@ -36,11 +36,11 @@ Introduction: Returns summary statistic for a particular band based on the `stat Formats: -`RS_SummaryStats(raster: Raster, statType: String, band: Integer = 1, excludeNoDataValue: Boolean = true)` +`RS_SummaryStats(raster: Raster, statType: String)` `RS_SummaryStats(raster: Raster, statType: String, band: Integer = 1)` -`RS_SummaryStats(raster: Raster, statType: String)` +`RS_SummaryStats(raster: Raster, statType: String, band: Integer = 1, excludeNoDataValue: Boolean = true)` Return type: `Double` diff --git a/docs/api/sql/Raster-Band-Accessors/RS_SummaryStatsAll.md b/docs/api/sql/Raster-Band-Accessors/RS_SummaryStatsAll.md index c2072595904..4bc4e224ee2 100644 --- a/docs/api/sql/Raster-Band-Accessors/RS_SummaryStatsAll.md +++ b/docs/api/sql/Raster-Band-Accessors/RS_SummaryStatsAll.md @@ -30,11 +30,11 @@ Introduction: Returns summary stats struct consisting of count, sum, mean, stdde Formats: -`RS_SummaryStatsAll(raster: Raster, band: Integer = 1, excludeNoDataValue: Boolean = true)` +`RS_SummaryStatsAll(raster: Raster)` `RS_SummaryStatsAll(raster: Raster, band: Integer = 1)` -`RS_SummaryStatsAll(raster: Raster)` +`RS_SummaryStatsAll(raster: Raster, band: Integer = 1, excludeNoDataValue: Boolean = true)` Return type: `Struct` diff --git a/docs/api/sql/Raster-Band-Accessors/RS_ZonalStats.md b/docs/api/sql/Raster-Band-Accessors/RS_ZonalStats.md index 66b46cbd68e..828865843db 100644 --- a/docs/api/sql/Raster-Band-Accessors/RS_ZonalStats.md +++ b/docs/api/sql/Raster-Band-Accessors/RS_ZonalStats.md @@ -53,11 +53,11 @@ The `allTouched` parameter (Since `v1.7.1`) determines how pixels are selected: Format: ``` -RS_ZonalStats(raster: Raster, zone: Geometry, band: Integer, statType: String, allTouched: Boolean, excludeNoData: Boolean, lenient: Boolean) +RS_ZonalStats(raster: Raster, zone: Geometry, statType: String) ``` ``` -RS_ZonalStats(raster: Raster, zone: Geometry, band: Integer, statType: String, allTouched: Boolean, excludeNoData: Boolean) +RS_ZonalStats(raster: Raster, zone: Geometry, band: Integer, statType: String) ``` ``` @@ -65,11 +65,11 @@ RS_ZonalStats(raster: Raster, zone: Geometry, band: Integer, statType: String, a ``` ``` -RS_ZonalStats(raster: Raster, zone: Geometry, band: Integer, statType: String) +RS_ZonalStats(raster: Raster, zone: Geometry, band: Integer, statType: String, allTouched: Boolean, excludeNoData: Boolean) ``` ``` -RS_ZonalStats(raster: Raster, zone: Geometry, statType: String) +RS_ZonalStats(raster: Raster, zone: Geometry, band: Integer, statType: String, allTouched: Boolean, excludeNoData: Boolean, lenient: Boolean) ``` Return type: `Double` diff --git a/docs/api/sql/Raster-Band-Accessors/RS_ZonalStatsAll.md b/docs/api/sql/Raster-Band-Accessors/RS_ZonalStatsAll.md index 4313831bc95..f577684f502 100644 --- a/docs/api/sql/Raster-Band-Accessors/RS_ZonalStatsAll.md +++ b/docs/api/sql/Raster-Band-Accessors/RS_ZonalStatsAll.md @@ -53,11 +53,11 @@ The `allTouched` parameter (Since `v1.7.1`) determines how pixels are selected: Format: ``` -RS_ZonalStatsAll(raster: Raster, zone: Geometry, band: Integer, allTouched: Boolean, excludeNodata: Boolean, lenient: Boolean) +RS_ZonalStatsAll(raster: Raster, zone: Geometry) ``` ``` -RS_ZonalStatsAll(raster: Raster, zone: Geometry, band: Integer, allTouched: Boolean, excludeNodata: Boolean) +RS_ZonalStatsAll(raster: Raster, zone: Geometry, band: Integer) ``` ``` @@ -65,11 +65,11 @@ RS_ZonalStatsAll(raster: Raster, zone: Geometry, band: Integer, allTouched: Bool ``` ``` -RS_ZonalStatsAll(raster: Raster, zone: Geometry, band: Integer) +RS_ZonalStatsAll(raster: Raster, zone: Geometry, band: Integer, allTouched: Boolean, excludeNodata: Boolean) ``` ``` -RS_ZonalStatsAll(raster: Raster, zone: Geometry) +RS_ZonalStatsAll(raster: Raster, zone: Geometry, band: Integer, allTouched: Boolean, excludeNodata: Boolean, lenient: Boolean) ``` Return type: `Struct` diff --git a/docs/api/sql/Raster-Operators/RS_AddBand.md b/docs/api/sql/Raster-Operators/RS_AddBand.md index a371ede52c7..9c0deacc3a4 100644 --- a/docs/api/sql/Raster-Operators/RS_AddBand.md +++ b/docs/api/sql/Raster-Operators/RS_AddBand.md @@ -32,7 +32,7 @@ If no `toRasterIndex` is provided, the new band is appended to the end of `toRas Format: ``` -RS_AddBand(toRaster: Raster, fromRaster: Raster, fromBand: Integer = 1, toRasterIndex: Integer = at_end) +RS_AddBand(toRaster: Raster, fromRaster: Raster) ``` ``` @@ -40,7 +40,7 @@ RS_AddBand(toRaster: Raster, fromRaster: Raster, fromBand: Integer = 1) ``` ``` -RS_AddBand(toRaster: Raster, fromRaster: Raster) +RS_AddBand(toRaster: Raster, fromRaster: Raster, fromBand: Integer = 1, toRasterIndex: Integer = at_end) ``` Return type: `Raster` diff --git a/docs/api/sql/Raster-Operators/RS_AsRaster.md b/docs/api/sql/Raster-Operators/RS_AsRaster.md index 7e5a8e8afa7..be0dd7aa293 100644 --- a/docs/api/sql/Raster-Operators/RS_AsRaster.md +++ b/docs/api/sql/Raster-Operators/RS_AsRaster.md @@ -32,11 +32,11 @@ Introduction: `RS_AsRaster` converts a vector geometry into a raster dataset by Format: ``` -RS_AsRaster(geom: Geometry, raster: Raster, pixelType: String, allTouched: Boolean, value: Double, noDataValue: Double, useGeometryExtent: Boolean) +RS_AsRaster(geom: Geometry, raster: Raster, pixelType: String) ``` ``` -RS_AsRaster(geom: Geometry, raster: Raster, pixelType: String, allTouched: Boolean, value: Double, noDataValue: Double) +RS_AsRaster(geom: Geometry, raster: Raster, pixelType: String, allTouched: Boolean) ``` ``` @@ -44,11 +44,11 @@ RS_AsRaster(geom: Geometry, raster: Raster, pixelType: String, allTouched: Boole ``` ``` -RS_AsRaster(geom: Geometry, raster: Raster, pixelType: String, allTouched: Boolean) +RS_AsRaster(geom: Geometry, raster: Raster, pixelType: String, allTouched: Boolean, value: Double, noDataValue: Double) ``` ``` -RS_AsRaster(geom: Geometry, raster: Raster, pixelType: String) +RS_AsRaster(geom: Geometry, raster: Raster, pixelType: String, allTouched: Boolean, value: Double, noDataValue: Double, useGeometryExtent: Boolean) ``` Return type: `Raster` diff --git a/docs/api/sql/Raster-Operators/RS_Clip.md b/docs/api/sql/Raster-Operators/RS_Clip.md index 0d49fb57d2d..7433f5e4850 100644 --- a/docs/api/sql/Raster-Operators/RS_Clip.md +++ b/docs/api/sql/Raster-Operators/RS_Clip.md @@ -37,11 +37,11 @@ The `allTouched` parameter (Since `v1.7.1`) determines how pixels are selected: Format: ``` -RS_Clip(raster: Raster, band: Integer, geom: Geometry, allTouched: Boolean, noDataValue: Double, crop: Boolean, lenient: Boolean) +RS_Clip(raster: Raster, band: Integer, geom: Geometry) ``` ``` -RS_Clip(raster: Raster, band: Integer, geom: Geometry, allTouched: Boolean, noDataValue: Double, crop: Boolean) +RS_Clip(raster: Raster, band: Integer, geom: Geometry, allTouched: Boolean) ``` ``` @@ -49,11 +49,11 @@ RS_Clip(raster: Raster, band: Integer, geom: Geometry, allTouched: Boolean, noDa ``` ``` -RS_Clip(raster: Raster, band: Integer, geom: Geometry, allTouched: Boolean) +RS_Clip(raster: Raster, band: Integer, geom: Geometry, allTouched: Boolean, noDataValue: Double, crop: Boolean) ``` ``` -RS_Clip(raster: Raster, band: Integer, geom: Geometry) +RS_Clip(raster: Raster, band: Integer, geom: Geometry, allTouched: Boolean, noDataValue: Double, crop: Boolean, lenient: Boolean) ``` Return type: `Raster` diff --git a/docs/api/sql/Raster-Operators/RS_Resample.md b/docs/api/sql/Raster-Operators/RS_Resample.md index 67ee3841f91..ce980aa0686 100644 --- a/docs/api/sql/Raster-Operators/RS_Resample.md +++ b/docs/api/sql/Raster-Operators/RS_Resample.md @@ -49,7 +49,7 @@ For more information about ScaleX, ScaleY, SkewX, SkewY, please refer to the [Af Format: ```sql -RS_Resample(raster: Raster, widthOrScale: Double, heightOrScale: Double, gridX: Double, gridY: Double, useScale: Boolean, algorithm: String) +RS_Resample(raster: Raster, referenceRaster: Raster, useScale: Boolean, algorithm: String) ``` ```sql @@ -57,7 +57,7 @@ RS_Resample(raster: Raster, widthOrScale: Double, heightOrScale: Double, useScal ``` ```sql -RS_Resample(raster: Raster, referenceRaster: Raster, useScale: Boolean, algorithm: String) +RS_Resample(raster: Raster, widthOrScale: Double, heightOrScale: Double, gridX: Double, gridY: Double, useScale: Boolean, algorithm: String) ``` Return type: `Raster` diff --git a/docs/api/sql/Raster-Operators/RS_SetBandNoDataValue.md b/docs/api/sql/Raster-Operators/RS_SetBandNoDataValue.md index 1fa1a11245a..360c1d19678 100644 --- a/docs/api/sql/Raster-Operators/RS_SetBandNoDataValue.md +++ b/docs/api/sql/Raster-Operators/RS_SetBandNoDataValue.md @@ -33,11 +33,11 @@ Since `v1.5.1`, this function supports the ability to replace the current no-dat Format: ``` -RS_SetBandNoDataValue(raster: Raster, bandIndex: Integer, noDataValue: Double, replace: Boolean) +RS_SetBandNoDataValue(raster: Raster, bandIndex: Integer = 1, noDataValue: Double) ``` ``` -RS_SetBandNoDataValue(raster: Raster, bandIndex: Integer = 1, noDataValue: Double) +RS_SetBandNoDataValue(raster: Raster, bandIndex: Integer, noDataValue: Double, replace: Boolean) ``` Return type: `Raster` diff --git a/docs/api/sql/Raster-Operators/RS_SetValues.md b/docs/api/sql/Raster-Operators/RS_SetValues.md index 4ef6121b60e..4a06d164853 100644 --- a/docs/api/sql/Raster-Operators/RS_SetValues.md +++ b/docs/api/sql/Raster-Operators/RS_SetValues.md @@ -30,11 +30,11 @@ to this function. Format without ROI `geom`: ``` -RS_SetValues(raster: Raster, bandIndex: Integer, colX: Integer, rowY: Integer, width: Integer, height: Integer, newValues: ARRAY[Double], keepNoData: Boolean = false) +RS_SetValues(raster: Raster, bandIndex: Integer, colX: Integer, rowY: Integer, width: Integer, height: Integer, newValues: ARRAY[Double]) ``` ``` -RS_SetValues(raster: Raster, bandIndex: Integer, colX: Integer, rowY: Integer, width: Integer, height: Integer, newValues: ARRAY[Double]) +RS_SetValues(raster: Raster, bandIndex: Integer, colX: Integer, rowY: Integer, width: Integer, height: Integer, newValues: ARRAY[Double], keepNoData: Boolean = false) ``` Return type: `Raster` @@ -60,7 +60,7 @@ The `allTouched` parameter (Since `v1.7.1`) determines how pixels are selected: Format with ROI `geom`: ``` -RS_SetValues(raster: Raster, bandIndex: Integer, geom: Geometry, newValue: Double, allTouched: Boolean = false, keepNoData: Boolean = false) +RS_SetValues(raster: Raster, bandIndex: Integer, geom: Geometry, newValue: Double) ``` ``` @@ -68,7 +68,7 @@ RS_SetValues(raster: Raster, bandIndex: Integer, geom: Geometry, newValue: Doubl ``` ``` -RS_SetValues(raster: Raster, bandIndex: Integer, geom: Geometry, newValue: Double) +RS_SetValues(raster: Raster, bandIndex: Integer, geom: Geometry, newValue: Double, allTouched: Boolean = false, keepNoData: Boolean = false) ``` SQL Example