Class: QgsMeshSigmaAveragingMethod

class qgis.core.QgsMeshSigmaAveragingMethod

Bases: QgsMesh3dAveragingMethod

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

New in version 3.12.

QgsMeshSigmaAveragingMethod() Constructs the sigma method for whole value range 0-1

QgsMeshSigmaAveragingMethod(startFraction: float, endFraction: float) Constructs the sigma method

Parameters
  • startFraction – starting fraction (0-1)

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

QgsMeshSigmaAveragingMethod(QgsMeshSigmaAveragingMethod)

Methods

clone

rtype

QgsMesh3dAveragingMethod

endFraction

Returns ending fraction.

equals

param other

readXml

param elem

startFraction

Returns starting fraction.

writeXml

param doc

clone(self)QgsMesh3dAveragingMethod
Return type

QgsMesh3dAveragingMethod

endFraction(self)float

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

equals(self, other: QgsMesh3dAveragingMethod)bool
Parameters

other (QgsMesh3dAveragingMethod) –

Return type

bool

readXml(self, elem: QDomElement)
Parameters

elem (QDomElement) –

startFraction(self)float

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

writeXml(self, doc: QDomDocument)QDomElement
Parameters

doc (QDomDocument) –

Return type

QDomElement