Class: QgsRasterPyramid¶
- class qgis.core.QgsRasterPyramid¶
Bases:
sip.wrapper
This struct is used to store pyramid info for the raster layer.
Methods
Returns
True
if the pyramid layer will be built.Returns
True
if the pyramid layer currently exists.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.- property build¶
getBuild(self) -> bool 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.New in version 3.20.
- Return type
bool
- property exists¶
getExists(self) -> bool Returns
True
if the pyramid layer currently exists.New in version 3.20.
- Return type
bool
- getBuild(self) bool ¶
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.New in version 3.20.
- Return type
bool
- getExists(self) bool ¶
Returns
True
if the pyramid layer currently exists.New in version 3.20.
- Return type
bool
- getLevel(self) int ¶
Returns the pyramid level.
Pyramid levels are as defined by GDAL, eg level 2 is half the original raster size.
New in version 3.20.
- Return type
int
- getXDim(self) int ¶
Returns the x dimension for this pyramid layer.
New in version 3.20.
- Return type
int
- getYDim(self) int ¶
Returns the y dimension for this pyramid layer.
New in version 3.20.
- Return type
int
- property level¶
getLevel(self) -> int Returns the pyramid level.
Pyramid levels are as defined by GDAL, eg level 2 is half the original raster size.
New in version 3.20.
- Return type
int
- setBuild(self, build: bool)¶
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.New in version 3.20.
- Parameters
build (bool) –
- setExists(self, exists: bool)¶
Sets whether the pyramid layer currently exists.
New in version 3.20.
- Parameters
exists (bool) –
- setLevel(self, level: int)¶
Sets the pyramid
level
.Pyramid levels are as defined by GDAL, eg level 2 is half the original raster size.
New in version 3.20.
- Parameters
level (int) –
- setXDim(self, dimension: int)¶
Sets the x
dimension
for this pyramid layer.New in version 3.20.
- Parameters
dimension (int) –
- setYDim(self, dimension: int)¶
Sets the y
dimension
for this pyramid layer.New in version 3.20.
- Parameters
dimension (int) –
- property xDim¶
getXDim(self) -> int Returns the x dimension for this pyramid layer.
New in version 3.20.
- Return type
int
- property yDim¶
getYDim(self) -> int Returns the y dimension for this pyramid layer.
New in version 3.20.
- Return type
int