Class: QgsRasterPipe¶
-
class
qgis.core.
QgsRasterPipe
¶ Bases:
sip.wrapper
Constructor for QgsRasterPipe.
Base class for processing modules.
Enums
Methods
Test if interface at index may be switched on/off
Try to insert interface at specified index and connect if connection would fail, the interface is not inserted and
False
is returnedRemove and delete interface at given index if possible
Try to replace interface at specified index and connect if connection would fail, the interface is not inserted and
False
is returnedInsert a new known interface in default place or replace interface of the same role if it already exists.
Set interface at index on/off Returns
True
on successSignals
Attributes
-
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¶
-
brightnessFilter
(self) → QgsBrightnessContrastFilter¶
-
canSetOn
(self, idx: int, on: bool) → bool¶ Test if interface at index may be switched on/off
-
hueSaturationFilter
(self) → 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
-
last
(self) → QgsRasterInterface¶
-
nuller
(self) → QgsRasterNuller¶
-
projector
(self) → QgsRasterProjector¶
-
provider
(self) → 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
-
renderer
(self) → 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
-
resampleFilter
(self) → 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.
-
setOn
(self, idx: int, on: bool) → bool¶ Set interface at index on/off Returns
True
on success
-
size
(self) → int¶
-