seasonder_setSeaSondeRCS_FOR_method: Set First Order Region Processing Method for SeaSondeRCS...
In SeaSondeR: Radial Metrics from SeaSonde HF-Radar Data
View source: R/SeaSondeRCS_FOR.R
seasonder_setSeaSondeRCS_FOR_method R Documentation
Set First Order Region Processing Method for SeaSondeRCS Object
Description
This function sets the First Order Region (FOR) processing method for a SeaSondeRCS object.
It validates the provided method using seasonder_validateFORMethod and assigns it to the
object's FOR_data attribute under FOR_method.
Usage
seasonder_setSeaSondeRCS_FOR_method(seasonder_cs_object, FOR_method)
Arguments
seasonder_cs_object
A SeaSondeRCS object containing spectral and metadata information.
FOR_method
A character string specifying the desired FOR processing method. Currently, only
"SeaSonde" is supported.
Details
The function first validates the provided method. If the method is valid, it is stored in the
FOR_data attribute of the SeaSondeRCS object under the FOR_method field. This setting
is later used in the processing workflow to guide FOR computation.
Value
The updated SeaSondeRCS object with the specified FOR processing method set.
SeaSondeR documentation built on June 8, 2025, 10:50 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/SeaSondeRCS_FOR.R
| seasonder_setSeaSondeRCS_FOR_method | R Documentation |
Set First Order Region Processing Method for SeaSondeRCS Object
Description
This function sets the First Order Region (FOR) processing method for a SeaSondeRCS object.
It validates the provided method using seasonder_validateFORMethod and assigns it to the
object's FOR_data attribute under FOR_method.
Usage
seasonder_setSeaSondeRCS_FOR_method(seasonder_cs_object, FOR_method)
Arguments
seasonder_cs_object |
A SeaSondeRCS object containing spectral and metadata information. |
FOR_method |
A character string specifying the desired FOR processing method. Currently, only
|
Details
The function first validates the provided method. If the method is valid, it is stored in the
FOR_data attribute of the SeaSondeRCS object under the FOR_method field. This setting
is later used in the processing workflow to guide FOR computation.
Value
The updated SeaSondeRCS object with the specified FOR processing method set.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.