PingPeriodTest

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

Bases: BaseTest

Plot the period of the pings binned by depth. Illustrates the increase in ping period as depth increases. Gets some odd results with dual swath/dual head sonar. We try to plot the rolling mean of the ping period in these cases.

Methods Summary

plot([mode, depth_bin_size])

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

Methods Documentation

plot(mode='frequency', depth_bin_size=5.0)

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