seasonder_getMUSICOptions: Retrieve MUSIC Options from a SeaSondeRCS Object
In SeaSondeR: Radial Metrics from SeaSonde HF-Radar Data

seasonder_getMUSICOptions

R Documentation

Retrieve MUSIC Options from a SeaSondeRCS Object

Description

This function extracts the MUSIC options from a SeaSondeRCS object.

Usage

seasonder_getMUSICOptions(seasonder_cs_object)

Arguments

seasonder_cs_object

A SeaSondeRCS object containing MUSIC data as an attribute.

Details

The function retrieves the MUSIC options from the object's MUSIC_data attribute. In the absence of user-defined options, it returns the default options provided by seasonder_defaultMUSICOptions().

Value

A list of MUSIC options.

Examples

# Minimal example for seasonder_getMUSICOptions
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)
cs_obj <- seasonder_createSeaSondeRCS(cs_file, seasonder_apm_object = apm_obj)
opts <- seasonder_getMUSICOptions(cs_obj)
print(opts)

SeaSondeR documentation built on June 8, 2025, 10:50 a.m.