25.1.13. Raster tools

25.1.13.1. Convert map to raster

Creates a raster image of map canvas content.

A map theme can be selected to render a predetermined set of layers with a defined style for each layer.

Alternatively, a single layer can be selected if no map theme is set.

If neither map theme nor layer is set, the current map content will be rendered. The minimum extent entered will internally be extended to be a multiple of the tile size.

Parameters

Label	Name	Type	Description
Minimum extent to render (xmin, xmax, ymin, ymax)	EXTENT	[extent]	Specify the extent of the output raster layer. It will internally be extended to a multiple of the tile size. Available methods are: Calculate from layer…: uses extent of a layer loaded in the current project Use map canvas extent Draw on canvas Enter the coordinates as xmin, xmax, ymin, ymax
Tile size	TILE_SIZE	[number] Default: 1024	Size of the tile of the output raster layer. Minimum value: 64.
Map units per pixel	MAP_UNITS_PER_PIXEL	[number] Default: 100.0	Pixel size (in map units). Minimum value: 0.0
Make background transparent	MAKE_BACKGROUND_TRANSPARENT	[boolean] Default: False	Allows exporting the map with a transparent background. Outputs an RGBA (instead of RGB) image if set to True.
Map theme to render Optional	MAP_THEME	[enumeration]	Use an existing map theme for the rendering.
Single layer to render Optional	LAYER	[enumeration]	Choose a single layer for the rendering
Output layer	OUTPUT	[raster] Default: [Save to temporary file]	Specification of the output raster. One of: Save to a Temporary File Save to File…

Outputs

Label	Name	Type	Description
Output layer	OUTPUT	[raster]	Output raster layer

Python code

Algorithm ID: qgis:rasterize

import processing
processing.run("algorithm_id", {parameter_dictionary})

The algorithm id is displayed when you hover over the algorithm in the Processing Toolbox. The parameter dictionary provides the parameter NAMEs and values. See Using processing algorithms from the console for details on how to run processing algorithms from the Python console.

25.1.13.2. Fill NoData cells

Resets the NoData values in the input raster to a chosen value, resulting in raster dataset with no NoData pixels.

The algorithm respects the input raster data type, e.g. a floating point fill value will be truncated when applied to an integer raster.

Fig. 25.30 Filling NoData values (in grey) of a raster

Parameters

Label	Name	Type	Description
Input raster	INPUT	[raster]	The raster to process.
Band number	BAND	[number] Default: 1	The band of the raster
Fill value	FILL_VALUE	[number] Default: 1.0	Set the value to use for the NoData pixels
Output raster	OUTPUT	[raster] Default: [Save to temporary file]	Specification of the output raster. One of: Save to a Temporary File Save to File…

Outputs

Label	Name	Type	Description
Output raster	OUTPUT	[raster]	The output raster layer with filled data cells.

Python code

Algorithm ID: native:fillnodata

import processing
processing.run("algorithm_id", {parameter_dictionary})

The algorithm id is displayed when you hover over the algorithm in the Processing Toolbox. The parameter dictionary provides the parameter NAMEs and values. See Using processing algorithms from the console for details on how to run processing algorithms from the Python console.

25.1.13.3. Generate XYZ tiles (Directory)

Generates raster “XYZ” tiles using the current QGIS project as individual images to a directory structure.

Parameters

