paleolimbot commented on code in PR #3114:
URL: https://github.com/apache/sedona/pull/3114#discussion_r3627334723


##########
docs/api/sql/Raster-Operators/RS_AsRaster.md:
##########
@@ -26,7 +26,7 @@ Introduction: `RS_AsRaster` converts a vector geometry into a 
raster dataset by
 * `pixelType`: Defines data type of the output raster. This can be one of the 
following, D (double), F (float), I (integer), S (short), US (unsigned short) 
or B (byte).
 * `allTouched` (Since: `v1.7.1`): Decides the pixel selection criteria. If set 
to `true`, the function selects all pixels touched by the geometry, else, 
selects only pixels whose centroids intersect the geometry. Defaults to `false`.
 * `value`: The value to be used for assigning pixels covered by the geometry. 
Defaults to using `1.0` if not provided.
-* `noDataValue`: Used for assigning the no data value of the resultant raster. 
Defaults to `null` if not provided.
+* `noDataValue`: Used for assigning the no data value of the resultant raster; 
pixels not covered by the geometry are set to this value. Defaults to `null` if 
not provided, in which case uncovered pixels are `0` and the raster has no no 
data value.

Review Comment:
   I agree with James' assessment of what the ideal behaviour is, although I 
also don't know the degree to which a nodata value is typically lifted from a 
reference (are there other functions where this happens? Or does GDAL do this 
in its command line tool for any operations?). In general I think GDAL's 
command line forces you to re-specify the nodata value frequently, perhaps this 
is intentional (to maybe maximize a safe nodata value that won't conflict with 
an actual value) or perhaps this is historical.
   
   It's possible to phase raster API changes in Sedona over a few 
versions...opt-in to new behaviour -> opt-out of new behaviour -> removed. This 
has some testing overhead during the transition but I think it will be positive 
for our Raster API to emerge as more consistent and easier to use (without just 
going through and breaking functions before we're sure).



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to