Skip to contents

Retrieve Center Doppler Bin

Source: R/SeaSondeRCS.R
seasonder_getCenterDopplerBin.Rd

This function calculates the center Doppler bin index for a SeaSondeRCS object. It obtains the total number of Doppler cells from the object using seasonder_getnDopplerCells and computes the center bin with seasonder_computeCenterDopplerBin.

Usage

seasonder_getCenterDopplerBin(seasonder_cs_object)

Arguments

seasonder_cs_object

A SeaSondeRCS object containing metadata about Doppler bins.

Value

A numeric value representing the center Doppler bin.

Details

The center Doppler bin is computed by retrieving the total number of Doppler cells (via seasonder_getnDopplerCells) and then processing that value with seasonder_computeCenterDopplerBin. Note that while CODAR data files might use zero-based indexing, R uses one-based indexing.