Class: QgsRasterLayerElevationProperties¶
- class qgis.core.QgsRasterLayerElevationProperties¶
Bases:
QgsMapLayerElevationProperties
Raster layer specific subclass of
QgsMapLayerElevationProperties
.New in version 3.26.
QgsRasterLayerElevationProperties(parent: QObject) Constructor for
QgsRasterLayerElevationProperties
, with the specifiedparent
object.Methods
Returns the band number from which the elevation should be taken.
- param layer:
- rtype:
QgsRasterLayerElevationProperties
Copies common properties from another object.
Returns the elevation limit, which is used when
profileSymbology()
isQgis
.ProfileSurfaceSymbology.FillBelow orQgis
.ProfileSurfaceSymbology.FillAbove to limit the fill to a specific elevation range.Returns the elevation range corresponding to a raw pixel value from the specified
band
.Returns the fixed elevation range for the raster.
Returns the fixed elevation range for each band.
- rtype:
bool
- rtype:
str
Returns
True
if the elevation properties are enabled, i.e. the raster layer values represent an elevation surface.- param range:
Returns
True
if a rasterlayer
looks like a DEM.Returns the elevation mode.
Returns the fill symbol used to render the raster profile in elevation profile plots.
Returns the line symbol used to render the raster profile in elevation profile plots.
Returns the symbology option used to render the raster profile in elevation profile plots.
Reads common class properties from a DOM
element
previously written bywriteXml()
.- param element:
Sets the
band
number from which the elevation should be taken.Sets the elevation
limit
, which is used whenprofileSymbology()
isQgis
.ProfileSurfaceSymbology.FillBelow orQgis
.ProfileSurfaceSymbology.FillAbove to limit the fill to a specific elevation range.Sets whether the elevation properties are enabled, i.e. the raster layer values represent an elevation surface.
Sets the fixed elevation
range
for the raster.Sets the fixed elevation range for each band.
Sets the elevation
mode
.Sets the fill
symbol
used to render the raster profile in elevation profile plots.Sets the line
symbol
used to render the raster profile in elevation profile plots.Sets the
symbology
option used to render the raster profile in elevation profile plots.- rtype:
bool
Writes common class properties to a DOM
element
, to be used later withreadXml()
.- param element:
- bandNumber(self) int ¶
Returns the band number from which the elevation should be taken.
See also
- Return type:
int
- calculateZRange(self, layer: QgsMapLayer) QgsDoubleRange ¶
- Parameters:
layer (QgsMapLayer) –
- Return type:
- childEvent(self, QChildEvent)¶
- clone(self) QgsRasterLayerElevationProperties ¶
- Return type:
- connectNotify(self, QMetaMethod)¶
- copyCommonProperties(self, other: QgsMapLayerElevationProperties)¶
Copies common properties from another object.
New in version 3.26.
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- elevationLimit(self) float ¶
Returns the elevation limit, which is used when
profileSymbology()
isQgis
.ProfileSurfaceSymbology.FillBelow orQgis
.ProfileSurfaceSymbology.FillAbove to limit the fill to a specific elevation range.By default this is NaN, which indicates that there is no elevation limit.
See also
New in version 3.32.
- Return type:
float
- elevationRangeForPixelValue(self, band: int, pixelValue: float) QgsDoubleRange ¶
Returns the elevation range corresponding to a raw pixel value from the specified
band
.Returns an infinite range if the pixel value does not correspond to an elevation value.
New in version 3.38.
- Parameters:
band (int) –
pixelValue (float) –
- Return type:
- fixedRange(self) QgsDoubleRange ¶
Returns the fixed elevation range for the raster.
Note
When a fixed range is set any
zOffset()
andzScale()
is ignored.See also
New in version 3.38.
- Return type:
- fixedRangePerBand(self) Dict[int, QgsDoubleRange] ¶
Returns the fixed elevation range for each band.
Note
When a fixed range is set any
zOffset()
andzScale()
is ignored.See also
New in version 3.38.
- Return type:
Dict[int, QgsDoubleRange]
- hasElevation(self) bool ¶
- Return type:
bool
- htmlSummary(self) str ¶
- Return type:
str
- isEnabled(self) bool ¶
Returns
True
if the elevation properties are enabled, i.e. the raster layer values represent an elevation surface.See also
- Return type:
bool
- isSignalConnected(self, QMetaMethod) bool ¶
- isVisibleInZRange(self, range: QgsDoubleRange) bool ¶
- Parameters:
range (QgsDoubleRange) –
- Return type:
bool
- layerLooksLikeDem(layer: QgsRasterLayer) bool ¶
Returns
True
if a rasterlayer
looks like a DEM.This method applies some heuristics to
layer
to determine whether it looks like a candidate for a DEM layer.Specifically, it checks:
the layer’s name for DEM-like wording hints
whether the layer contains a single band
whether the layer contains an attribute table (if so, it’s unlikely to be a DEM)
the layer’s data type
New in version 3.32.
- Parameters:
layer (QgsRasterLayer) –
- Return type:
bool
- mode(self) Qgis.RasterElevationMode ¶
Returns the elevation mode.
See also
New in version 3.38.
- Return type:
- profileFillSymbol(self) QgsFillSymbol ¶
Returns the fill symbol used to render the raster profile in elevation profile plots.
See also
- Return type:
- profileLineSymbol(self) QgsLineSymbol ¶
Returns the line symbol used to render the raster profile in elevation profile plots.
See also
- Return type:
- profileSymbology(self) Qgis.ProfileSurfaceSymbology ¶
Returns the symbology option used to render the raster profile in elevation profile plots.
See also
- Return type:
- readCommonProperties(self, element: QDomElement, context: QgsReadWriteContext)¶
Reads common class properties from a DOM
element
previously written bywriteXml()
.See also
New in version 3.26.
- readXml(self, element: QDomElement, context: QgsReadWriteContext) bool ¶
- Parameters:
element (QDomElement) –
context (QgsReadWriteContext) –
- Return type:
bool
- receivers(self, PYQT_SIGNAL) int ¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setBandNumber(self, band: int)¶
Sets the
band
number from which the elevation should be taken.See also
- Parameters:
band (int) –
- setElevationLimit(self, limit: float)¶
Sets the elevation
limit
, which is used whenprofileSymbology()
isQgis
.ProfileSurfaceSymbology.FillBelow orQgis
.ProfileSurfaceSymbology.FillAbove to limit the fill to a specific elevation range.Set to NaN to indicate that there is no elevation limit.
See also
New in version 3.32.
- Parameters:
limit (float) –
- setEnabled(self, enabled: bool)¶
Sets whether the elevation properties are enabled, i.e. the raster layer values represent an elevation surface.
See also
- Parameters:
enabled (bool) –
- setFixedRange(self, range: QgsDoubleRange)¶
Sets the fixed elevation
range
for the raster.Note
When a fixed range is set any
zOffset()
andzScale()
is ignored.See also
New in version 3.38.
- Parameters:
range (QgsDoubleRange) –
- setFixedRangePerBand(self, ranges: Dict[int, QgsDoubleRange])¶
Sets the fixed elevation range for each band.
Note
When a fixed range is set any
zOffset()
andzScale()
is ignored.See also
New in version 3.38.
- Parameters:
ranges (Dict[int) –
- setMode(self, mode: Qgis.RasterElevationMode)¶
Sets the elevation
mode
.See also
New in version 3.38.
- Parameters:
mode (Qgis.RasterElevationMode) –
- setProfileFillSymbol(self, symbol: QgsFillSymbol)¶
Sets the fill
symbol
used to render the raster profile in elevation profile plots.Ownership of
symbol
is transferred to the plot.See also
- Parameters:
symbol (QgsFillSymbol) –
- setProfileLineSymbol(self, symbol: QgsLineSymbol)¶
Sets the line
symbol
used to render the raster profile in elevation profile plots.Ownership of
symbol
is transferred to the plot.See also
- Parameters:
symbol (QgsLineSymbol) –
- setProfileSymbology(self, symbology: Qgis.ProfileSurfaceSymbology)¶
Sets the
symbology
option used to render the raster profile in elevation profile plots.See also
- Parameters:
symbology (Qgis.ProfileSurfaceSymbology) –
- showByDefaultInElevationProfilePlots(self) bool ¶
- Return type:
bool
- timerEvent(self, QTimerEvent)¶
- writeCommonProperties(self, element: QDomElement, doc: QDomDocument, context: QgsReadWriteContext)¶
Writes common class properties to a DOM
element
, to be used later withreadXml()
.See also
New in version 3.26.
- writeXml(self, element: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) QDomElement ¶
- Parameters:
element (QDomElement) –
doc (QDomDocument) –
context (QgsReadWriteContext) –
- Return type:
QDomElement