This function computes the Doppler frequencies associated with each Doppler bin in a SeaSondeRCS object. The output can be normalized by the positive Bragg frequency if specified.
Usage
seasonder_computeDopplerBinsFrequency(
seasonder_cs_object,
nDoppler,
center_bin,
spectra_res,
normalized = FALSE
)
Arguments
- seasonder_cs_object
A SeaSonde CS object created by
seasonder_createSeaSondeRCS()
. This object contains the necessary metadata, such as Doppler resolution and center bin, for frequency computation.- nDoppler
Integer. The total number of Doppler bins.
- center_bin
Numeric. The index of the central Doppler bin corresponding to 0 Hz.
- spectra_res
Numeric. The spectral resolution in Hz for each Doppler bin.
- normalized
Logical. If
TRUE
, the frequencies are normalized by dividing them by the positive Bragg frequency. Default isFALSE
.
Value
A numeric vector representing the Doppler frequencies for each bin. If
normalized = TRUE
, the values are dimensionless and relative to the
positive Bragg frequency. Otherwise, they are in Hz.
Details
Doppler frequencies are calculated using the formula: $$\text{frequency}_i = (\text{bin index}_i - \text{center bin}) \times \text{resolution}$$ For normalized frequencies: $$\text{frequency}_i = \frac{\text{frequency}_i}{\text{positive Bragg frequency}}$$
The center bin is typically determined using seasonder_getCenterDopplerBin()
,
and the resolution is obtained from seasonder_getDopplerSpectrumResolution()
.
Normalization is based on the positive Bragg frequency calculated by
seasonder_getBraggDopplerAngularFrequency()
.