seasonder_createSeaSondeRAPM {SeaSondeR} | R Documentation |
Create a SeaSondeRAPM Object
Description
This function creates a SeaSondeRAPM object to store antenna pattern calibration data.
Usage
seasonder_createSeaSondeRAPM(
calibration_matrix = matrix(complex(real = NA_real_, imaginary = NA_real_), nrow = 3,
ncol = 0),
...
)
Arguments
calibration_matrix |
A 3 x b complex matrix, where b is the number of bearings for calibration. |
... |
Additional named attributes that will be passed to |
Details
The function performs the following operations:
Validates the
calibration_matrix
withseasonder_validateCalibrationMatrixSeaSondeRAPM
.Initializes all other attributes either with default or user-provided values.
Merges the initialized attributes into
calibration_matrix
.Sets the object's class to 'SeaSondeRAPM'.
For more details on the attributes, see seasonder_initializeAttributesSeaSondeRAPM
.
Value
A SeaSondeRAPM object containing a complex matrix with class attribute 'SeaSondeRAPM' and additional attributes for metadata. Row names are set "A13", "A23" and "A33" and column names are set to be the values in BEAR.
See Also
seasonder_validateCalibrationMatrixSeaSondeRAPM
,
seasonder_initializeAttributesSeaSondeRAPM
Examples
# Create a test SeaSondeRAPM object by reading sample file
apm_file <- system.file("css_data/MeasPattern.txt", package = "SeaSondeR")
obj <- seasonder_readSeaSondeRAPMFile(apm_file)