S7kscatter

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

Bases: BScatter

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

Attributes Summary

absorption_description
fixed_gain	For s7k, the fixed_gain that we can remove from the raw intensity is the user set gain + power.
gain_selection_description
power_selection_description
pulse_length_description
raw_intensity_description
rx_beam_width_description
spreading_description
tvg	For s7k, the tvg that we can remove from the raw intensity is calculated based on these other runtime parameters and the calculated slant range.
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 absorption_db_km'

fixed_gain

For s7k, the fixed_gain that we can remove from the raw intensity is the user set gain + power.

gain_selection_description = '20 * log10(runtime parameters GainSelection)'

power_selection_description = '20 * log10(runtime parameters PowerSelection)'

pulse_length_description = 'runtime parameters tx_pulse_width_seconds'

raw_intensity_description = '20 * log10(RawDetection7027 Intensity)'

rx_beam_width_description = 'runtime parameters ReceiveBeamWidth'

spreading_description = 'runtime parameters spreading_loss_db'

tvg

For s7k, the tvg that we can remove from the raw intensity is calculated based on these other runtime parameters and the calculated slant range.

tx_beam_width_description = 'runtime parameters ProjectorBeamWidthVertical'

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 return descriptor for removing fixed_gain from raw reflectivity

• tvg_corrected (bool) – if True, will return descriptor for removing tvg from raw reflectivity

• transmission_loss_corrected (bool) – if True, will return descriptor for adding on the transmission loss corrector

• area_corrected (bool) – if True, will return descriptor for adding on the area correction