Subgroup: Raster
Class: QgsRasterPipe¶
-
class
qgis.core.
QgsRasterPipe
¶ Bases:
sip.wrapper
Constructor for QgsRasterPipe.
Base class for processing modules.
Methods
at
brightnessFilter
canSetOn
Test if interface at index may be swithed on/off hueSaturationFilter
insert
Try to insert interface at specified index and connect if connection would fail, the interface is not inserted and false is returned * last
nuller
projector
provider
remove
Remove and delete interface at given index if possible renderer
replace
Try to replace interface at specified index and connect if connection would fail, the interface is not inserted and false is returned * resampleFilter
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
Signals
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¶
-
brightnessFilter
(self) → QgsBrightnessContrastFilter¶
-
canSetOn
(self, idx: int, on: bool) → bool¶ Test if interface at index may be swithed 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¶
-