Class: QgsRasterPipe

class qgis.core.QgsRasterPipe

Bases: sip.wrapper

Constructor for QgsRasterPipe.

Base class for processing modules.

Methods

at

param idx

brightnessFilter

rtype

QgsBrightnessContrastFilter

canSetOn

Test if interface at index may be switched on/off

hueSaturationFilter

rtype

QgsHueSaturationFilter

insert

Try to insert interface at specified index and connect if connection would fail, the interface is not inserted and False is returned

last

rtype

QgsRasterInterface

nuller

rtype

QgsRasterNuller

projector

rtype

QgsRasterProjector

provider

rtype

QgsRasterDataProvider

remove

Remove and delete interface at given index if possible

renderer

rtype

QgsRasterRenderer

replace

Try to replace interface at specified index and connect if connection would fail, the interface is not inserted and False is returned

resampleFilter

rtype

QgsRasterResampleFilter

set

Insert a new known interface in default place or replace interface of the same role if it already exists.

setOn

Set interface at index on/off Returns True on success

size

rtype

int

Attributes

BrightnessRole

HueSaturationRole

NullerRole

ProjectorRole

ProviderRole

RendererRole

ResamplerRole

UnknownRole

BrightnessRole = 3
HueSaturationRole = 7
NullerRole = 6
ProjectorRole = 5
ProviderRole = 1
RendererRole = 2
ResamplerRole = 4
class Role

Bases: int

UnknownRole = 0
at(self, idx: int) → QgsRasterInterface
Parameters

idx (int) –

Return type

QgsRasterInterface

brightnessFilter(self) → QgsBrightnessContrastFilter
Return type

QgsBrightnessContrastFilter

canSetOn(self, idx: int, on: bool) → bool

Test if interface at index may be switched on/off

Parameters
  • idx (int) –

  • on (bool) –

Return type

bool

hueSaturationFilter(self) → QgsHueSaturationFilter
Return type

QgsHueSaturationFilter

insert(self, idx: int, interface: QgsRasterInterface) → bool

Try to insert interface at specified index and connect if connection would fail, the interface is not inserted and False is returned

Parameters
Return type

bool

last(self) → QgsRasterInterface
Return type

QgsRasterInterface

nuller(self) → QgsRasterNuller
Return type

QgsRasterNuller

projector(self) → QgsRasterProjector
Return type

QgsRasterProjector

provider(self) → QgsRasterDataProvider
Return type

QgsRasterDataProvider

remove(self, idx: int) → bool

Remove and delete interface at given index if possible

remove(self, interface: QgsRasterInterface) -> bool Remove and delete interface from pipe if possible

Parameters

idx (int) –

Return type

bool

renderer(self) → QgsRasterRenderer
Return type

QgsRasterRenderer

replace(self, idx: int, interface: QgsRasterInterface) → bool

Try to replace interface at specified index and connect if connection would fail, the interface is not inserted and False is returned

Parameters
Return type

bool

resampleFilter(self) → QgsRasterResampleFilter
Return type

QgsRasterResampleFilter

set(self, interface: QgsRasterInterface) → bool

Insert a new known interface in default place or replace interface of the same role if it already exists. Known interfaces are: QgsRasterDataProvider, QgsRasterRenderer, QgsRasterResampleFilter, QgsRasterProjector and their subclasses. For unknown interfaces it mus be explicitly specified position where it should be inserted using insert() method.

Parameters

interface (QgsRasterInterface) –

Return type

bool

setOn(self, idx: int, on: bool) → bool

Set interface at index on/off Returns True on success

Parameters
  • idx (int) –

  • on (bool) –

Return type

bool

size(self) → int
Return type

int