seasonder_limitFORCurrentRange {SeaSondeR} | R Documentation |
Limit First Order Region (FOR) Based on Maximum Radial Velocity
Description
This function removes Doppler bins from the detected First Order Region (FOR) if their corresponding radial velocity exceeds a predefined maximum threshold.
Usage
seasonder_limitFORCurrentRange(seasonder_cs_object)
Arguments
seasonder_cs_object |
A |
Details
Steps in Current Range Limiting:
-
Retrieve Maximum Velocity Threshold:
Extracts the
currmax
parameter fromseasonder_getFOR_parameters
.
-
Obtain Current FOR Detection Results:
Retrieves the existing FOR Doppler bin indices from
seasonder_getSeaSondeRCS_FOR
.
-
Compute Radial Velocities for Doppler Bins:
Calls
seasonder_getBinsRadialVelocity
to convert Doppler bins into radial velocities.
-
Identify Bins Exceeding Maximum Velocity:
Finds the Doppler bins where the absolute radial velocity is greater than or equal to
currmax
.
-
Filter Out Exceeding Bins:
Uses
setdiff
to remove bins exceedingcurrmax
from the FOR region.
-
Store Updated FOR Data in Object:
Updates the
SeaSondeRCS
object with the filtered FOR results.
This function ensures that only Doppler bins corresponding to physically realistic radial velocities are included in the first-order Bragg region.
Value
The updated SeaSondeRCS
object with the FOR bins filtered based on maximum velocity.
See Also
-
seasonder_getBinsRadialVelocity
for computing radial velocities. -
seasonder_getSeaSondeRCS_FOR
for retrieving FOR bin indices. -
seasonder_setSeaSondeRCS_FOR
for storing updated FOR data.