Class: QgsRasterPyramid¶
This struct is used to store pyramid info for the raster layer.
Methods
Returns |
|
Returns |
|
Returns the pyramid level. |
|
Returns the x dimension for this pyramid layer. |
|
Returns the y dimension for this pyramid layer. |
|
Sets whether the pyramid layer will be built. |
|
Sets whether the pyramid layer currently exists. |
|
Sets the pyramid level. |
|
Sets the x dimension for this pyramid layer. |
|
Sets the y dimension for this pyramid layer. |
- class qgis.core.QgsRasterPyramid[source]¶
Bases:
object
- property build¶
Returns
True
if the pyramid layer will be built.When used with
QgsRasterDataProvider.buildPyramids()
this flag controls whether pyramids will be built for the layer.Added in version 3.20.
- Return type:
bool
- property exists¶
Returns
True
if the pyramid layer currently exists.Added in version 3.20.
- Return type:
bool
- getBuild(self) bool [source]¶
Returns
True
if the pyramid layer will be built.When used with
QgsRasterDataProvider.buildPyramids()
this flag controls whether pyramids will be built for the layer.Added in version 3.20.
- Return type:
bool
- getExists(self) bool [source]¶
Returns
True
if the pyramid layer currently exists.Added in version 3.20.
- Return type:
bool
- getLevel(self) int [source]¶
Returns the pyramid level.
Pyramid levels are as defined by GDAL, eg level 2 is half the original raster size.
Added in version 3.20.
- Return type:
int
- getXDim(self) int [source]¶
Returns the x dimension for this pyramid layer.
Added in version 3.20.
- Return type:
int
- getYDim(self) int [source]¶
Returns the y dimension for this pyramid layer.
Added in version 3.20.
- Return type:
int
- property level¶
Returns the pyramid level.
Pyramid levels are as defined by GDAL, eg level 2 is half the original raster size.
Added in version 3.20.
- Return type:
int
- setBuild(self, build: bool)[source]¶
Sets whether the pyramid layer will be built.
When used with
QgsRasterDataProvider.buildPyramids()
this flag controls whether pyramids will be built for the layer. Set toTrue
to build the pyramids.Added in version 3.20.
- Parameters:
build (bool)
- setExists(self, exists: bool)[source]¶
Sets whether the pyramid layer currently exists.
Added in version 3.20.
- Parameters:
exists (bool)
- setLevel(self, level: int)[source]¶
Sets the pyramid
level
.Pyramid levels are as defined by GDAL, eg level 2 is half the original raster size.
Added in version 3.20.
- Parameters:
level (int)
- setXDim(self, dimension: int)[source]¶
Sets the x
dimension
for this pyramid layer.Added in version 3.20.
- Parameters:
dimension (int)
- setYDim(self, dimension: int)[source]¶
Sets the y
dimension
for this pyramid layer.Added in version 3.20.
- Parameters:
dimension (int)
- property xDim¶
Returns the x dimension for this pyramid layer.
Added in version 3.20.
- Return type:
int
- property yDim¶
Returns the y dimension for this pyramid layer.
Added in version 3.20.
- Return type:
int