seasonder_validateFOR_parameters {SeaSondeR}R Documentation

Validate First Order Region (FOR) Parameters

Description

This function validates and assigns default values to the parameters used in defining the First Order Region (FOR) in a SeaSondeR cross-spectral object. It ensures that all necessary parameters are present and assigns appropriate defaults where values are missing.

Usage

seasonder_validateFOR_parameters(
  seasonder_cs_object,
  FOR_parameters,
  method = "SeaSonde"
)

Arguments

seasonder_cs_object

A SeaSondeRCS object containing metadata about the Doppler spectrum.

FOR_parameters

A named list containing the parameters for first-order region detection.

method

A character string specifying the validation method. Default is "SeaSonde". Currently, only "SeaSonde" is supported.

Details

The function validates FOR parameters and assigns default values where necessary. If the selected method is "SeaSonde", the function ensures that each parameter is defined and, if missing, assigns it a default value based on seasonder_defaultFOR_parameters.

The parameters validated include:

Value

A named list containing validated and completed FOR parameters.

See Also


[Package SeaSondeR version 0.2.8 Index]