seasonder_setSeaSondeRCS_APM: Set APM for a SeaSondeRCS Object

In SeaSondeR: Radial Metrics from SeaSonde HF-Radar Data

Set APM for a SeaSondeRCS Object

Description

This function assigns the provided APM object to the SeaSondeRCS object by setting its "APM" attribute. (Note: Validation of the APM object is to be implemented.)

Usage

seasonder_setSeaSondeRCS_APM(seasonder_cs_object, seasonder_apm_object)

Arguments

seasonder_cs_object	A SeaSondeRCS object.
seasonder_apm_object	An object representing the APM (Antenna Pattern Matrix or similar metadata) to be assigned to the SeaSondeRCS object.

Details

The function simply sets the "APM" attribute of the provided SeaSondeRCS object to the given APM object. Further validation of the APM object should be performed (TODO).

Value

The updated SeaSondeRCS object with the new APM attribute set.

Examples

# Minimal example for seasonder_setSeaSondeRCS_APM
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)
cs_obj <- seasonder_setSeaSondeRCS_APM(cs_obj, apm_obj)
print(attr(cs_obj, "APM"))

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