Label	Name	Type	Description
Extent (xmin, xmax, ymin, ymax)	EXTENT	[extent]	Specify the extent of the tiles. It will internally be extended to a multiple of the tile size. Available methods are: Calculate from layer…: uses extent of a layer loaded in the current project Use map canvas extent Draw on canvas Enter the coordinates as xmin, xmax, ymin, ymax
Minimum zoom	ZOOM_MIN	[number] Default: 12	Minimum 0, maximum 25.
Maximum zoom	ZOOM_MAX	[number] Default: 12	Minimum 0, maximum 25.
DPI	DPI	[number] Default: 96	Minimum 48, maximum 600.
Background color Optional	BACKGROUND_COLOR	[color] Default: QColor(0, 0, 0, 0)	Choose the background color for the tiles
Tile format	TILE_FORMAT	[enumeration] Default: 0	One of: 0 — PNG 1 — JPG
Quality (JPG only) Optional	QUALITY	[number] Default: 75	Minimum 1, maximum 100.
Metatile size Optional	METATILESIZE	[number] Default: 4	Specify a custom metatile size when generating XYZ tiles. Larger values may speed up the rendering of tiles and provide better labelling (fewer gaps without labels) at the expense of using more memory. Minimum 1, maximum 20.
Tile width Optional	TILE_WIDTH	[number] Default: 256	Minimum 1, maximum 4096.
Tile height Optional	TILE_HEIGHT	[number] Default: 256	Minimum 1, maximum 4096.
Use inverted tile Y axis (TMS conventions) Optional	TMS_CONVENTION	[boolean] Default: False
Output directory	OUTPUT_DIRECTORY	[folder] Default: [Save to temporary folder]	Specification of the output raster. One of: Skip Output Save to a Temporary Directory Save to Directory
Output html (Leaflet)	OUTPUT_HTML	[html] Default: [Save to temporary file]	Specification of the output HTML file. One of: Skip Output Save to a Temporary File Save to File…

Outputs

Label	Name	Type	Description
Output directory	OUTPUT_DIRECTORY	[folder]	Output directory (for the tiles)
Output html (Leaflet)	OUTPUT_HTML	[html]	The output HTML (Leaflet) file

Python code

Algorithm ID: qgis:tilesxyzdirectory

import processing
processing.run("algorithm_id", {parameter_dictionary})

The algorithm id is displayed when you hover over the algorithm in the Processing Toolbox. The parameter dictionary provides the parameter NAMEs and values. See Using processing algorithms from the console for details on how to run processing algorithms from the Python console.

25.1.13.4. Generate XYZ tiles (MBTiles)

Generates raster “XYZ” tiles using the current QGIS project as a single file in the “MBTiles” format.

Parameters

Label	Name	Type	Description
Extent (xmin, xmax, ymin, ymax)	EXTENT	[extent]	Specify the extent of the tiles. It will internally be extended to a multiple of the tile size. Available methods are: Calculate from layer…: uses extent of a layer loaded in the current project Use map canvas extent Draw on canvas Enter the coordinates as xmin, xmax, ymin, ymax
Minimum zoom	ZOOM_MIN	[number] Default: 12	Minimum 0, maximum 25.
Maximum zoom	ZOOM_MAX	[number] Default: 12	Minimum 0, maximum 25.
DPI	DPI	[number] Default: 96	Minimum 48, maximum 600.
Background color Optional	BACKGROUND_COLOR	[color] Default: QColor(0, 0, 0, 0)	Choose the background color for the tiles
Tile format	TILE_FORMAT	[enumeration] Default: 0	One of: 0 — PNG 1 — JPG
Quality (JPG only) Optional	QUALITY	[number] Default: 75	Minimum 1, maximum 100.
Metatile size Optional	METATILESIZE	[number] Default: 4	Specify a custom metatile size when generating XYZ tiles. Larger values may speed up the rendering of tiles and provide better labelling (fewer gaps without labels) at the expense of using more memory. Minimum 1, maximum 20.
Output file (for MBTiles)	OUTPUT_FILE	[file] Default: [Save to temporary file]	Specification of the output file. One of: Skip Output Save to a Temporary File Save to File…

Outputs

Label	Name	Type	Description
Output file (for MBTiles)	OUTPUT_FILE	[file]	The output file.

Python code

Algorithm ID: qgis:tilesxyzmbtiles

import processing
processing.run("algorithm_id", {parameter_dictionary})

The algorithm id is displayed when you hover over the algorithm in the Processing Toolbox. The parameter dictionary provides the parameter NAMEs and values. See Using processing algorithms from the console for details on how to run processing algorithms from the Python console.