seasonder_setSeaSondeRCS_FOR_SS_Smoothed: Set Smoothed Self-Spectra for First Order Region (FOR)

View source: R/SeaSondeRCS_FOR.R

seasonder_setSeaSondeRCS_FOR_SS_SmoothedR Documentation

Set Smoothed Self-Spectra for First Order Region (FOR)

Description

This function assigns a smoothed self-spectra (SS) matrix to the First Order Region (FOR) data within a SeaSondeRCS object. This smoothed matrix is used in FOR processing to improve the detection of the first-order region.

Usage

seasonder_setSeaSondeRCS_FOR_SS_Smoothed(seasonder_cs_object, FOR_SS_Smoothed)

Arguments

seasonder_cs_object

A SeaSondeRCS object to which the smoothed FOR self-spectra will be assigned.

FOR_SS_Smoothed

A matrix containing the smoothed self-spectra data.

Details

The function assigns the provided smoothed self-spectra matrix to the FOR_data attribute of the SeaSondeRCS object. This matrix is typically generated using seasonder_SmoothSS and applied to antenna 3.

Validation Considerations:

  • The function currently lacks explicit validation for FOR_SS_Smoothed.

  • Future improvements should include checking whether FOR_SS_Smoothed is a matrix and ensuring its dimensions match the original self-spectra structure.

Value

The updated SeaSondeRCS object with the smoothed self-spectra stored in the FOR_data attribute.

See Also

  • seasonder_SmoothSS for generating the smoothed self-spectra.

  • seasonder_SmoothFORSS for applying smoothing and setting the result.


SeaSondeR documentation built on June 8, 2025, 10:50 a.m.