BScatter

class HSTB.kluster.modules.backscatter.BScatter(raw_intensity, slant_range, surface_sound_speed, beam_angle, plot_backscatter=None)

Bases: object

Backscatter processing module for all sonars. Inherit from this for your manufacturer specific model.

Attributes Summary

absorption_description
area_correction
attenuation
fixed_gain
pulse_length_description
raw_intensity_description
rx_beam_width_description
spherical_spreading
transmission_loss
tvg
tx_beam_width_description

Methods Summary

plot_backscatter_components()
process([fixed_gain_corrected, ...])	Process the raw intensity for each of the given correctors.
return_settings([fixed_gain_corrected, ...])

Attributes Documentation

absorption_description = ''

area_correction

attenuation

fixed_gain

pulse_length_description = ''

raw_intensity_description = ''

rx_beam_width_description = ''

spherical_spreading

transmission_loss

tvg

tx_beam_width_description = ''

Methods Documentation

plot_backscatter_components()

process(fixed_gain_corrected=True, tvg_corrected=True, transmission_loss_corrected=True, area_corrected=True)

Process the raw intensity for each of the given correctors. Uses the following basic equation:

final intensity = raw intensity - fixed gain - manufacturer tvg + calculated transmission loss - calculated area correction

Will optionally save plots if you provided plot_backscatter.

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

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