pyorc.Velocimetry#
- class pyorc.Velocimetry(xarray_obj)[source]#
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)[source]#
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
filter_spatial
([v_x, v_y, filter_nan, ...])Masks velocity values on a number of spatial filters.
filter_spatial_median
([v_x, v_y, tolerance, ...])Masks values when their value deviates more than x standard deviations from the median of its neighbours (inc.
filter_spatial_nan
([v_x, v_y, tolerance, ...])Masks values if their surrounding neighbours (inc.
filter_temporal
([v_x, v_y, filter_std, ...])Masks values using several filters that use temporal variations or comparison as basis.
filter_temporal_angle
([v_x, v_y, ...])filters on the expected angle.
filter_temporal_corr
([v_x, v_y, corr, tolerance])Masks values with a too low correlation.
filter_temporal_count
([tolerance])Masks locations with a too low amount of valid velocities in time, measured by fraction with
tolerance
.filter_temporal_neighbour
([v_x, v_y, roll, ...])Masks values if neighbours over a certain rolling length before and after, have a significantly higher velocity than value under consideration, measured by tolerance.
filter_temporal_std
([v_x, v_y, ...])Masks values if they deviate more than x standard deviations from the mean.
filter_temporal_velocity
([v_x, v_y, s_min, ...])Masks values if the velocity scalar lies outside a user-defined valid range.
get_transect
(x, y[, z, s, crs, v_eff, xs, ...])Interpolate all variables to supplied x and y coordinates of a cross section.
replace_outliers
([v_x, v_y, wdw, max_iter, ...])Replace missing values using neighbourhood operators.
set_encoding
([enc_pars])Set encoding parameters for all typical variables in a velocimetry dataset.
Attributes
Camera configuration belonging to the processed video
Shape of the original camera objective of the processed video (e.g.
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.