pyorc.Frames.get_piv

Frames.get_piv(**kwargs)

Perform PIV computation on projected frames. Only a pipeline graph to computation is setup. Call a result to trigger actual computation. The dataset returned contains velocity information for each interrogation window including “v_x” for x-direction velocity components, “v_y” for y-direction velocity component, “corr” for the maximum correlation [-] found in the interrogation window and s2n [-] for the signal to noise ratio

Parameters:

**kwargs (keyword arguments to pass to dask_piv, used to control the manner in which openpiv.pyprocess) – is called.

Returns:

ds – PIV results in a lazy dask.array form in DataArrays “v_x”, “v_y”, “corr” and “s2n”.

Return type:

xr.Dataset