Radial Metrics from SeaSonde HF-Radar Data
Read SeaSonde CS File Header V6
Read and Parse a SeaSonde APM File
Assigment pipe
Convert dB Values to Self-Spectra Power
Create a New SeaSondeRCS Object
Parse a Metadata Line from a SeaSonde APM File
Pipe operator
Print a SeaSondeRAPM Object
Print Method for SeaSondeRCS Object
Process a Specific Version of the SeaSonde File Header
Quality Control - Check Range and Type
Quality Control - Check Type
Quality Control Check for Unsigned Values
Read and Quality Control a Single Field
Read a Row from a Matrix Represented as Text Lines
Read Version 6 Block Data
Apply Amplitude and Phase Corrections to a SeaSonde RAPM Object
Apply CSSW Sign Corrections
Check if log recording is enabled in SeaSondeR
Check if message logging is enabled in SeaSondeR
Convert SeaSondeRCS Object to JSON
Convert SeaSondeRCS Object to JSON
Convert Doppler Bins to Doppler Frequencies
Convert Doppler Bins to Normalized Doppler Frequency
Validate Field Specifications
Compute Antenna Pattern Projections for the MUSIC Algorithm
Compute Radial Velocities for Doppler Bins
Compute the Center Doppler Bin
Compute Doppler Bins Frequencies
Convert Doppler Frequencies to Doppler Bins
Compute First Order Regions (FOR) Based on Selected Method
Compute First Order Regions (FOR) Using the SeaSonde Method
Compute Geographic Coordinates from Origin, Distance, and Bearing
Compute Noise Level for First Order Region (FOR) Processing
Compute Power Matrix
Create a SeaSondeRAPM Object
Create a SeaSondeRCS object from a file path
Create a SeaSondeRCS object from a list
Create a SeaSondeRCS object
Read Self Spectra Sign Information from a Connection
Transform CSSW Body to SeaSonde CS Data Structure
Transform CSSW Header to SeaSonde CS Header
Read Self Spectra Sign Information from a Connection
Read Complex Spectral Sign Information from a Connection
Transform CSSY Body to SeaSonde CS Data Structure
Transform CSSY Header to SeaSondeRCS Header
Default First-Order Radial Processing Parameters
Default Parameters for MUSIC Algorithm
Default Options for the MUSIC Algorithm
Get the Default Specifications File Path
Get the Default Specifications Path for a Spectra File
Disable all debug points in SeaSondeR
Disable log recording in SeaSondeR
Disable message logging in SeaSondeR
Convert Doppler Frequencies to Doppler Bins
Convert Doppler Frequencies to Normalized Doppler Frequencies
Enable debug points in SeaSondeR
Enable log recording in SeaSondeR
Enable message logging in SeaSondeR
Estimate Reference Noise Limits in Normalized Doppler Frequency
Export MUSIC Table to CSV
Export CTF Range Information to a File
Export LLUV Radial Metrics to a File
Export MUSIC Table from SeaSondeRCS Object
Export Radial Metrics from a SeaSondeRCS Object
Export Range Information from a SeaSondeRCS Object
Extract First Order Region (FOR) Spectral Data
Extract Doppler Ranges from Self-Spectra Data Matrix
Extrapolate SeaSondeR APM Matrix
Filter First Order Region (FOR) Based on Amplitude Thresholds
Determine the Spectra File Type
Identify Nulls in First Order Region (FOR) Across All Range Cells
Find Nulls in First Order Region (FOR)
Identify Nulls in First Order Region (FOR) Spectrum
Identify Nulls in First Order Region (FOR) for a Self-Spectra Matrix
Get enabled debug points in SeaSondeR
Calculate Radial Velocities for Each Doppler Bin
Calculate the Bragg Doppler Angular Frequency
Get Bragg Line Doppler Bins
Calculate the Bragg Wavelength
Retrieve Center Doppler Bin
Retrieve Center Frequency in MHz
Retrieve a value from the SeaSondeRCS header by a specific path
Get Doppler Bins Frequency
Calculate the Doppler Spectrum Resolution
Retrieve FOR Maximum Radial Velocity Limit (currmax)
Retrieve FOR Power Dropoff Threshold (fdown)
Retrieve FOR Null Limit (flim)
Retrieve FOR Noise Factor (noisefact)
Retrieve FOR Doppler Smoothing Factor (nsm)
Retrieve First Order Region (FOR) Parameters
Retrieve a Specific FOR Parameter
Retrieve the Last Logs
Retrieve the MUSIC Configuration from a SeaSondeRCS Object
Retrieve the Doppler Interpolation Factor from MUSIC Options
Retrieve Proportion of Dual Solutions from MUSIC Data
Retrieve Interpolated MUSIC Data from a SeaSondeRCS Object
Retrieve Interpolated Doppler Cells Index from a SeaSondeRCS Object
Retrieve MUSIC Options from a SeaSondeRCS Object
Get the nDopplerCells value from a SeaSondeRCS object
Get the nRangeCells value from a SeaSondeRCS object
Calculate the Radar Wavelength
Calculate the Radar Wave Number
Calculate Radial Velocity Resolution
Retrieve Receiver Gain in Decibels
Getter for AmplitudeFactors
Getter for AntennaBearing
Getter for BEAR
Getter for BearingResolution
Getter for CommentLine
Getter for CreateTimeStamp
Getter for Creator
Getter for FileID
Getter for FileName
Getter for PhaseCorrections
Getter for ProcessingSteps
Getter for quality_matrix
Getter for SiteName
Getter for SiteOrigin
Getter for Smoothing
Getter for StationCode
Getter for Type
Retrieve Self-Spectra Data for a Specific Antenna from a SeaSondeRCS O...
Retrieve the APM Attribute from a SeaSondeRCS Object
Getter for data
Retrieve a Specific Data Matrix from a SeaSondeRCS Object
Retrieve Smoothed Self-Spectra for First Order Region (FOR)
Retrieve First Order Region (FOR) Data from SeaSondeRCS Object
Retrieve First Order Region (FOR) Configuration from a SeaSondeRCS Obj...
Getter for header
Retrieve a Specific Field from a SeaSondeRCS Header
Retrieve Radial Velocities for MUSIC Doppler Bins
Retrieve the Center Doppler Bin for MUSIC Analysis
Calculate Doppler Bins Frequencies for MUSIC Analysis
Retrieve the Adjusted Doppler Spectrum Resolution for MUSIC Analysis
Retrieve the Interpolated Number of Doppler Cells for MUSIC
Retrieve MUSIC Parameters from a SeaSondeRCS Object
Retrieve MUSIC Data from a SeaSondeRCS Object
Getter for ProcessingSteps
Retrieve the Reference Noise Normalized Limits Estimation Interval
Retrieve Self-Spectra Power Matrices for Specified Antenna, Range, and...
Get the version value from a SeaSondeR object
Get the version value from a SeaSondeRAPM object
Get the version value from a SeaSondeRCS object
Initialize Cross-Spectra Data Structure for SeaSondeR
Initialize Attributes for a SeaSondeRAPM Object
Initialize MUSIC Data for SeaSondeR
Initialize SeaSondeR MUSIC Data Structure
Convert an integer to raw bytes using a 64-bit representation
Check if a debug point is enabled in SeaSondeR
Retrieve the Last Log Entry
Limit First Order Region (FOR) Based on Maximum Radial Velocity
seasonder_log function
Log and Abort Message in SeaSondeR
Log and Inform Message in SeaSondeR
Archive Log Entries
Map Doppler Bins to Doppler Frequencies
Map Doppler Frequencies to Doppler Bins
Convert MUSIC Bearings to Geographic Bearings
Validate Eigenvalue Ratio Using MUSIC Algorithm
Validate Signal Matrix Power Ratios Using MUSIC Algorithm
Validate Signal Power Ratios Using MUSIC Algorithm
Calculate the MUSIC Covariance Matrix for each Given Cell Range and Do...
Compute DOA Functions Using the MUSIC Algorithm
Compute the Proportion of Dual Solutions in MUSIC Data
Compute Signal Power Matrix for MUSIC Algorithm
Eigen Decomposition of the MUSIC Covariance Matrix
Extract Direction of Arrival (DOA) Solutions Using the MUSIC Algorithm
Extract and Validate DOA Peaks Using MUSIC Algorithm
Validate Retained Solution in MUSIC Algorithm Peak Extraction
Initialize Covariance Matrix for MUSIC Algorithm
Initialize Direction of Arrival (DOA) Solutions for MUSIC Algorithm
Initialize Eigenvalue Decomposition Structure for MUSIC Algorithm
Initialize Interpolated Data for MUSIC Algorithm
Initialize Projection Matrix for MUSIC Algorithm
Map MUSIC Bearings to Geographic Coordinates
Select Direction of Arrival (DOA) from MUSIC Algorithm Results
Test Dual-Bearing Solutions Using MUSIC Algorithm
Convert Normalized Doppler Frequencies to Doppler Bins
Convert Normalized Doppler Frequencies to Doppler Frequencies
Initialize NULL Data Structure for SeaSondeR MUSIC Analysis
Plot APM Loops in a Polar Coordinate System
Convert a Raw Vector to a 64-bit Integer
Read Reduced Encoded Data from a Binary Connection
Read a CSField from a Binary Connection
Read CSSW Body
Read a Body Range Cell and Apply Scaling if Required
Read CSSW Fields
Read CSSW File Header
Read CSSW Limits
Read a Body Range Cell and Apply Scaling if Required
Read CSSY File Header
Read Phase Correction File
Read SeaSonde Cross Spectra (CS) File
Read and Apply Quality Control to a Block of Fields
Read SeaSonde Cross Spectra (CS) File Data
Read the SeaSonde CS File Header
Read SeaSonde File Header (Version 1)
Read SeaSonde File Header (Version 2)
Read SeaSonde File Header (Version 3)
Read SeaSonde File Header (Version 4)
Read SeaSonde File Header (Version 5)
Read SeaSonde RCSSW File and Create SeaSondeRCS Object
Read SeaSonde RCSSY File and Create SeaSondeRCS Object
Read Specifications from a YAML File
Apply Distant Bragg Peak Rejection to All Range Cells
Reject Bragg Peaks Far from Expected Bragg Index
Apply Noise/Ionospheric Contamination Test to All Bragg Peaks
Reject Bragg Peaks Due to Noise/Ionospheric Contamination
Structured Restart for Quality Control
Execute the MUSIC Algorithm on a SeaSondeRCS Object
Run MUSIC Algorithm on FOR Data
Plot Self-Spectrum for a SeaSondeRCS Object
Export First Order Region (FOR) Boundaries
Perform Doppler Interpolation for SeaSonde Cross-Spectra Data
Apply Scaling to SeaSondeRCSSW Data
Apply Scaling to SeaSondeRCSSY Data
Convert Self-Spectra to dB Using a SeaSondeR Object
Set FOR Maximum Velocity (currmax)
Set FOR Dropoff Threshold (fdown)
Set FOR Null Limit (flim)
Set FOR Noise Factor (noisefact)
Set FOR Doppler Smoothing Factor (nsm)
Set First Order Region (FOR) Parameters for a SeaSondeRCS Object
Set a Specific FOR Parameter for a SeaSondeRCS Object
Set a Specific MUSIC Option for a SeaSondeRCS Object
Set MUSIC Options for a SeaSondeRCS Object
Set Noise Level Estimation Interval for a SeaSondeRCS Object
Setter for AmplitudeFactors
Setter for AntennaBearing
Setter for BEAR
Setter for BearingResolution
Setter for CommentLine
Setter for CreateTimeStamp
Setter for Creator
Setter for FileID
Setter for FileName
Setter for PhaseCorrections
Setter for ProcessingSteps
Setter for quality_matrix
Setter for SiteName
Setter for SiteOrigin
Setter for Smoothing
Setter for StationCode
Setter for Type
Set APM for a SeaSondeRCS Object
Setter for data
Set Maximum Power Bin Indices for First Order Region (FOR)
Set Maximum Power (MAXP) for First Order Region (FOR)
Set First Order Region Processing Method for SeaSondeRCS Object
Set Smoothed Self-Spectra for First Order Region (FOR)
Set First Order Region Data in a SeaSondeRCS Object
Setter for header
Set the Doppler Interpolation Factor in a SeaSondeRCS Object
Set Dual Solutions Proportion for MUSIC Analysis
Set Interpolated MUSIC Data in a SeaSondeRCS Object
Set MUSIC Parameters for a SeaSondeRCS Object
Set MUSIC Data in a SeaSondeRCS Object
Set Noise Level for SeaSondeRCS Object
Setter for ProcessingSteps
Skip Reading a CSField and Return a Specified Value
Skip SeaSonde Cross Spectra (CS) File Reading
Smooth APM Data
Smooth Self-Spectra for First Order Region (FOR)
Smooth Self-Spectra Matrix Using a Sliding Window
Split Logs Based on Time Thresholds
Convert Between Different Doppler Frequency Units
Trim APM Data
Trigger Restart for Skipping Transformation
Validate Attributes for a SeaSondeRAPM Object
Validate Calibration Matrix for a SeaSondeRAPM Object
Validate the Data Structure of CrossSpectra Data
Validate SeaSondeR CS File Data
Validate the Header of CrossSpectra Data
Validate First Order Region (FOR) Parameters
Validate First Order Region (FOR) Processing Method
Generate Amplitude and Phase Corrections Step Text
Generate Amplitude Factors Override Step Text
Generate Antenna Bearing Override Step Text
Generate Creation Step Text
Generate Phase Correction Override Step Text
Generate SiteOrigin Override Step Text
Generate Smoothing Step Text
Generate Trimming Step Text
Generate Creation Step Text
Validate Doppler Interpolation Factor for SeaSondeRCS Objects
Convert Self-Spectra Power to dB
Summarizes a SeaSondeRAPM Object
Summary Method for SeaSondeRCS Object
Validate AmplitudeFactors Attribute for a SeaSondeRAPM Object
Validate AntennaBearing Attribute for a SeaSondeRAPM Object
Validate BEAR Attribute for a SeaSondeRAPM Object
Validate BearingResolution Attribute for a SeaSondeRAPM Object
Validate CommentLine Attribute for a SeaSondeRAPM Object
Validate CreateTimeStamp Attribute for a SeaSondeRAPM Object
Validate Creator Attribute for a SeaSondeRAPM Object
Validate FileID Attribute for a SeaSondeRAPM Object
Validate FileName Attribute for a SeaSondeRAPM Object
Validate PhaseCorrections Attribute for a SeaSondeRAPM Object
Validate ProcessingSteps Attribute for a SeaSondeRAPM Object
Validate quality_matrix Attribute for a SeaSondeRAPM Object
Validate SiteName Attribute for a SeaSondeRAPM Object
Validate SiteOrigin Attribute for a SeaSondeRAPM Object
Validate Smoothing Attribute for a SeaSondeRAPM Object
Validate StationCode Attribute for a SeaSondeRAPM Object
Validate Type Attribute for a SeaSondeRAPM Object
Validate ProcessingSteps Attribute for a SeaSondeRCS Object
Read CODAR's SeaSonde High-Frequency Radar spectra files, compute radial metrics, and generate plots for spectra and antenna pattern data. Implementation is based in technical manuals, publications and patents, please refer to the following documents for more information: Barrick and Lipa (1999) <https://codar.com/images/about/patents/05990834.PDF>; CODAR Ocean Sensors (2002) <http://support.codar.com/Technicians_Information_Page_for_SeaSondes/Docs/Informative/FirstOrder_Settings.pdf>; Lipa et al. (2006) <doi:10.1109/joe.2006.886104>; Paolo et al. (2007) <doi:10.1109/oceans.2007.4449265>; CODAR Ocean Sensors (2009a) <http://support.codar.com/Technicians_Information_Page_for_SeaSondes/Docs/GuidesToFileFormats/File_AntennaPattern.pdf>; CODAR Ocean Sensors (2009b) <http://support.codar.com/Technicians_Information_Page_for_SeaSondes/Docs/GuidesToFileFormats/File_CrossSpectraReduced.pdf>; CODAR Ocean Sensors (2016a) <http://support.codar.com/Technicians_Information_Page_for_SeaSondes/Manuals_Documentation_Release_8/File_Formats/File_Cross_Spectra_V6.pdf>; CODAR Ocean Sensors (2016b) <http://support.codar.com/Technicians_Information_Page_for_SeaSondes/Manuals_Documentation_Release_8/File_Formats/FIle_Reduced_Spectra.pdf>; CODAR Ocean Sensors (2016c) <http://support.codar.com/Technicians_Information_Page_for_SeaSondes/Manuals_Documentation_Release_8/Application_Guides/Guide_SpectraPlotterMap.pdf>; Bushnell and Worthington (2022) <doi:10.25923/4c5x-g538>.
Useful links