QgsMeshSigmaAveragingMethod Class Reference

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

#include <qgsmesh3daveraging.h>

Inheritance diagram for QgsMeshSigmaAveragingMethod:

Public Member Functions
	QgsMeshSigmaAveragingMethod ()
	Constructs the sigma method for whole value range 0-1.
	QgsMeshSigmaAveragingMethod (double startFraction, double endFraction)
	Constructs the sigma method.
	~QgsMeshSigmaAveragingMethod () override
QgsMesh3DAveragingMethod *	clone () const override
	Clone the instance.
double	endFraction () const
	Returns ending fraction.
bool	equals (const QgsMesh3DAveragingMethod *other) const override
	Returns whether method equals to other.
void	readXml (const QDomElement &elem) override
	Reads configuration from the given DOM element.
double	startFraction () const
	Returns starting fraction.
QDomElement	writeXml (QDomDocument &doc) const override
	Writes configuration to a new DOM element.
Public Member Functions inherited from QgsMesh3DAveragingMethod
	QgsMesh3DAveragingMethod (Method method)
	Ctor.
virtual	~QgsMesh3DAveragingMethod ()=default
	Dtor.
QgsMeshDataBlock	calculate (const QgsMesh3DDataBlock &block3d, QgsFeedback *feedback=nullptr) const
	Calculated 2d block values from 3d stacked mesh values.
Method	method () const
	Returns type of averaging method.

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.
static bool	equals (const QgsMesh3DAveragingMethod *a, const QgsMesh3DAveragingMethod *b)
	Returns whether two methods equal.

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 242 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 381 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 386 of file qgsmesh3daveraging.cpp.

~QgsMeshSigmaAveragingMethod()

QgsMeshSigmaAveragingMethod::~QgsMeshSigmaAveragingMethod ( )

overridedefault

Member Function Documentation

clone()

QgsMesh3DAveragingMethod * QgsMeshSigmaAveragingMethod::clone ( ) const

overridevirtual

Clone the instance.

Implements QgsMesh3DAveragingMethod.

Definition at line 431 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 441 of file qgsmesh3daveraging.cpp.

equals()

bool QgsMeshSigmaAveragingMethod::equals ( const QgsMesh3DAveragingMethod *  other ) const

overridevirtual

Returns whether method equals to other.

Implements QgsMesh3DAveragingMethod.

Definition at line 421 of file qgsmesh3daveraging.cpp.

readXml()

void QgsMeshSigmaAveragingMethod::readXml ( const QDomElement &  elem )

overridevirtual

Reads configuration from the given DOM element.

Implements QgsMesh3DAveragingMethod.

Definition at line 407 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 436 of file qgsmesh3daveraging.cpp.

writeXml()

QDomElement QgsMeshSigmaAveragingMethod::writeXml ( QDomDocument &  doc ) const

overridevirtual

Writes configuration to a new DOM element.

Implements QgsMesh3DAveragingMethod.

Definition at line 399 of file qgsmesh3daveraging.cpp.

---

The documentation for this class was generated from the following files:

• /home/fischer/src/qgis-3.38/src/core/mesh/qgsmesh3daveraging.h
• /home/fischer/src/qgis-3.38/src/core/mesh/qgsmesh3daveraging.cpp