ExtinctionTest

class HSTB.kluster.modules.sat.ExtinctionTest(fqpr, round_frequency=True)

Bases: BaseTest

Plot the outermost sound velocity corrected alongtrack/depth offsets to give a sense of the maximum swath coverage versus depth. Useful for operational planning where you can think to yourself, ‘At 50 meters depth, I can expect about 4 x 50 meters coverage (4x water depth)’

Requires processed fqpr instance, see fqpr_generation.Fqpr.

Methods Summary

plot([mode, depth_bin_size, ...])	Deprecated, left in case you want to experiment with this approach.
plotv2([mode, depth_bin_size, point_size, ...])	Plot all outermost points binned in the depth dimension according to the provided size.

Methods Documentation

plot(mode='frequency', depth_bin_size=1.0, filter_incomplete_swaths=True)

Deprecated, left in case you want to experiment with this approach. See plotv2.

Plot all outermost points binned in the depth dimension according to the provided size. Each plot is organized by the given mode, if mode is frequency will plot once per frequency, such that the colors let you know the extinction at each frequency.

Parameters

• mode (str) – allowable plot mode, must be one of “frequency”, “mode”, “modetwo”

• depth_bin_size (float) – bin size in meters for the depth, size of 1 will produce one point for each meter of depth

• filter_incomplete_swaths (bool) – If True, will only plot outermost points if the outermost port alongtrack value is negative, outermost starboard alongtrack value is positive

plotv2(mode='frequency', depth_bin_size=10.0, point_size=4, filter_incomplete_swaths=True)

Plot all outermost points binned in the depth dimension according to the provided size.

Found that grouping points by category and then plotting, resulted in a messy picture, where you would have the min/max acrosstrack values for multiple modes at the same depth. You would instead generally just want the full extent at each depth interval, colored by the specified mode. Results in less points and a cleaner picture. I believe this is generally preferred, leaving the first version just in case.

Parameters

• mode (str) – allowable plot mode, must be one of “frequency”, “mode”, “modetwo”

• depth_bin_size (float) – bin size in meters for the depth, size of 1 will produce one point for each meter of depth

• point_size (int) – point size in the resulting scatter plot, generally a value from 2 to 6 for a good display

• filter_incomplete_swaths (bool) – If True, will only plot outermost points if the outermost port alongtrack value is negative, outermost starboard alongtrack value is positive