Raster Constructors
These functions create raster objects from various file formats or from scratch.| Function | Return type | Description |
|---|---|---|
| RS_AsInDB | Raster | Converts an out-of-database (out-db) raster to an in-database (in-db) raster, facilitating raster data management within the database. |
| RS_AsRaster | Raster | Converts a Geometry to a Raster dataset. Unlike RS_Clip, which extracts a subset of an existing raster while preserving its original values, RS_AsRaster generates a new Raster where the Geomet… |
| RS_FromArcInfoAsciiGrid | Raster | Returns a raster geometry from an Arc Info Ascii Grid file. |
| RS_FromGeoTiff | Raster | Returns a raster geometry from a GeoTiff file. |
| RS_FromNetCDF | Raster | Returns a raster geometry representing the given record variable short name from a NetCDF file. This API reads the array data of the record variable in memory along with all its dimensions Since … |
| RS_FromPath | Raster | Returns an out-db raster from a path to an image file. Out-db rasters hold references to raster files instead of holding the actual pixel data. |
| RS_MakeEmptyRaster | Raster | Returns an empty raster geometry. Every band in the raster is initialized to 0.0. |
| RS_MakeRaster | Raster | Creates a raster from the given array of pixel values. The width, height, geo-reference information, and the CRS will be taken from the given reference raster. The data type of the resulting raster… |
| RS_NetCDFInfo | String | Returns a string containing names of the variables in a given netCDF file along with its dimensions. |
Raster Accessors
These functions extract metadata and properties from raster objects.| Function | Return type | Description |
|---|---|---|
| RS_BandPath | String | Retrieves the file path of an out-of-database (out-db) raster, providing a link to the external raster file it references. |
| RS_GeoReference | String | Returns the georeference metadata of raster as a string in GDAL or ESRI format. Default is GDAL if not specified. |
| RS_GeoTransform | Struct | Returns a struct of parameters that represent the GeoTransformation of the raster. The struct has the following schema: |
| RS_Height | Integer | Returns the height of the raster. |
| RS_MetaData | Array<Double> | Returns the metadata of the raster as a struct. The struct has the following schema: |
| RS_NumBands | Integer | Returns the number of the bands in the raster. |
| RS_RasterToWorldCoord | Geometry | Returns the upper left X and Y coordinates of the given row and column of the given raster geometric units of the geo-referenced raster as a Point geometry. If any out of bounds values are given, t… |
| RS_RasterToWorldCoordX | Double | Returns the upper left X coordinate of the given row and column of the given raster geometric units of the geo-referenced raster. If any out of bounds values are given, the X coordinate of the assu… |
| RS_RasterToWorldCoordY | Double | Returns the upper left Y coordinate of the given row and column of the given raster geometric units of the geo-referenced raster. If any out of bounds values are given, the Y coordinate of the assu… |
| RS_Rotation | Double | Returns the uniform rotation of the raster in radian. |
| RS_ScaleX | Double | Returns the pixel width of the raster in CRS units. |
| RS_ScaleY | Double | Returns the pixel height of the raster in CRS units. |
| RS_SkewX | Double | Returns the X skew or rotation parameter. |
| RS_SkewY | Double | Returns the Y skew or rotation parameter. |
| RS_UpperLeftX | Double | Returns the X coordinate of the upper-left corner of the raster. |
| RS_UpperLeftY | Double | Returns the Y coordinate of the upper-left corner of the raster. |
| RS_Width | Integer | Returns the width of the raster. |
| RS_WorldToRasterCoord | Geometry | Returns the grid coordinate of the given world coordinates as a Point. |
| RS_WorldToRasterCoordX | Integer | Returns the X coordinate of the grid coordinate of the given world coordinates as an integer. |
| RS_WorldToRasterCoordY | Integer | Returns the Y coordinate of the grid coordinate of the given world coordinates as an integer. |
Raster Band Accessors
These functions access band-level properties of raster objects.| Function | Return type | Description |
|---|---|---|
| RS_BandIsNoData | Boolean | Returns true if the band is filled with only nodata values. Band 1 is assumed if not specified. |
| RS_BandNoDataValue | Double | Returns the no data value of the given band of the given raster. If no band is given, band 1 is assumed. The band parameter is 1-indexed. If there is no data value associated with the given band, R… |
| RS_BandPixelType | String | Returns the datatype of each pixel in the given band of the given raster in string format. The band parameter is 1-indexed. If no band is specified, band 1 is assumed. |
Raster Spatial Reference System
These functions get and set the coordinate reference system of a raster.| Function | Return type | Description |
|---|---|---|
| RS_CRS | String | Returns the coordinate reference system (CRS) of the raster as a string in the specified format (projjson, wkt2, wkt1, proj). Defaults to PROJJSON. |
| RS_SRID | Integer | Returns the spatial reference system identifier (SRID) of the raster geometry. |
| RS_SetCRS | Raster | Sets the coordinate reference system (CRS) of the raster using a CRS definition string. Accepts EPSG codes, WKT1, WKT2, PROJ strings, and PROJJSON. |
| RS_SetSRID | Raster | Sets the spatial reference system identifier (SRID) of the raster geometry. |
Pixel Functions
These functions work with individual pixel geometry representations.| Function | Return type | Description |
|---|---|---|
| RS_PixelAsCentroid | Geometry | Returns the centroid (point geometry) of the specified pixel’s area. The pixel coordinates specified are 1-indexed. If colX and rowY are out of bounds for the raster, they are interpolated assu… |
| RS_PixelAsCentroids | Array<Struct> | Returns a list of the centroid point geometry, the pixel value and its raster X and Y coordinates for each pixel in the raster at the specified band. Each centroid represents the geometric center o… |
| RS_PixelAsPoint | Geometry | Returns a point geometry of the specified pixel’s upper-left corner. The pixel coordinates specified are 1-indexed. |
| RS_PixelAsPoints | Array<Struct> | Returns a list of the pixel’s upper-left corner point geometry, the pixel value and its raster X and Y coordinates for each pixel in the raster at the specified band. |
| RS_PixelAsPolygon | Geometry | Returns a polygon geometry that bounds the specified pixel. The pixel coordinates specified are 1-indexed. If colX and rowY are out of bounds for the raster, they are interpolated assuming the … |
| RS_PixelAsPolygons | Array<Struct> | Returns a list of the polygon geometry, the pixel value and its raster X and Y coordinates for each pixel in the raster at the specified band. |
| RS_Polygonize | Array<Struct<geom: Geometry, value: Double>> | Converts raster pixels into polygon geometries. For each connected region of pixels with the same value, returns a polygon geometry along with the pixel value. |
Raster Geometry Functions
These functions extract geometry representations from rasters.| Function | Return type | Description |
|---|---|---|
| RS_ConvexHull | Geometry | Return the convex hull geometry of the raster including the NoDataBandValue band pixels. For regular shaped and non-skewed rasters, this gives more or less the same result as RS_Envelope and hence … |
| RS_Envelope | Geometry | Returns the envelope of the raster as a Geometry. |
| RS_MinConvexHull | Geometry | Returns the min convex hull geometry of the raster excluding the NoDataBandValue band pixels, in the given band. If no band is specified, all the bands are considered when creating the min conv… |
Raster Predicates
These functions test spatial relationships involving raster objects.| Function | Return type | Description |
|---|---|---|
| RS_Contains | Boolean | Returns true if the geometry or raster on the left side contains the geometry or raster on the right side. The convex hull of the raster is considered in the test. |
| RS_DWithin | Boolean | Returns true if the raster or geometry on the left side is within distance meters of the raster or geometry on the right side. |
| RS_Intersects | Boolean | Returns true if raster or geometry on the left side intersects with the raster or geometry on the right side. The convex hull of the raster is considered in the test. |
| RS_Within | Boolean | Returns true if the geometry or raster on the left side is within the geometry or raster on the right side. The convex hull of the raster is considered in the test. |
Raster Operators
These functions perform operations on raster objects.| Function | Return type | Description |
|---|---|---|
| RS_AddBand | Raster | Adds a new band to a raster toRaster at a specified index toRasterIndex. The new band’s values are copied from fromRaster at a specified band index fromBand. If no toRasterIndex is provided… |
| RS_Band | Raster | Returns a new raster consisting 1 or more bands of an existing raster. It can build new rasters from existing ones, export only selected bands from a multiband raster, or rearrange the order of ban… |
| RS_Clip | Raster | Returns a raster that is clipped by the given geometry. |
| RS_Interpolate | Raster | This function performs interpolation on a raster using the Inverse Distance Weighted (IDW) method. This method estimates cell values by averaging the values of sample data points in the vicinity of… |
| RS_NormalizeAll | Raster | Normalizes values in all bands of a raster between a given normalization range. The function maintains the data type of the raster values by ensuring that the normalized values are cast back to the… |
| RS_ReplaceBandNoDataValue | Raster | Rewrites a band’s existing no-data pixels and updates its no-data value. |
| RS_ReprojectMatch | Raster | Reproject a raster to match the geo-reference, CRS, and envelope of a reference raster. The output raster always have the same extent and resolution as the reference raster. For pixels not covered … |
| RS_Resample | Raster | Resamples a raster using a given resampling algorithm and new dimensions (width and height), a new grid corner to pivot the raster at (gridX and gridY) and a set of georeferencing attributes (scale… |
| RS_SetBandNoDataValue | Raster | Sets or clears the band’s no-data metadata without changing pixel values. |
| RS_SetGeoReference | Raster | Sets the Georeference information of an object in a single call. Accepts inputs in GDAL and ESRI format. Default format is GDAL. If all 6 parameters are not provided then will return null. |
| RS_SetPixelType | Raster | Returns a modified raster with the desired pixel data type. |
| RS_SetValue | Raster | Returns a raster by replacing the value of pixel specified by colX and rowY. |
| RS_SetValues | Raster | Returns a raster by replacing the values of pixels in a specified rectangular region. The top left corner of the region is defined by the colX and rowY coordinates. The width and height par… |
| RS_Stack | Raster | Returns a combined multi-band raster from 2 or more input Rasters. The order of bands in the resultant raster will be in the order of the input rasters. For example if RS_Stack is called on two 2… |
| RS_Value | Double | Returns the value at the given point in the raster. If no band number is specified it defaults to 1. |
| RS_Values | Array<Double> | Returns the values at the given points or grid coordinates in the raster. If no band number is specified it defaults to 1. |
Raster Statistics
These functions compute statistics over raster bands, optionally within a zone geometry.| Function | Return type | Description |
|---|---|---|
| RS_Count | Long | Returns the number of pixels in a given band. If band is not specified then it defaults to 1. |
| RS_SummaryStats | Double | Returns summary statistic for a particular band based on the statType parameter. The function defaults to band index of 1 when band is not specified and excludes noDataValue if `excludeNoData… |
| RS_SummaryStatsAll | Struct | Returns summary stats struct consisting of count, sum, mean, stddev, min, max for a given band in raster. If band is not specified then it defaults to 1. |
| RS_ZonalStats | Double | This returns a statistic value specified by statType over the region of interest defined by zone. It computes the statistic from the pixel values within the ROI geometry and returns the result… |
| RS_ZonalStatsAll | Struct | Returns a struct of statistic values, where each statistic is computed over a region defined by the zone geometry. The struct has the following schema: |
| RS_ZonalStatsAllBands | Array<Struct<count, sum, mean, median, mode, stddev, variance, min, max>> | Computes zonal statistics for all bands of a raster in a single call, returning an array of structs. |
Raster Map Algebra
These functions convert between raster bands and arrays for map algebra operations.| Function | Return type | Description |
|---|---|---|
| RS_AddBandFromArray | Raster | Add a band to a raster from an array of doubles. |
| RS_BandAsArray | Array<Double> | Extract a band from a raster as an array of doubles. |
| RS_MapAlgebra | Raster | Apply a map algebra script on a raster. |
Map Algebra Operators
These functions perform per-pixel mathematical operations on raster band arrays.| Function | Return type | Description |
|---|---|---|
| RS_Add | Array<Double> | Add two spectral bands in a Geotiff image |
| RS_Array | Array<Double> | Create an array that is filled by the given value |
| RS_BitwiseAND | Array<Double> | Find Bitwise AND between two bands of Geotiff image |
| RS_BitwiseOR | Array<Double> | Find Bitwise OR between two bands of Geotiff image |
| RS_CountValue | Integer | Returns count of a particular value from a spectral band in a raster image |
| RS_Divide | Array<Double> | Divide band1 with band2 from a geotiff image |
| RS_FetchRegion | Array<Double> | Fetch a subset of region from given Geotiff image based on minimumX, minimumY, maximumX and maximumY index as well original height and width of image |
| RS_GreaterThan | Array<Double> | Mask all the values with 1 which are greater than a particular target value |
| RS_GreaterThanEqual | Array<Double> | Mask all the values with 1 which are greater than equal to a particular target value |
| RS_LessThan | Array<Double> | Mask all the values with 1 which are less than a particular target value |
| RS_LessThanEqual | Array<Double> | Mask all the values with 1 which are less than equal to a particular target value |
| RS_LogicalDifference | Array<Double> | Return value from band 1 if a value in band1 and band2 are different, else return 0 |
| RS_LogicalOver | Array<Double> | Return value from band1 if it’s not equal to 0, else return band2 value |
| RS_Mean | Double | Returns Mean value for a spectral band in a Geotiff image |
| RS_Mode | Array<Double> | Returns Mode from a spectral band in a Geotiff image in form of an array |
| RS_Modulo | Array<Double> | Find modulo of pixels with respect to a particular value |
| RS_Multiply | Array<Double> | Multiply two spectral bands in a Geotiff image |
| RS_MultiplyFactor | Array<Double> | Multiply a factor to a spectral band in a geotiff image |
| RS_Normalize | Array<Double> | Normalize the value in the array to [0, 255]. Uniform arrays are set to 0 after normalization. |
| RS_NormalizedDifference | Array<Double> | Returns Normalized Difference between two bands(band2 and band1) in a Geotiff image(example: NDVI, NDBI) |
| RS_SquareRoot | Array<Double> | Find Square root of band values in a geotiff image |
| RS_Subtract | Array<Double> | Subtract two spectral bands in a Geotiff image(band2 - band1) |
Raster Tiles
These functions split rasters into tiles.| Function | Return type | Description |
|---|---|---|
| RS_StackTileExplode | Struct | Stack a given array of rasters into a single raster and explode the stacked raster into multiple tiles. |
| RS_Tile | Array<Raster> | Returns an array of rasters resulting from the split of the input raster based upon the desired dimensions of the output rasters. |
| RS_TileExplode | Struct | Generates records containing raster tiles resulting from the split of the input raster based upon the desired dimensions of the output rasters. |
Raster Aggregate Functions
These functions perform aggregate operations on groups of rasters.| Function | Return type | Description |
|---|---|---|
| RS_Stack_Aggr | Raster | This function combines multiple rasters into a single multiband raster by stacking the bands of each input raster sequentially. The function arranges the bands in the output raster according to the… |
Raster Output
These functions convert raster data to various output formats for visualization.| Function | Return type | Description |
|---|---|---|
| RS_AsArcGrid | Binary | Returns a binary DataFrame from a Raster DataFrame. Each raster object in the resulting DataFrame is an ArcGrid image in binary format. |
| RS_AsBase64 | String | Returns a base64 encoded string of the given raster. If the datatype is integral then this function internally takes the first 4 bands as RGBA, and converts them to the PNG format, finally produces… |
| RS_AsCOG | Binary | Returns a Cloud Optimized GeoTiff (COG) binary from a raster. COG is a GeoTiff file format optimized for efficient cloud-based access, with internal tiling and overviews that enable partial reads over HTTP range requests. |
| RS_AsGeoTiff | Binary | Returns a binary DataFrame from a Raster DataFrame. Each raster object in the resulting DataFrame is a GeoTiff image in binary format. |
| RS_AsImage | String | Returns a HTML that when rendered using an HTML viewer or via a Jupyter Notebook, displays the raster as a square image of side length imageWidth. Optionally, an imageWidth parameter can be passe… |
| RS_AsMatrix | String | Returns a string, that when printed, outputs the raster band as a pretty printed 2D matrix. All the values of the raster are cast to double for the string. RS_AsMatrix allows specifying the number … |
| RS_AsPNG | Binary | Returns a PNG byte array, that can be written to raster files as PNGs. This function can only accept pixel data type of unsigned integer. |