seasonder_setFORParameter: Set a Specific FOR Parameter for a SeaSondeRCS Object

In SeaSondeR: Radial Metrics from SeaSonde HF-Radar Data

Set a Specific FOR Parameter for a SeaSondeRCS Object

Description

This function updates a single First Order Region (FOR) parameter in the SeaSondeRCS object. It creates a single-parameter list and passes it to seasonder_setFOR_parameters().

Usage

seasonder_setFORParameter(seasonder_cs_object, FOR_parameter, value)

Arguments

seasonder_cs_object	A SeaSondeRCS object containing FOR-related metadata.
FOR_parameter	A character string specifying the name of the parameter to set.
value	The value to assign to the specified FOR parameter.

Value

The updated SeaSondeRCS object with the new parameter value.

Examples

# Set sample file paths
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")
# Read the antenna pattern file to create a SeaSondeRAPM object
apm_obj <- seasonder_readSeaSondeRAPMFile(apm_file)
# Create a SeaSondeRCS object from a spectral file
cs_obj <- seasonder_createSeaSondeRCS(cs_file, seasonder_apm_object = apm_obj)
cs_obj <- seasonder_setFORParameter(cs_obj, "nsm", 4)

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