Class: QgsProcessingParameterAlignRasterLayers

A parameter for Processing algorithms specifying how rasters should be aligned.

A parameter for Processing algorithms that need a list of input raster layers to align - this parameter provides Processing framework’s adapter for QList<QgsAlignRaster.Item>.

A valid value for this parameter is a list (QVariantList), where each item is a map (QVariantMap) in this form:

{
  'inputFile':  string,
  'outputFile': string,
  'resampleMethod': int,
  'rescale': bool,
}

Also it can accept lists (either string lists or QgsMapLayer list) as well as individual layer object or string representing layer source.

Static functions parametersAsItems(), variantMapAsItem(), itemAsVariantMap() provide conversion between QgsAlignRaster.Item representation and QVariant representation.

Added in version 3.34.

Class Hierarchy

Inheritance diagram of qgis.core.QgsProcessingParameterAlignRasterLayers

Base classes

QgsProcessingParameterDefinition

Base class for the definition of processing parameters.

Static Methods

itemAsVariantMap

Converts a single input layer to QVariant representation (a QVariantMap)

parameterAsItems

Converts a QVariant value (a QVariantList) to a list of input layers

typeName

Returns the type name for the parameter class.

variantMapAsItem

Converts a QVariant value (a QVariantMap) to a single input layer
class qgis.core.QgsProcessingParameterAlignRasterLayers[source]

Bases: QgsProcessingParameterDefinition

__init__(name: str | None, description: str | None = '')

Constructor for QgsProcessingParameterAlignRasterLayers.

Parameters:

  • name (Optional[str])

  • description (Optional[str] = '')

__init__(a0: QgsProcessingParameterAlignRasterLayers)
Parameters:

a0 (QgsProcessingParameterAlignRasterLayers)

static itemAsVariantMap(item: QgsAlignRasterData.RasterItem) → Dict[str, Any][source]

Converts a single input layer to QVariant representation (a QVariantMap)

Parameters:

item (QgsAlignRasterData.RasterItem)

Return type:

Dict[str, Any]

static parameterAsItems(layersVariant: Any, context: QgsProcessingContext) → List[QgsAlignRasterData.RasterItem]

Converts a QVariant value (a QVariantList) to a list of input layers

Parameters:
Return type:

List[QgsAlignRasterData.RasterItem]

static typeName() → str[source]

Returns the type name for the parameter class.

Return type:

str

static variantMapAsItem(layerVariantMap: Dict[str, Any], context: QgsProcessingContext) → QgsAlignRasterData.RasterItem[source]

Converts a QVariant value (a QVariantMap) to a single input layer

Parameters:
Return type:

QgsAlignRasterData.RasterItem