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_q([v_corr, fill_method])	Depth integrated velocity for quantiles of time series using a correction v_corr between surface velocity and depth-average velocity.
get_river_flow([q_name, Q_name])	Integrate time series of depth averaged velocities [m2 s-1] into cross-section integrated flow [m3 s-1] estimating one or several quantiles over the time dimension.
get_xyz_perspective([M, xs, ys, mask_outside])	Get camera-perspective column, row coordinates from cross-section locations.
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.
h_a	Actual water level belonging to the processed video