pyorc.CrossSection.get_wetted_surface#

CrossSection.get_wetted_surface(h: float, camera: bool = False, swap_y_coords=False) → Polygon[source]#

Retrieve a wetted surface for a given water level, as a geometry.Polygon.

Parameters:

h (float) – water level [m]
camera (bool, optional) – If set, return 2D projected polygon, by default False.
swap_y_coords (bool, optional) – if set, all y-coordinates are swapped so that they fit on a flipped version of the image. This is useful in case you plot on ascending y-coordinate axis background images (default: False)

Returns:

Wetted surface as a polygon (2d if camera=True, 3d if camera=False).

Return type:

geometry.Polygon