rsl_get_sweep
This function returns a structure containing the requested sweep. The base scan is returned
by default.
Syntax
sweep = rsl_get_sweep(volume [, elevation] [, SWEEP_NUMBER=sweepnumber] [, SWEEP_INDEX=sweepindex])
Inputs
volume |
a volume structure. |
elevation |
this optional argument can be used to select a sweep by elevation angle.
The sweep at elevation (in degrees) closest to this value is returned. If
this argument is omitted and neither of the keywords SWEEP_NUMBER or
SWEEP_INDEX (described below) is used, the base scan is returned.
|
Keyword parameters
SWEEP_INDEX |
this keyword parameter can be used to select a sweep by index number,
where 0 is the base scan. If both elevation and SWEEP_INDEX
are given, elevation is used.
|
SWEEP_NUMBER |
sweep number, where 1 is the base scan. If both elevation
and SWEEP_NUMBER are given, elevation is used.
|
Example 1
Get the base scan sweep.
volume = rsl_get_volume(radar)
sweep = rsl_get_sweep(volume)
Example 2
Get the sweep closest to elevation 1.5 degrees.
sweep = rsl_get_sweep(volume, 1.5)
Example 3
To get the sweep at the second tilt, use either of the following:
sweep = rsl_get_sweep(volume, sweep_num=2)
or
sweep = rsl_get_sweep(volume, sweep_index=1)