Class: QgsRasterFileWriterTask

QgsTask task which performs a QgsRasterFileWriter layer saving operation as a background task.

This can be used to save a raster layer out to a file without blocking the QGIS interface.

See also

QgsVectorFileWriterTask

See also

QgsVectorFileExporterTask

Class Hierarchy

Base classes

QgsTask	Abstract base class for long running background tasks.
QObject

Signals

errorOccurred	Emitted when an error occurs which prevented the file being written (or if the task is canceled).
writeComplete	Emitted when writing the layer is successfully completed.

class qgis.core.QgsRasterFileWriterTask

Bases: QgsTask

__init__(writer: QgsRasterFileWriter, pipe: QgsRasterPipe | None, columns: int, rows: int, outputExtent: QgsRectangle, crs: QgsCoordinateReferenceSystem)

Constructor for QgsRasterFileWriterTask. Takes a source writer, columns, rows, outputExtent and destination crs. Ownership of the pipe is transferred to the writer task, and will be deleted when the task completes.

Deprecated since version 3.8: Use version with transformContext instead.

Parameters:

• writer (QgsRasterFileWriter)

• pipe (Optional[QgsRasterPipe])

• columns (int)

• rows (int)

• outputExtent (QgsRectangle)

• crs (QgsCoordinateReferenceSystem)

__init__(writer: QgsRasterFileWriter, pipe: QgsRasterPipe | None, columns: int, rows: int, outputExtent: QgsRectangle, crs: QgsCoordinateReferenceSystem, transformContext: QgsCoordinateTransformContext)

Constructor for QgsRasterFileWriterTask. Takes a source writer, columns, rows, outputExtent, destination crs and coordinate transformContext . Ownership of the pipe is transferred to the writer task, and will be deleted when the task completes.

Parameters:

• writer (QgsRasterFileWriter)

• pipe (Optional[QgsRasterPipe])

• columns (int)

• rows (int)

• outputExtent (QgsRectangle)

• crs (QgsCoordinateReferenceSystem)

• transformContext (QgsCoordinateTransformContext)

signal errorOccurred(error: int, errorMessage: str)

Emitted when an error occurs which prevented the file being written (or if the task is canceled). The writing error will be reported and a errorMessage will be potentially set.

Added in version 3.10.

Parameters:

• error (int)

• errorMessage (str)

signal writeComplete(outputUrl: str)

Emitted when writing the layer is successfully completed. The outputUrl parameter indicates the file path for the written file(s).

Parameters:

outputUrl (str)