pyorc.CrossSection.get_csl_line#

CrossSection.get_csl_line(h: Optional[float] = None, l: Optional[float] = None, length: float = 0.5, offset: float = 0.0, camera: bool = False, swap_y_coords: bool = False) → List[LineString][source]#

Retrieve waterlines over the cross-section, perpendicular to the orientation of the cross-section.

Returns a 2D LineString if camera is True, 3D if False

Parameters:

h (float, optional) – water level [m]
l (float) – coordinate of distance from left to right bank, including height [m], if provided, h must not be provided.
length (float, optional) – length of the waterline [m], by default 0.5
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 lines, 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:

List of lines perpendicular to cross section orientation, can be only one or two lines.

Return type:

List[shapely.geometry.LineString]