Class: QgsMeshMultiLevelsAveragingMethod

Multi level averaging method specifies limits of vertical layers from the top layer down or reversed.

The limits will be truncated to the maximum number of vertical layers. To pick value from a single layer, specify the upper and lower limit to be the same

Added in version 3.12.

Class Hierarchy

Inheritance diagram of qgis.core.QgsMeshMultiLevelsAveragingMethod

Base classes

QgsMesh3DAveragingMethod

Abstract class for interpolating 3d stacked mesh data to 2d data.

Methods

countedFromTop

Returns whether the start and end vertical levels are indexed from top (surface) or bottom (bed) level

endVerticalLevel

Returns ending vertical level.

isSingleLevel

Returns whether the averaging method selects only a single vertical level

startVerticalLevel

Returns starting vertical level.

class qgis.core.QgsMeshMultiLevelsAveragingMethod[source]

Bases: QgsMesh3DAveragingMethod

__init__()

Constructs single level averaging method for 1st (top) vertical level

__init__(startLevel: int, endLevel: int, countedFromTop: bool)

Constructs multi level averaging method

Parameters:
  • startLevel (int) – starting vertical level index numbered from 1

  • endLevel (int) – ending vertical level index numbered from 1 (higher or equal than startLevel)

  • countedFromTop (bool) – if True, the startLevel index is counted from surface (index 1 is the top layer). if False, the startLevel index is counted from the bed level (index 1 is the bottom layer)

__init__(verticalLevel: int, countedFromTop: bool)

Constructs single level averaging method

Parameters:
  • verticalLevel (int) – vertical level index numbered from 1

  • countedFromTop (bool) – if True, the startLevel index is counted from surface (index 1 is the top layer). if False, the startLevel index is counted from the bed level (index 1 is the bottom layer)

__init__(a0: QgsMeshMultiLevelsAveragingMethod)
Parameters:

a0 (QgsMeshMultiLevelsAveragingMethod)

countedFromTop(self) bool[source]

Returns whether the start and end vertical levels are indexed from top (surface) or bottom (bed) level

Return type:

bool

endVerticalLevel(self) int[source]

Returns ending vertical level.

Numbered from 1. If countedFromTop(), 1 represents the top (surface) level, otherwise 1 represents the bottom (bed) level

Always lower or equal than endVerticalLevel()

Return type:

int

isSingleLevel(self) bool[source]

Returns whether the averaging method selects only a single vertical level

Return type:

bool

startVerticalLevel(self) int[source]

Returns starting vertical level.

Numbered from 1. If countedFromTop(), 1 represents the top (surface) level, otherwise 1 represents the bottom (bed) level

Always lower or equal than endVerticalLevel()

Return type:

int