seasonder_computeFORsSeaSondeMethod: Compute First Order Regions (FOR) Using the SeaSonde Method

View source: R/SeaSondeRCS_FOR.R

seasonder_computeFORsSeaSondeMethodR Documentation

Compute First Order Regions (FOR) Using the SeaSonde Method

Description

This function processes a SeaSondeRCS object to compute the First Order Regions (FOR) using the SeaSonde method. The workflow includes detecting null points, filtering amplitudes, limiting currents to a maximum range, and rejecting peaks based on proximity to Bragg indices and noise/ionospheric contamination.

Usage

seasonder_computeFORsSeaSondeMethod(seasonder_cs_object)

Arguments

seasonder_cs_object

A SeaSondeRCS object containing the spectral data and configuration parameters.

Details

Workflow Steps:

  1. Initialize Processing Steps:

    • Marks the start of the SeaSonde method processing in the object's metadata.

  2. Detect Null Points:

    • Locates the nulls defining the First Order Regions (FOR) using seasonder_findFORNulls.

  3. Filter Amplitudes:

    • Removes regions with insufficient amplitudes using seasonder_filterFORAmplitudes.

  4. Limit Currents to Maximum Range:

    • Ensures that currents exceed the configured maximum radial velocity using seasonder_limitFORCurrentRange.

  5. Reject Distant Bragg Peaks:

    • If enabled, rejects peaks that are too far from Bragg indices using seasonder_rejectDistantBragg.

  6. Reject Noise/Ionospheric Peaks:

    • If enabled, removes peaks where non-Bragg power significantly exceeds Bragg power using seasonder_rejectNoiseIonospheric.

  7. Finalize Processing Steps:

    • Marks the end of the SeaSonde method processing in the object's metadata.

Use Case: This function is designed for processing SeaSonde radar data to accurately identify and validate the First Order Regions, ensuring reliable current and wave measurements.

Value

The updated SeaSondeRCS object with the computed First Order Regions (FOR).

See Also

  • seasonder_findFORNulls for detecting nulls in the FOR.

  • seasonder_filterFORAmplitudes for amplitude filtering.

  • seasonder_limitFORCurrentRange for limiting radial velocity.

  • seasonder_rejectDistantBragg for rejecting distant Bragg peaks.

  • seasonder_rejectNoiseIonospheric for rejecting noise/ionospheric contamination.


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