24.1.11. Raster tools

24.1.11.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.

24.1.11.1.1. Parameters

Label

Nimi

Type

Kuvaus

Minimum extent to render (xmin, xmax, ymin, ymax)

EXTENT

[extent]

Specify the extent of the output raster layer. One of:

  • Use Canvas Extent

  • Select Extent on Canvas

  • Use Layer Extent…

It will internally be extended to a multiple of the tile size.

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…

The file encoding can also be changed here.

24.1.11.1.2. Tulokset

Label

Nimi

Type

Kuvaus

Output layer

OUTPUT

[raster]

Output raster layer

24.1.11.1.3. 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.

24.1.11.2. Create constant raster layer

Generates a raster layer where all pixels have the same value.

24.1.11.2.1. Parameters

Label

Nimi

Type

Kuvaus

Desired extent (xmin, xmax, ymin, ymax)

EXTENT

[extent]

Specify the extent of the output raster layer. One of:

  • Use Canvas Extent

  • Select Extent on Canvas

  • Use Layer Extent…

It will internally be extended to a multiple of the tile size.

Target CRS

TARGET_CRS

[crs]

Default: Project CRS

CRS for the output raster layer

Pixel size

PIXEL_SIZE

[number]

Default: 0.1

Pixel size (X=Y) in map units. Minimum value: 0.01

Constant value

NUMBER

[number]

Default: 1

Constant pixel value for the output raster layer.

Constant

OUTPUT

[raster]

Specification of the output raster. One of:

  • Save to a Temporary File

  • Save to File…

The file encoding can also be changed here.

24.1.11.2.2. Tulokset

Label

Nimi

Type

Kuvaus

Constant

OUTPUT

[raster]

Raster covering the desired extent with the specified pixel size and value.

24.1.11.2.3. Python code

Algorithm ID: qgis:createconstantrasterlayer

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.

24.1.11.3. Generate XYZ tiles (Directory)

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

24.1.11.3.1. Parameters

Label

Nimi

Type

Kuvaus

Extent (xmin, xmax, ymin, ymax)

EXTENT

[extent]

Specify the extent of the tiles. One of:

  • Use Canvas Extent

  • Select Extent on Canvas

  • Use Layer Extent…

It will internally be extended to a multiple of the tile size.

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…

The file encoding can also be changed here.

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…

24.1.11.3.2. Tulokset

Label

Nimi

Type

Kuvaus

Output directory

OUTPUT_DIRECTORY

[folder]

Output directory (for the tiles)

Output html (Leaflet)

OUTPUT_HTML

[html]

The output HTML (Leaflet) file

24.1.11.3.3. 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.

24.1.11.4. Generate XYZ tiles (MBTiles)

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

24.1.11.4.1. Parameters

Label

Nimi

Type

Kuvaus

Extent (xmin, xmax, ymin, ymax)

EXTENT

[extent]

Specify the extent of the tiles. One of:

  • Use Canvas Extent

  • Select Extent on Canvas

  • Use Layer Extent…

It will internally be extended to a multiple of the tile size.

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…

The file encoding can also be changed here.

24.1.11.4.2. Tulokset

Label

Nimi

Type

Kuvaus

Output file (for MBTiles)

OUTPUT_FILE

[file]

The output file.

24.1.11.4.3. 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.