seasonder_getReceiverGain_dB: Retrieve Receiver Gain in Decibels

In SeaSondeR: Radial Metrics from SeaSonde HF-Radar Data

Retrieve Receiver Gain in Decibels

Description

This function retrieves the receiver gain value (in decibels) from the header of a given SeaSondeRCS object. If the receiver gain field is missing or NULL, a default value of -34.2 dB is returned.

Usage

seasonder_getReceiverGain_dB(seasonder_cs_object)

Arguments

seasonder_cs_object

A SeaSondeRCS object containing header information about the radar system.

Details

The function extracts the value of the header field fReferenceGainDB using seasonder_getSeaSondeRCS_headerField. If the field is not present or has a NULL value, the function defaults to a receiver gain of -34.2 dB (CODAR, 2016).

Value

A numeric value representing the receiver gain in decibels (dB).

References

Cross Spectra File Format Version 6, CODAR. (2016).

See Also

seasonder_getSeaSondeRCS_headerField to retrieve specific fields from the SeaSondeRCS header.

SeaSondeR documentation built on June 8, 2025, 10:50 a.m.