Class: QgsMeshSigmaAveragingMethod

Sigma averages over the values between 0 (bed level) and 1 (surface).

The fractions will be truncated to 0-1. For example: the average of between a quarter and 3 quarters of the water column - Sigma from 0.25 to 0.75

Added in version 3.12.

Class Hierarchy

Inheritance diagram of qgis.core.QgsMeshSigmaAveragingMethod

Base classes

QgsMesh3DAveragingMethod

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

Methods

endFraction

Returns ending fraction.

startFraction

Returns starting fraction.

class qgis.core.QgsMeshSigmaAveragingMethod[source]

Bases: QgsMesh3DAveragingMethod

__init__()

Constructs the sigma method for whole value range 0-1

__init__(startFraction: float, endFraction: float)

Constructs the sigma method

Parameters:
  • startFraction (float) – starting fraction (0-1)

  • endFraction (float) – ending fraction, must be higher or equal than startFraction (0-1)

__init__(a0: QgsMeshSigmaAveragingMethod)
Parameters:

a0 (QgsMeshSigmaAveragingMethod)

endFraction(self) float[source]

Returns ending fraction.

In range 0-1, where 1 means the surface level and 0 bed level. Always higher or equal than startFraction()

Return type:

float

startFraction(self) float[source]

Returns starting fraction.

In range 0-1, where 1 means the surface level and 0 bed level. Always lower or equal than endFraction()

Return type:

float