seasonder_createSeaSondeRAPM: Create a SeaSondeRAPM Object

In SeaSondeR: Radial Metrics from SeaSonde HF-Radar Data

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 seasonder_initializeAttributesSeaSondeRAPM.

Details

The function performs the following operations:

1. Validates the calibration_matrix with seasonder_validateCalibrationMatrixSeaSondeRAPM.

2. Initializes all other attributes either with default or user-provided values.

3. Merges the initialized attributes into calibration_matrix.

4. 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)

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