pyorc.CrossSection.get_bottom_surface#

CrossSection.get_bottom_surface(length: float = 2.0, offset: float = 0.0, camera: bool = False, swap_y_coords=False)[source]#

Retrieve a bottom surface polygon for the entire cross section, expanded over a length.

Returns a 2D Polygon if camera is True, 3D if False. Useful in particular for 3d situation plots.

Parameters:

length (float, optional) – length of the cross-section lateral expansion (from up to downstream) [m], by default 2.0.
offset (float, optional) – perpendicular offset of the expanded cross section from the original cross section coordinates [m], by default 0.0.
camera (bool, optional) – If set, return 2D projected polygon, by default False. Note that any plotting does not provide shading or ray tracing hence plotting a 2D polygon is not recommended.
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:

polygon representing the cross-section expanded over a certain length (2d if camera=True, 3d if camera=False).

Return type:

shapely.geometry.Polygon