@@ -65,7 +65,9 @@ def process_turbulence(procstatus, dscfg, radar_list=None):
6565 data set configuration. Accepted Configuration Keywords::
6666
6767 datatype : string. Dataset keyword
68- The input data type
68+ The input data type, must contain,
69+ "dBuZ" or "dBZ" or "dBZc" or "dBuZv" or "dBZv" or "dBZvc" or "CNRc", and,
70+ "W" or "Wv" or "Wu" or "Wvu" or "WD" or "WDc"
6971 radius : float. Dataset keyword
7072 Search radius for calculating Eddy Dissipation Rate (EDR).
7173 Default 2
@@ -97,7 +99,7 @@ def process_turbulence(procstatus, dscfg, radar_list=None):
9799 Returns
98100 -------
99101 new_dataset : dict
100- dictionary containing the output
102+ dictionary containing the output field "EDR"
101103 ind_rad : int
102104 radar index
103105
@@ -235,7 +237,8 @@ def process_dealias_fourdd(procstatus, dscfg, radar_list=None):
235237 data set configuration. Accepted Configuration Keywords::
236238
237239 datatype : string. Dataset keyword
238- The input data type
240+ The input data type, must contain
241+ "V" or "Vc"
239242 filt : int. Dataset keyword
240243 Flag controlling Bergen and Albers filter, 1 = yes, 0 = no.
241244 sign : int. Dataset keyword
@@ -252,7 +255,7 @@ def process_dealias_fourdd(procstatus, dscfg, radar_list=None):
252255 Returns
253256 -------
254257 new_dataset : dict
255- dictionary containing the output
258+ dictionary containing the output field "dealV" or "dealVc" (if Vc was provided)
256259 ind_rad : int
257260 radar index
258261
@@ -357,7 +360,8 @@ def process_dealias_region_based(procstatus, dscfg, radar_list=None):
357360 data set configuration. Accepted Configuration Keywords::
358361
359362 datatype : string. Dataset keyword
360- The input data type
363+ The input data type, must contain,
364+ "V" or "Vc"
361365 interval_splits : int, optional
362366 Number of segments to split the nyquist interval into when finding
363367 regions of similar velocity. More splits creates a larger number
@@ -387,7 +391,7 @@ def process_dealias_region_based(procstatus, dscfg, radar_list=None):
387391 Returns
388392 -------
389393 new_dataset : dict
390- dictionary containing the output
394+ dictionary containing the output field "dealV" or "dealVc" (if Vc was provided)
391395 ind_rad : int
392396 radar index
393397
@@ -458,7 +462,8 @@ def process_dealias_unwrap_phase(procstatus, dscfg, radar_list=None):
458462 data set configuration. Accepted Configuration Keywords::
459463
460464 datatype : string. Dataset keyword
461- The input data type
465+ The input data type, must contain,
466+ "V" or "Vc"
462467 unwrap_unit : {'ray', 'sweep', 'volume'}, optional
463468 Unit to unwrap independently. 'ray' will unwrap each ray
464469 individually, 'sweep' each sweep, and 'volume' will unwrap the
@@ -473,7 +478,7 @@ def process_dealias_unwrap_phase(procstatus, dscfg, radar_list=None):
473478 Returns
474479 -------
475480 new_dataset : dict
476- dictionary containing the output
481+ dictionary containing the output field "dealV" or "dealVc" (if Vc was provided)
477482 ind_rad : int
478483 radar index
479484
@@ -534,7 +539,10 @@ def process_radial_velocity(procstatus, dscfg, radar_list=None):
534539 data set configuration. Accepted Configuration Keywords::
535540
536541 datatype : string. Dataset keyword
537- The input data type
542+ The input data type, must contain
543+ WIND_SPEED, and,
544+ WIND_DIRECTION, and,
545+ wind_vel_v
538546 latitude, longitude : float
539547 arbitrary coordinates [deg] from where to compute the radial
540548 velocity. If any of them is None it will be the radar position
@@ -547,7 +555,7 @@ def process_radial_velocity(procstatus, dscfg, radar_list=None):
547555 Returns
548556 -------
549557 new_dataset : dict
550- dictionary containing the output
558+ dictionary containing the output field "V"
551559 ind_rad : int
552560 radar index
553561
@@ -665,7 +673,8 @@ def process_wind_vel(procstatus, dscfg, radar_list=None):
665673 data set configuration. Accepted Configuration Keywords::
666674
667675 datatype : string. Dataset keyword
668- The input data type
676+ The input data type, must contain
677+ "V" or "Vc"
669678 vert_proj : Boolean
670679 If true the vertical projection is computed. Otherwise the
671680 horizontal projection is computed
@@ -675,7 +684,9 @@ def process_wind_vel(procstatus, dscfg, radar_list=None):
675684 Returns
676685 -------
677686 new_dataset : dict
678- dictionary containing the output
687+ dictionary containing the output field
688+ "wind_vel_h_az", (if vert_proj is False), or,
689+ "wind_vel_v" (if vert_proj is True)
679690 ind_rad : int
680691 radar index
681692
@@ -737,7 +748,7 @@ def process_windshear(procstatus, dscfg, radar_list=None):
737748 Returns
738749 -------
739750 new_dataset : dict
740- dictionary containing the output
751+ dictionary containing the output field "windshear_v"
741752 ind_rad : int
742753 radar index
743754
@@ -786,7 +797,8 @@ def process_windshear_lidar(procstatus, dscfg, radar_list=None):
786797 data set configuration. Accepted Configuration Keywords::
787798
788799 datatype : string. Dataset keyword
789- The input data type
800+ The input data type, must contain
801+ "V" or "Vc"
790802 az_tol : float
791803 The tolerance in azimuth when looking for gates on top
792804 of the gate when computation is performed
@@ -797,7 +809,7 @@ def process_windshear_lidar(procstatus, dscfg, radar_list=None):
797809 Returns
798810 -------
799811 new_dataset : dict
800- dictionary containing the output
812+ dictionary containing the output field "windshear_v"
801813 ind_rad : int
802814 radar index
803815
@@ -847,14 +859,17 @@ def process_vad(procstatus, dscfg, radar_list=None):
847859 data set configuration. Accepted Configuration Keywords::
848860
849861 datatype : string. Dataset keyword
850- The input data type
862+ The input data type, must contain
863+ "V" or "Vc"
851864 radar_list : list of Radar objects
852865 Optional. list of radar objects
853866
854867 Returns
855868 -------
856869 new_dataset : dict
857- dictionary containing the output
870+ dictionary containing the output fields
871+ "wind_vel_h_u", "wind_vel_h_v", "wind_vel_v",
872+ "estV", "stdV", and "diffV"
858873 ind_rad : int
859874 radar index
860875
@@ -923,7 +938,9 @@ def process_dda(procstatus, dscfg, radar_list=None):
923938 data set configuration. Accepted Configuration Keywords::
924939
925940 datatype : string. Dataset keyword
926- The input data type
941+ The input data type, must contain
942+ "V" or "Vc", and,
943+ "dBuZ", "dBZ", or "dBZc"
927944
928945 gridconfig : dictionary. Dataset keyword
929946 Dictionary containing some or all of this keywords:
@@ -997,7 +1014,8 @@ def process_dda(procstatus, dscfg, radar_list=None):
9971014 Returns
9981015 -------
9991016 new_dataset : dict
1000- dictionary containing the output
1017+ dictionary containing the output fields
1018+ "wind_vel_h_u", "wind_vel_h_v" and "wind_vel_v"
10011019 ind_rad : int
10021020 radar index
10031021
0 commit comments