Skip to contents

Retrieve Proportion of Dual Solutions from MUSIC Data

Source: R/SeaSondeRCS_MUSIC.R
seasonder_getMUSICDualSolutionsProportion.Rd

This function extracts the proportion of dual solutions from the MUSIC data in a SeaSondeRCS object.

Usage

seasonder_getMUSICDualSolutionsProportion(seasonder_cs_object)

Arguments

seasonder_cs_object

A SeaSondeRCS object containing MUSIC data.

Value

A numeric value representing the dual solutions proportion, or NA if not set.

Details

The function checks the MUSIC_data attribute for a dual_solutions_proportion value. If not available, it defaults to NA_real_.

Examples

# Minimal example for seasonder_getMUSICDualSolutionsProportion
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.
dual_prop <- seasonder_getMUSICDualSolutionsProportion(cs_obj)
print(dual_prop)
#> [1] NA