Skip to contents

Retrieve the MUSIC Configuration from a SeaSondeRCS Object

Source: R/SeaSondeRCS_MUSIC.R
seasonder_getMUSICConfig.Rd

This function returns the key configuration parameters for the MUSIC algorithm from a SeaSondeRCS object.

Usage

seasonder_getMUSICConfig(seasonder_cs_object)

Arguments

seasonder_cs_object

A SeaSondeRCS object containing MUSIC data and options.

Value

A list containing:

  • doppler_interpolation: The Doppler interpolation factor.

  • MUSIC_parameters: The numeric vector of MUSIC parameters.

Details

The configuration is aggregated from the MUSIC_data attribute of the object for easy access.

Examples

# Minimal example for seasonder_getMUSICConfig
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.
config <- seasonder_getMUSICConfig(cs_obj)
print(config)
#> $doppler_interpolation
#> [1] 1
#> 
#> $MUSIC_parameters
#> [1] 40 20  2 20
#>