accuracy_test

HSTB.kluster.modules.sat.accuracy_test(ref_surf, fq, output_directory, line_names=None, ping_times=None, show_plots=False)

Accuracy test: takes a reference surface and accuracy test lines and creates plots of depth difference between surface and lines for the soundings nearest the grid nodes. Plots are by beam/by angle averages. This function will automatically determine the mode and frequency of each line in the dataset to organize the plots.

Parameters

• ref_surf (Union[str, BathyGrid]) – a path to a bathygrid instance to load or the already loaded bathygrid instance

• fq (Union[str, Fqpr]) – a path to a fqpr instance to load or the already loaded fqpr instance

• output_directory (str) – str, where you want to put the plot images

• line_names (Union[str, list, None]) – if provided, only returns data for the line(s), otherwise, returns data for all lines

• ping_times (Optional[tuple]) – time to select the dataset by, must be a tuple of (min time, max time) in utc seconds. If None, will use the full min/max time of the dataset

• show_plots (bool) – if True, will show the plots as well as save them to disk