Sigma averages over the values between 0 (bed level) and 1 (surface). More...
#include <qgsmesh3daveraging.h>
Public Member Functions | |
| QgsMeshSigmaAveragingMethod () | |
| Constructs the sigma method for whole value range 0-1. More... | |
| QgsMeshSigmaAveragingMethod (double startFraction, double endFraction) | |
| Constructs the sigma method. More... | |
| ~QgsMeshSigmaAveragingMethod () override | |
| QgsMesh3dAveragingMethod * | clone () const override |
| Clone the instance. More... | |
| double | endFraction () const |
| Returns ending fraction. More... | |
| bool | equals (const QgsMesh3dAveragingMethod *other) const override |
| Returns whether method equals to other. More... | |
| void | readXml (const QDomElement &elem) override |
| Reads configuration from the given DOM element. More... | |
| double | startFraction () const |
| Returns starting fraction. More... | |
| QDomElement | writeXml (QDomDocument &doc) const override |
| Writes configuration to a new DOM element. More... | |
 Public Member Functions inherited from QgsMesh3dAveragingMethod | |
| QgsMesh3dAveragingMethod (Method method) | |
| Ctor. More... | |
| virtual | ~QgsMesh3dAveragingMethod ()=default |
| Dtor. More... | |
| QgsMeshDataBlock | calculate (const QgsMesh3dDataBlock &block3d, QgsFeedback *feedback=nullptr) const |
| Calculated 2d block values from 3d stacked mesh values. More... | |
| Method | method () const |
| Returns type of averaging method. More... | |
Additional Inherited Members | |
| Public Types inherited from QgsMesh3dAveragingMethod | |
| enum | Method { MultiLevelsAveragingMethod = 0, SigmaAveragingMethod, RelativeHeightAveragingMethod, ElevationAveragingMethod } |
| Type of averaging method. More... | |
| Static Public Member Functions inherited from QgsMesh3dAveragingMethod | |
| static QgsMesh3dAveragingMethod * | createFromXml (const QDomElement &elem) |
| Creates the instance from XML by calling readXml of derived classes. More... | |
| static bool | equals (const QgsMesh3dAveragingMethod *a, const QgsMesh3dAveragingMethod *b) |
| Returns whether two methods equal. More... | |
Detailed Description
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
- Since
- QGIS 3.12
Definition at line 238 of file qgsmesh3daveraging.h.
Constructor & Destructor Documentation
◆ QgsMeshSigmaAveragingMethod() [1/2]
| QgsMeshSigmaAveragingMethod::QgsMeshSigmaAveragingMethod | ( | ) |
Constructs the sigma method for whole value range 0-1.
Definition at line 350 of file qgsmesh3daveraging.cpp.
◆ QgsMeshSigmaAveragingMethod() [2/2]
| QgsMeshSigmaAveragingMethod::QgsMeshSigmaAveragingMethod | ( | double | startFraction, |
| double | endFraction | ||
| ) |
Constructs the sigma method.
- Parameters
-
startFraction starting fraction (0-1) endFraction ending fraction, must be higher or equal than startFraction (0-1)
Definition at line 355 of file qgsmesh3daveraging.cpp.
◆ ~QgsMeshSigmaAveragingMethod()
|
overridedefault |
Member Function Documentation
◆ clone()
|
overridevirtual |
Clone the instance.
Implements QgsMesh3dAveragingMethod.
Definition at line 400 of file qgsmesh3daveraging.cpp.
◆ endFraction()
| double QgsMeshSigmaAveragingMethod::endFraction | ( | ) | const |
Returns ending fraction.
In range 0-1, where 1 means the surface level and 0 bed level. Always higher or equal than startFraction()
Definition at line 410 of file qgsmesh3daveraging.cpp.
◆ equals()
|
overridevirtual |
Returns whether method equals to other.
Implements QgsMesh3dAveragingMethod.
Definition at line 390 of file qgsmesh3daveraging.cpp.
◆ readXml()
|
overridevirtual |
Reads configuration from the given DOM element.
Implements QgsMesh3dAveragingMethod.
Definition at line 376 of file qgsmesh3daveraging.cpp.
◆ startFraction()
| double QgsMeshSigmaAveragingMethod::startFraction | ( | ) | const |
Returns starting fraction.
In range 0-1, where 1 means the surface level and 0 bed level. Always lower or equal than endFraction()
Definition at line 405 of file qgsmesh3daveraging.cpp.
◆ writeXml()
|
overridevirtual |
Writes configuration to a new DOM element.
Implements QgsMesh3dAveragingMethod.
Definition at line 368 of file qgsmesh3daveraging.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.16.0+99unstable/src/core/mesh/qgsmesh3daveraging.h
- /build/qgis-3.16.0+99unstable/src/core/mesh/qgsmesh3daveraging.cpp
