pyorc.Transect

class pyorc.Transect(xarray_obj)

Transect functionalities that can be applied on xarray.Dataset.

Initialize a transect xarray.Dataset containing cross-sectional velocities in [time, points] dimensions.

Parameters:

xarray_obj (xr.Dataset) – transect data fields (from pyorc.Velocimetry.get_transect)

__init__(xarray_obj)

Initialize a transect xarray.Dataset containing cross-sectional velocities in [time, points] dimensions.

Parameters:

xarray_obj (xr.Dataset) – transect data fields (from pyorc.Velocimetry.get_transect)

Methods

__init__(xarray_obj)	Initialize a transect xarray.Dataset containing cross-sectional velocities in [time, points] dimensions.
add_xy_coords(xy_coord_data, coords, attrs_dict)	Add coordinate variables with x and y dimensions (2d) to existing xr.Dataset.
get_bottom_surface_z_perspective(h[, ...])	Return densified bottom and surface points, warped to image perspective.
get_depth_perspective(h[, sample_size, interval])	Get line (x, y) pairs that show the depth over several intervals in the wetted part of the cross section.
get_q([v_corr, fill_method])	Integrated velocity over depth for quantiles of time series.
get_river_flow([q_name, discharge_name])	Integrate time series of depth averaged velocities [m2 s-1] into cross-section integrated flow [m3 s-1].
get_transect_perspective([h, within_image])	Get row, col locations of the transect coordinates.
get_v_bulk([q_name])	Compute the bulk velocity.
get_v_surf([v_name])	Compute mean surface velocity in locations that are below water level.
vector_to_scalar([v_x, v_y])	Set "v_eff" and "v_dir" variables as effective velocities over cross-section, and its angle.

Attributes

camera_config	Camera configuration belonging to the processed video.
camera_shape	Shape of the original camera objective of the processed video (e.g.
cross_section	Return cross-sectional coordinates as CrossSection object.
h_a	Actual water level belonging to the processed video.
wetted_perimeter	Return wetted perimeter as float.
wetted_perimeter_linestring	Return wetted perimeter as shapely.geometry.MultiLineString object.
wetted_surface	Return wetted surface as float.
wetted_surface_polygon	Return wetted surface as shapely.geometry.MultiPolygon object.