seasonder_setSeaSondeRCS_MUSIC_parameters: Set MUSIC Parameters for a SeaSondeRCS Object

In SeaSondeR: Radial Metrics from SeaSonde HF-Radar Data

Set MUSIC Parameters for a SeaSondeRCS Object

Description

This function updates the MUSIC algorithm parameters stored in a SeaSondeRCS object's MUSIC data attribute. The parameters are updated in the MUSIC options under the MUSIC_parameters field. Currently, no explicit validation of the provided parameters is performed.

Usage

seasonder_setSeaSondeRCS_MUSIC_parameters(
  seasonder_cs_object,
  MUSIC_parameters = seasonder_defaultMUSIC_parameters()
)

Arguments

seasonder_cs_object	A SeaSondeRCS object containing cross-spectral data and metadata.
MUSIC_parameters	A numeric vector of parameters for the MUSIC algorithm. Defaults to the result of seasonder_defaultMUSIC_parameters().

Details

The function assigns the provided MUSIC_parameters vector to the MUSIC_parameters field within the MUSIC_options list, which is stored in the object's MUSIC_data attribute. These parameters are used in various steps of the MUSIC processing workflow.

Value

The updated SeaSondeRCS object with the new MUSIC parameters stored in its MUSIC options.

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