pyorc.CrossSection.plot_bottom_surface#

CrossSection.plot_bottom_surface(length: float = 2.0, offset: float = 0.0, camera: bool = False, ax=None, swap_y_coords=False, **kwargs) → Axes[source]#

Plot the bottom surface for a given water level.

Parameters:

length (float, optional) – length of the waterline [m], by default 2.0
offset (float, optional) – perpendicular offset of the waterline from the cross-section [m], by default 0.0
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)
ax (plt.axes, optional) – if not provided, axes is setup (Default: None). If provided, user must take care to provide the correct projection. If camera=False, an axes must be provided with projection=”3d”.
**kwargs (dict, optional) – keyword arguments used to make the polygon plot of the bottom surface.

Return type:

plt.axes