Skip to contents

Validate Calibration Matrix for a SeaSondeRAPM Object

Source: R/SeaSondeRAPM.R
seasonder_validateCalibrationMatrixSeaSondeRAPM.Rd

This function validates the input calibration_matrix to ensure it meets the required specifications for use in a SeaSondeRAPM object.

Usage

seasonder_validateCalibrationMatrixSeaSondeRAPM(matrix)

Arguments

matrix

A 3 x b complex matrix for calibration, where b is the number of bearings.

Value

TRUE if the matrix is valid. The function will stop execution and display an error message if the matrix is invalid.

Details

The function performs the following validation checks:

  1. Confirms that the input is a matrix.

  2. Verifies that the matrix has exactly three rows.

  3. Checks that the matrix contains only complex numbers.

If any of these validation steps fail, the function will log a fatal error and stop the execution using rlang::abort.

See also

seasonder_createSeaSondeRAPM

Examples

valid <- seasonder_validateCalibrationMatrixSeaSondeRAPM(
  matrix(complex(real = 1, imaginary = 0), nrow = 3, ncol = 5)
)