Retrieve the Doppler Interpolation Factor from MUSIC Options — seasonder

This function obtains the Doppler interpolation factor used in the MUSIC algorithm from a SeaSondeRCS object.

Usage

seasonder_getMUSICDopplerInterpolation(seasonder_cs_object)

Arguments

seasonder_cs_object: A SeaSondeRCS object containing MUSIC data and options.

Value

An integer representing the Doppler interpolation factor.

Details

The function accesses the MUSIC_data attribute under MUSIC_options and retrieves the doppler_interpolation parameter. If absent, it defaults to 1L.

Examples

# Assuming cs_object is a valid SeaSondeRCS object.
# Minimal example for seasonder_getMUSICDopplerInterpolation
cs_file <- system.file("css_data/CSS_TORA_24_04_04_0700.cs", package = "SeaSondeR")
apm_file <- system.file("css_data/MeasPattern.txt", package = "SeaSondeR")
apm_obj <- seasonder_readSeaSondeRAPMFile(apm_file)
#> seasonder_createSeaSondeRAPM:  APM object created successfully.
cs_obj <- seasonder_createSeaSondeRCS(cs_file, seasonder_apm_object = apm_obj)
#> new_SeaSondeRCS:  SeaSondeRCS object created successfully.
interp_factor <- seasonder_getMUSICDopplerInterpolation(cs_obj)
print(interp_factor)
#> [1] 1