Skip to contents

Set FOR Maximum Velocity (currmax)

Source: R/SeaSondeRCS_FOR.R
seasonder_setFOR_currmax.Rd

This function sets the maximum radial velocity (currmax) allowed in the first-order region for the SeaSondeRCS object.

Usage

seasonder_setFOR_currmax(seasonder_cs_object, currmax)

Arguments

seasonder_cs_object

A SeaSondeRCS object with FOR parameters.

currmax

A numeric value specifying the new maximum radial velocity.

Value

The updated SeaSondeRCS object with the new currmax 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)
#> seasonder_createSeaSondeRAPM:  APM object created successfully.
# Create a SeaSondeRCS object from a spectral file
cs_obj <- seasonder_createSeaSondeRCS(cs_file, seasonder_apm_object = apm_obj)
#> new_SeaSondeRCS:  SeaSondeRCS object created successfully.
cs_obj <- seasonder_setFOR_currmax(cs_obj, 2.5)