seasonder_setSeaSondeRCS_MUSIC_dual_solutions_proportion: Set Dual Solutions Proportion for MUSIC Analysis

In SeaSondeR: Radial Metrics from SeaSonde HF-Radar Data

Set Dual Solutions Proportion for MUSIC Analysis

Description

This function assigns the dual solutions proportion to the MUSIC data of a SeaSondeRCS object. The dual solutions proportion represents the fraction of solutions identified as dual in the MUSIC processing workflow. Currently, no explicit validation of the provided value is performed.

Usage

seasonder_setSeaSondeRCS_MUSIC_dual_solutions_proportion(
  seasonder_cs_object,
  dual_solutions_proportion
)

Arguments

seasonder_cs_object	A SeaSondeRCS object containing MUSIC analysis results.
dual_solutions_proportion	A numeric value representing the proportion of dual solutions.

Details

The function updates the dual_solutions_proportion field within the MUSIC_data attribute. This value is later used to assess the prevalence of dual bearing solutions in the MUSIC results.

Value

The updated SeaSondeRCS object with the dual solutions proportion stored in its MUSIC data.

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