Skip to contents

Retrieve First Order Region (FOR) Parameters

Source: R/SeaSondeRCS_FOR.R
seasonder_getFOR_parameters.Rd

This function retrieves the First Order Region (FOR) parameters associated with a SeaSondeR cross-spectral object. If no FOR parameters are found in the object's attributes, it initializes them using seasonder_validateFOR_parameters.

Usage

seasonder_getFOR_parameters(seasonder_cs_object)

Arguments

seasonder_cs_object

A SeaSondeRCS object containing FOR-related metadata.

Value

A named list containing the validated FOR parameters.

Details

The function extracts the FOR parameters stored within the object. If the parameters are missing, the function initializes them using seasonder_validateFOR_parameters and assigns default values where necessary.

FOR Parameters:

  • nsm: Doppler smoothing factor.

  • fdown: Peak power dropoff threshold.

  • flim: Null below peak power threshold.

  • noisefact: Signal-to-noise threshold.

  • currmax: Maximum velocity allowed.

  • reject_distant_bragg: Flag to reject distant Bragg signals.

  • reject_noise_ionospheric: Flag to reject ionospheric noise contamination.

  • reject_noise_ionospheric_threshold: Threshold (in dB) for rejecting noise-affected Bragg signals.

  • reference_noise_normalized_limits: Estimated limits for reference noise in normalized Doppler frequency.

See also

seasonder_validateFOR_parameters for initializing and validating FOR parameters. seasonder_defaultFOR_parameters for retrieving default parameter values.