seasonder_getSeaSondeRCS_FORConfig {SeaSondeR} | R Documentation |
Retrieve First Order Region (FOR) Configuration from a SeaSondeRCS Object
Description
This function extracts the configuration related to the First Order Region (FOR) from a SeaSondeRCS object. It returns a list containing the FOR parameters and the noise level assigned to the object.
Usage
seasonder_getSeaSondeRCS_FORConfig(seasonder_cs_object)
Arguments
seasonder_cs_object |
A SeaSondeRCS object containing FOR-related metadata. |
Details
The FOR configuration is composed of parameters that define the first order region and the noise level used during
FOR processing. This function aggregates these components by calling seasonder_getFOR_parameters()
and
seasonder_getSeaSondeRCS_NoiseLevel()
.
Value
A list with two components:
-
FOR_parameters
: A list of parameters used for FOR processing. -
NoiseLevel
: The noise level values retrieved from the object.
Examples
# Create a minimal SeaSondeRCS object
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)
config <- seasonder_getSeaSondeRCS_FORConfig(cs_obj)
print(config)
[Package SeaSondeR version 0.2.8 Index]