Class: QgsMeshRelativeHeightAveragingMethod¶
-
class
qgis.core.
QgsMeshRelativeHeightAveragingMethod
¶ Bases:
QgsMesh3dAveragingMethod
Constructs default depth averaging method
QgsMeshRelativeHeightAveragingMethod(startHeight: float, endHeight: float, countedFromTop: bool) Constructs the depth/height averaging method
- Parameters
startHeight – starting depth/height, higher or equal than 0
endHeight – ending depth/height, higher or equal than startDepth
countedFromTop – if true, the startLength and endLength is relative to surface (0 is surface level). if false, the startLength and endLength is relative to bed (0 is bed level).
QgsMeshRelativeHeightAveragingMethod(
QgsMeshRelativeHeightAveragingMethod
)Relative height averaging method averages the values based on range defined relative to bed elevation or surface (when countedFromTop()) The range is defined in the same length units as defined by model (e.g. meters)
if countedFromTop(), the method represents averaging based on depth below surface. For example one can pull out results for between 6 to 12 meters below the water surface - depth from 6m to 12m. The depth will be truncated at the bed level.
if not countedFromTop(), the method represents averaging based on height above bed level. For example one can pull out results for between 6 to 12 meters above the bed - height from 6m to 12m. The height will be truncated at the bed level.
Methods
- rtype
QgsMesh3dAveragingMethod
Returns whether the start and end vertical levels are relative to top (surface) or bottom (bed) level
Returns ending depth/height.
- param other
- param elem
Returns starting depth/height.
- param doc
-
clone
(self) → QgsMesh3dAveragingMethod¶ - Return type
-
countedFromTop
(self) → bool¶ Returns whether the start and end vertical levels are relative to top (surface) or bottom (bed) level
- Return type
bool
-
endHeight
(self) → float¶ Returns ending depth/height.
Always higher or equal than startLength()
- Return type
float
-
equals
(self, other: QgsMesh3dAveragingMethod) → bool¶ - Parameters
other (QgsMesh3dAveragingMethod) –
- Return type
bool
-
readXml
(self, elem: QDomElement)¶ - Parameters
elem (QDomElement) –
-
startHeight
(self) → float¶ Returns starting depth/height.
Always lower or equal than endLength()
- Return type
float
-
writeXml
(self, doc: QDomDocument) → QDomElement¶ - Parameters
doc (QDomDocument) –
- Return type
QDomElement