Plotting functions

plot.plot_velocity_field(vel_res: VelocimetryResults, img: ndarray, roi: ROI, xs_res: CrossSectionResults = None, origin: Literal['lower', 'upper'] = 'lower', time_index: int = -1)

Plot velocity field with background image (+ optional Cross-section results)

Parameters:

• vel_res – Velocimetry results

• img – Background image

• roi – Region of Interest (for Image scaling)

• xs_res – Cross-section results (optional)

• origin – ‘lower’ or ‘upper’ (optional)

• time_index – Index of time in Velocimetry results (optional)