seasonder_MUSIC_DopplerFreq2Bins: Map Doppler Frequencies to Doppler Bins

View source: R/SeaSondeRCS_MUSIC.R

seasonder_MUSIC_DopplerFreq2BinsR Documentation

Map Doppler Frequencies to Doppler Bins

Description

This function maps specified Doppler frequency values to the corresponding Doppler bins for a given SeaSonde cross-spectral object.

Usage

seasonder_MUSIC_DopplerFreq2Bins(seasonder_cs_object, doppler_values)

Arguments

seasonder_cs_object

A SeaSondeRCS object representing the cross-spectral data structure. It contains metadata and configuration for Doppler frequency and bin mapping.

doppler_values

A numeric vector of Doppler frequency values to be mapped to Doppler bins.

Details

The function performs the following steps:

  • Retrieves the unnormalized Doppler bin frequencies using seasonder_getSeaSondeRCS_MUSIC_DopplerBinsFrequency.

  • Retrieves the Doppler spectrum resolution using seasonder_getSeaSondeRCS_MUSIC_DopplerSpectrumResolution.

  • Retrieves the total number of Doppler cells using seasonder_getSeaSondeRCS_MUSIC_nDopplerCells.

  • Computes the Doppler bin indices corresponding to the input Doppler frequency values using seasonder_computeDopplerFreq2Bins.

This mapping is essential for translating frequency-domain values into bin indices used in further data processing or visualization.

Value

A numeric vector of Doppler bins corresponding to the input Doppler frequency values.

See Also

seasonder_getSeaSondeRCS_MUSIC_DopplerBinsFrequency, seasonder_getSeaSondeRCS_MUSIC_DopplerSpectrumResolution, seasonder_getSeaSondeRCS_MUSIC_nDopplerCells, seasonder_computeDopplerFreq2Bins


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