Kmallscatter

class HSTB.kluster.modules.backscatter.Kmallscatter(runtime_parameters, raw_intensity, slant_range, surface_sound_speed, beam_angle, tx_beam_width, rx_beam_width, pulse_length, tvg, fixedgain, absorption, plot_backscatter=None)

Bases: BScatter

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

Attributes Summary

absorption_description
fixed_gain	For kmall, the fixed_gain that we can remove from the reflectivity2 is the sourceLevel + receiverSensitivity, kluster will combine both of these on conversion into the 'fixedgain' variable.
gain_selection_description
pulse_length_description
raw_intensity_description
rx_beam_width_description
tvg	Kluster will use the converted kmall tvg variable to represent the tvg to remove from reflectivity2
tvg_description
tx_beam_width_description

Methods Summary

return_settings([fixed_gain_corrected, ...])

Return a dict of descriptions for each corrector

Attributes Documentation

absorption_description = 'MRZ sounding meanAbsCoeff_dbPerkm / 1000'

fixed_gain

For kmall, the fixed_gain that we can remove from the reflectivity2 is the sourceLevel + receiverSensitivity, kluster will combine both of these on conversion into the ‘fixedgain’ variable.

gain_selection_description = 'MRZ sounding sourceLevelApplied_dB + MRZ sounding receiverSensitivityApplied_dB'

pulse_length_description = 'MRZ txSectorInfo totalSignalLength_sec'

raw_intensity_description = ' MRZ sounding reflectivity2_dB'

rx_beam_width_description = 'IIP sounding_size_deg (RX)'

tvg

Kluster will use the converted kmall tvg variable to represent the tvg to remove from reflectivity2

tvg_description = 'MRZ sounding TVG_dB'

tx_beam_width_description = 'IIP sounding_size_deg (TX)'

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