RS_DimNames¶

Returns the ordered list of dimension names for a raster band.

Usage¶

list<utf8> RS_DimNames(rast: raster)
list<utf8> RS_DimNames(rast: raster, band: int)

Arguments¶

rast (raster): Input raster
band (int): Band index (1-based). A null or out-of-range index returns null.

[!WARNING]

Experimental. This function is experimental; its behavior may change without notice.

Description¶

Returns the ordered list of dimension names for a raster band. Standard 2D rasters have dimensions ["y", "x"]. N-dimensional rasters may include additional dimensions such as time, pressure, wavelength, etc.

The dimension names correspond to the entries in RS_Shape — the i-th name matches the i-th size.

When the band index is omitted, all bands must agree on their dimension names; if they disagree, an error is returned prompting the user to specify a band index.

Examples¶

SELECT RS_DimNames(RS_Example());

┌───────────────────────────┐
│ rs_dimnames(rs_example()) │
│            list           │
╞═══════════════════════════╡
│ [y, x]                    │
└───────────────────────────┘