seasonder_getSeaSondeRCS_dataMatrix {SeaSondeR} | R Documentation |
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:
|
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.