viz.raster_map

Draw a raster as a map: one band with a colour map, or three bands as RGB, optionally over a hillshade. Reads at the drawn size, from overviews when present.

Kind: standard
Network: no
Memory: 8Gi

Inputs🔗

Name	Type	Required	Default	Description
`raster`	file (GeoTIFF)	yes		Raster to draw.
`hillshade`	file (GeoTIFF)	no		Shaded relief drawn beneath the raster.
`style`	file (JSON)	no		A JSON document whose fields override the arguments below.
`band`	number	no	`1`	Band to draw.
`rgb_bands`	string	no	blank	Three bands to draw as RGB, e.g. "4,3,2". Overrides band.
`colormap`	string	no	`viridis`	matplotlib colour map name.
`stretch`	string	no	`minmax`	How values map to colours. One of `minmax`, `percent_clip`, `stddev`.
`nodata_color`	string	no	blank	Colour behind nodata pixels; blank leaves them white.
`legend`	boolean	no	`True`	Draw a colour bar.
`max_pixels`	number	no	`4096`	Longest edge, in pixels, the raster is read at.
`title`	string	no	blank	Chart title. ${item.key} labels each chart inside a map.
`width`	number	no	`8`	Figure width in inches.
`format`	string	no	`png`	Image format. html is a static, self-contained page. One of `png`, `svg`, `html`.

Outputs🔗

Name	Type	Description
`map`	file (PNG)	The map.

Example🔗

- id: "@raster_map"
  name: viz.raster_map
  inputs: [{block: "@dem", output: raster, as: raster}]
  args:
    colormap: terrain
    stretch: percent_clip
    title: Elevation