pyorc.CrossSection.plot_planar_surface

CrossSection.plot_planar_surface(h: float, length: float = 2.0, offset: float = 0.0, camera: bool = False, swap_y_coords=False, ax=None, **kwargs) → Axes

Plot the planar surface for a given water level.

Parameters:

• h (float, optional) – water level [m]. If not provided, the water level is taken from the camera config cross_section.camera_config.gcps[“h_ref”].

• 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 planar surface.

Return type:

plt.axes