Skip to contents

Validate Doppler Interpolation Factor for SeaSondeRCS Objects

Source: R/SeaSondeRCS_MUSIC.R
SeaSondeRCS_MUSIC_validate_doppler_interpolation.Rd

This function validates the doppler_interpolation factor for a SeaSondeRCS object, ensuring it is within the allowed range and does not result in exceeding the maximum number of Doppler bins after interpolation.

Usage

SeaSondeRCS_MUSIC_validate_doppler_interpolation(value, seasonder_cs_object)

Arguments

value

An integer specifying the Doppler interpolation factor. Must be one of 1, 2, 3, or 4.

seasonder_cs_object

A SeaSondeRCS object containing metadata for Doppler bin calculations.

Value

The validated doppler_interpolation factor as an integer.

Details

Doppler interpolation is a process that increases the number of Doppler bins by the specified factor before radial processing. The function performs the following validations:

  • Ensures the doppler_interpolation factor is one of 1, 2, 3, or 4.

  • Computes the total number of Doppler bins after applying the specified interpolation factor. If this number exceeds 2048, the function aborts with a descriptive error message.

The maximum Doppler bins (2048) constraint is derived from CODAR's SeaSonde R8 Radial Config Setup, which specifies that the product of the interpolation factor and the original number of Doppler bins should not exceed this limit.

Warnings

  • Using Doppler interpolation factors of 3x or 4x is not recommended.

  • Exceeding 2048 Doppler bins after interpolation will result in an error.

See also

seasonder_getnDopplerCells for retrieving the number of Doppler bins, seasonder_logAndAbort for error handling and logging.