Allscatter

class HSTB.kluster.modules.backscatter.Allscatter(runtime_parameters, raw_intensity, slant_range, surface_sound_speed, beam_angle, tx_beam_width, rx_beam_width, near_normal_corrector, pulse_length, plot_backscatter=None)

Bases: BScatter

Backscatter processing module for the Kongsberg .all format. See the description class variables to get a sense of where the raw data comes from.

Attributes Summary

absorption_description
fixed_gain	There is a ReceiverFixedGain runtime parameter but it contains Mode2 for most sonar.
near_normal_description
pulse_length_description
raw_intensity_description
rx_beam_width_description
tvg	Kluster uses a basic model for calculating the tvg used by Kongsberg to remove from the raw reflectivity, also including the nearnormal corrector.
tx_beam_width_description

Methods Summary

return_settings([fixed_gain_corrected, ...])

Return a dict of descriptions for each corrector

Attributes Documentation

absorption_description = 'runtime parameters AbsorptionCoefficent'

fixed_gain

There is a ReceiverFixedGain runtime parameter but it contains Mode2 for most sonar. It appears to mostly be a legacy thing. from the docs “Receiver fixed gain setting in dB (only valid for) EM 2000, EM 1002, EM 3000, EM 3002, EM300, EM 120”.

So for this module, we leave fixed gain at 0.

near_normal_description = '(BSoblique_dB - BSnormal_dB) * (1 - sqrt((range - minrange) / ((minrange / crossoverangle) - minrange)))'

pulse_length_description = 'RangeandAngleDatagram SignalLength'

raw_intensity_description = 'SeaBedImage89 Reflectivity'

rx_beam_width_description = 'runtime parameters ReceiveBeamWidth'

tvg

Kluster uses a basic model for calculating the tvg used by Kongsberg to remove from the raw reflectivity, also including the nearnormal corrector.

tx_beam_width_description = 'runtime parameters TransmitBeamWidth'

Methods Documentation

classmethod return_settings(fixed_gain_corrected=True, tvg_corrected=True, transmission_loss_corrected=True, area_corrected=True)

Return a dict of descriptions for each corrector

Parameters

• fixed_gain_corrected (bool) – if True, will remove fixed_gain from raw reflectivity

• tvg_corrected (bool) – if True, will remove tvg from raw reflectivity

• transmission_loss_corrected (bool) – if True, will add on the transmission loss corrector

• area_corrected (bool) – if True, will add on the area correction