pyorc.Velocimetry

class pyorc.Velocimetry(xarray_obj)

Velocimetry functionalities that can be applied on xarray.Dataset

Initialize a velocimetry xarray.Dataset

Parameters:

xarray_obj (xr.Dataset) – velocimetry data fields (from pyorc.Frames.get_piv)

__init__(xarray_obj)

Initialize a velocimetry xarray.Dataset

Parameters:

xarray_obj (xr.Dataset) – velocimetry data fields (from pyorc.Frames.get_piv)

Methods

__init__(xarray_obj)	Initialize a velocimetry xarray.Dataset
add_xy_coords(xy_coord_data, coords, attrs_dict)	Add coordinate variables with x and y dimensions (2d) to existing xr.Dataset.
get_transect(x, y[, z, s, crs, v_eff, xs, ...])	Interpolate all variables to supplied x and y coordinates of a cross section.
set_encoding([enc_pars])	Set encoding parameters for all typical variables in a velocimetry dataset.

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.
is_velocimetry	Checks if the data contained in the object seems to be velocimetry data by checking naming of dims and available variables.