validation_against_xyz88

HSTB.kluster.fqpr_convenience.validation_against_xyz88(filname, analysis_mode='even', numplots=10, visualizations=False, export=None)

Function to take a multibeam file and compare the svcorrected xyz with the converted and sound velocity corrected data generated by Kluster/fqpr_generation. This is mostly here just to validate the Kluster data, definitely not performant. Will generate a plot with subplots that are useful for analysis.

Will take select pings from xyz88 and Kluster and compare them with a plot of differences

Parameters

• filname (str) – full path to multibeam file

• analysis_mode (str) – ‘even’ = select pings are evenly distributed, ‘random’ = select pings are randomly distributed, ‘first’ = pings will be the first found in the file

• numplots (int) – number of pings to compare

• visualizations (bool) – True if you want the matplotlib animations

• export (Optional[str]) – if export path is provided, save the image to this path

Returns

returned here for further analysis if you want it

Return type

Fqpr