Skip to contents

Initialize SeaSondeR MUSIC Data Structure

Source: R/SeaSondeRCS_MUSIC.R
seasonder_initSeaSondeRCS_MUSIC.Rd

This function initializes a data structure for storing MUSIC analysis results for a given SeaSondeR cross-spectral object.

Usage

seasonder_initSeaSondeRCS_MUSIC(
  seasonder_cs_object,
  range_cells = NULL,
  doppler_bins = NULL
)

Arguments

seasonder_cs_object

A SeaSondeR cross-spectral object containing metadata about the radar system.

range_cells

An optional vector specifying the range cells to include. Defaults to all range cells in the object.

doppler_bins

An optional vector specifying the Doppler bins to include. Defaults to all Doppler bins in the object.

Value

A tibble with initialized MUSIC analysis data for the specified range cells and Doppler bins.

Details

The function creates a tibble with pre-computed range, frequency, and radial velocity values for the specified range cells and Doppler bins. It also initializes placeholders for MUSIC-related parameters such as covariance matrices, eigen decompositions, projections, DOA solutions, and more.

Columns in the resulting tibble include:

  • range_cell: Range cell indices.

  • doppler_bin: Doppler bin indices.

  • range: Computed range values for the specified range cells.

  • freq: Computed frequency values for the specified Doppler bins.

  • radial_v: Computed radial velocities for the specified Doppler bins.

  • cov: Initialized covariance matrices (see seasonder_MUSICInitCov).

  • eigen: Initialized eigen decompositions (see seasonder_MUSICInitEigenDecomp).

  • projections: Initialized projection matrices (see seasonder_MUSICInitProjections).

  • DOA_solutions: Initialized DOA solutions (see seasonder_MUSICInitDOASolutions).

  • eigen_values_ratio: Placeholder for the ratio of eigenvalues.

  • P1_check: Logical placeholder for the P1 criterion (default is TRUE).

  • retained_solution: Placeholder for the type of retained solution ("dual" by default).

  • DOA: Placeholder for final DOA results.

  • lonlat: Placeholder for longitude and latitude data as a data frame.

See also

seasonder_NULLSeaSondeRCS_MUSIC for a NULL initialized structure. seasonder_MUSICInitCov, seasonder_MUSICInitEigenDecomp, seasonder_MUSICInitProjections, seasonder_MUSICInitDOASolutions for initializing individual components.