seasonder_getReceiverGain_dB {SeaSondeR} | R Documentation |
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 |
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.
[Package SeaSondeR version 0.2.8 Index]