[DOCS] Refactor RS_AddBandFromArray #964
Conversation
…DataValues from bands
| @@ -676,7 +676,7 @@ Introduction: Add a band to a raster from an array of doubles. | |||
|
|
|||
| Format: `RS_AddBandFromArray (raster: Raster, band: Array[Double])` | `RS_AddBandFromArray (raster: Raster, band: Array[Double], bandIndex:Int)` | `RS_AddBandFromArray (raster: Raster, band: Array[Double], bandIndex:Int, noDataValue:Double)` | |||
|
|
|||
| Since: `v1.4.1` | |||
| Since: `v1.5.0` | |||
There was a problem hiding this comment.
You can separate the new APIs and old APIs by
Additional APIs since `v1.5.0`
XXXX
There was a problem hiding this comment.
This change is not version dependent, if a user loads a raster with some other data type, and tries to add a band, they will be typecasted.
However, I changed the version because 1.5.0 onwards MakeEmptyRaster allows specifying data type.
Also, once we can control supplying version's docs from the backend right, I didn't think I would need to specify version wise anything in the documentation
docs/api/sql/Raster-operators.md
Outdated
| @@ -692,6 +692,9 @@ In order to remove an existing noDataValue from an existing band, pass null as t | |||
|
|
|||
| Note that: `bandIndex == RS_NumBands(raster) + 1` is an experimental feature and might not lead to the loss of raster metadata and properties such as color models. | |||
docs/api/sql/Raster-operators.md
Outdated
| @@ -692,6 +692,9 @@ In order to remove an existing noDataValue from an existing band, pass null as t | |||
|
|
|||
| Note that: `bandIndex == RS_NumBands(raster) + 1` is an experimental feature and might not lead to the loss of raster metadata and properties such as color models. | |||
|
|
|||
| !!!Note | |||
| RS_BandFromArray typecasts the double band values to the given datatype of the raster. This can lead to overflow values if values beyond the range of the raster's datatype are provided. | |||
There was a problem hiding this comment.
This should be RS_AddBandFromArray. What can users do to find the current data type in the raster?
There was a problem hiding this comment.
Pushed the mistake fix.
To get the data type for the given band, users can use RS_BandPixelType
There was a problem hiding this comment.
This file should not be added.
Did you read the Contributor Guide?
Is this PR related to a JIRA ticket?
[DOCS] my subject.What changes were proposed in this PR?
How was this patch tested?
Did this PR include necessary documentation updates?