Skip to contents

Compute the Center Doppler Bin

Source: R/SeaSondeRCS.R
seasonder_computeCenterDopplerBin.Rd

This function calculates the center Doppler bin for a SeaSondeRCS object based on the total number of Doppler bins. The center bin corresponds to the bin representing zero Doppler frequency.

Usage

seasonder_computeCenterDopplerBin(seasonder_cs_object, nDoppler)

Arguments

seasonder_cs_object

A SeaSondeRCS object containing metadata about Doppler bins and other radar parameters.

nDoppler

An integer representing the total number of Doppler bins.

Value

A numeric value representing the center Doppler bin. The calculation assumes zero-based indexing from CODAR data files, but note that R uses one-based indexing, which may result in differences compared to CODAR's Radia Suite outputs.

Details

The center Doppler bin is computed as: \(center\_bin = nDoppler/2\) where nDoppler is the total number of Doppler bins. This represents the bin at zero Doppler frequency in a zero-indexed system. Since R uses one-based indexing, users might observe an offset when comparing the output of this function to CODAR's Radia Suite programs.

See also

seasonder_getSeaSondeRCS_MUSIC_nDopplerCells to retrieve the number of Doppler cells from a SeaSondeRCS object.