seasonder_getSeaSondeRCS_dataMatrix: Retrieve a Specific Data Matrix from a SeaSondeRCS Object

In SeaSondeR: Radial Metrics from SeaSonde HF-Radar Data

Retrieve a Specific Data Matrix from a SeaSondeRCS Object

Description

This function extracts a specific data matrix from a SeaSondeRCS object. The available matrices correspond to self-spectra and cross-spectra components used in SeaSonde radar processing.

Usage

seasonder_getSeaSondeRCS_dataMatrix(seasonder_cs_object, matrix_name)

Arguments

seasonder_cs_object	A SeaSondeRCS object containing the spectral data.
matrix_name	A string specifying the name of the matrix to retrieve. Must be one of: "SSA1": Self-spectra for antenna 1. "SSA2": Self-spectra for antenna 2. "SSA3": Self-spectra for antenna 3. "CS12": Cross-spectra between antennas 1 and 2. "CS13": Cross-spectra between antennas 1 and 3. "CS23": Cross-spectra between antennas 2 and 3. "QC": Quality control matrix.

Details

The function first verifies that the provided matrix_name is valid. If the name is not in the list of accepted values, it logs an error and aborts execution using seasonder_logAndAbort. Once validated, the function extracts the requested matrix from the data component of the SeaSondeRCS object.

Value

A matrix containing the requested spectral data. If the matrix name is invalid, an error is thrown.

See Also

seasonder_getSeaSondeRCS_data for retrieving the complete data structure. seasonder_logAndAbort for error handling.

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