You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/source/index.rst
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,6 +72,7 @@ The core of Pyrad is based on Py-ART. Py-ART was originally developed in the con
72
72
73
73
* J. Figueras i Ventura, M. Lainer, Z. Schauwecker, J. Grazioli, U. Germann, (2020). Pyrad: A Real-Time Weather Radar Data Processing Framework Based on Py-ART. Journal of Open Research Software, 8(1), p.28. DOI: http://doi.org/10.5334/jors.330
DataTypeIDInFiles STRUCT Structure of strings defining the mapping between pyrad names and variable names in input files. If not provided it will be expected that the name in the files are the standard py-ART names (defined in the py-ART config file). If you process multiple radars, you can append the index of the radar to DataTypeIDInFiles: DataTypeIDInFiles1, will be used for radar 1, DataTypeIDInFiles2, for radar 2, and so on. If you don't add this index, the same DataTypeIDInFiles struc will be used for all radars. An example of such a struct could be:
16
-
- dBZ STRING DBZ
17
-
- ZDR STRING ZDR
18
-
- RhoHV STRING RHOHV
19
-
- PhiDP STRING PHIDP
20
-
- KDP STRING KDP
21
-
- V STRING VEL
22
-
- W STRING WIDTH
23
-
AntennaGaindB FLOAT Antenna gain [dB].
24
-
ScanList STRARR A list with the scans used for this data processing. Note that the first scan in this list is used as master scan. The master scan must be the first (temporal) scan of the corresponding rainbow task. In case of composite volumes the master scan is usually a PPI and the following are RHIs. If the radar processed is MCH C-band the scan list consists of the radar elevation (i.e., from 001 to 020). All scan names must have a trailing '/' except if rad4alp data is processed.
25
-
ScanPeriod FLOAT Repetition period of each scan in minutes.
26
-
Azimtol FLOAT Tolerance in azimuth for irregular data. (0.5 is a good value).
27
-
clutterMap STRING Clutter map of the data processing. The clutter map is located at ``<configpath>/clutter/<clutterMap>``.
28
-
AntennaGain FLOAT Radar antenna gain. Not used for X-band MCH data.
29
-
radarconsth(v) FLOAT Radar constant h (v). Not mandatory.
30
-
mflossh(v) FLOAT Matched filter losses h (v). Not mandatory.
31
-
attg FLOAT Gas attenuation coefficient (units? (1 way attenuation)).
32
-
IconRunFreq INT Frequency of a Icon model run in hours.
33
-
IconForecasted INT Hours forecasted by the Icon model.
34
-
rmax FLOAT For C-band data, the maximum range in [m] to be considered. Useful for speed considerations.
35
-
elmax FLOAT Maximum elevation [°] to consider.
36
-
ppiImageConfig STRUCT Structure defining the PPI image generating (PPI_IMAGE or PSEUDOPPI_IMAGE products). The following 6 fields are described below:
37
-
- xsize INT Number of horizontal pixels of the picture (without frame).
38
-
- ysize INT Number of vertical pixels of the picture (without frame).
39
-
- xmin FLOAT Distance of the left image boundary to the radar in km.
40
-
- xmax FLOAT Distance of the right image boundary to the radar in km.
41
-
- ymin FLOAT Distance of the lower image boundary to the radar in km.
42
-
- ymax FLOAT Distance of the upper image boundary to the radar in km.
43
-
- dpi INT Resolution of the image in dots per inch.
44
-
rhiImageConfig STRUCT Structure defining the RHI image generating (RHI_IMAGE or PSEUDORHI_IMAGE products). The following 6 fields are described below:
45
-
- xsize INT Number of horizontal pixels of the picture (without frame).
46
-
- ysize INT Number of vertical pixels of the picture (without frame).
47
-
- xmin FLOAT Distance of the left image boundary to the radar in km.
48
-
- xmax FLOAT Distance of the right image boundary to the radar in km.
49
-
- ymin FLOAT Distance of the lower image boundary (vertical direction) to the radar in km.
50
-
- ymax FLOAT Distance of the upper image boundary (vertical direction) to the radar in km.
51
-
- dpi INT Resolution of the image in dots per inch.
52
-
ppiMapImageConfig STRUCT Structure defining the PPI image overlaid on a map (PPI_MAP product). The following 9 fields are described below:
53
-
- rngRing FLOAT Distance between range rings (0 means no range ring) [km].
54
-
- xsize FLOAT Image size (inches) [inch].
55
-
- ysize FLOAT Image size (inches) [inch].
56
-
- lonmin FLOAT Minimum WGS84 longitude [°].
57
-
- lonmax FLOAT Maximum WGS84 longitude [°].
58
-
- latmin FLOAT Minimum WGS84 latitude [°].
59
-
- latmax FLOAT Maximum WGS84 latitude [°].
60
-
- latstep FLOAT Step in latitude [°] used in the map gridlines.
61
-
- lonstep FLOAT Step in longitude [°] used in the map gridlines.
62
-
- exact_limits INT If set to 1 will use exactly the user-specified latmin/latmax, lonmin/lonmax, if set to 0 will round them to the nearest integer.
- dpi INT Resolution of the image in dots per inch.
81
-
xsecImageConfig STRUCT Structure defining the cross-section images generated from gridded data (CROSS_SECTION, LATITUDE_SLICE and LONGITUDE_SLICE products)
82
-
- xsize INT Number of horizontal pixels of the picture (without frame).
83
-
- ysize INT Number of vertical pixels of the picture (without frame).
84
-
- xmin FLOAT Distance of the left image boundary to the radar in km.
85
-
- xmax FLOAT Distance of the right image boundary to the radar in km.
86
-
- ymin FLOAT Distance of the lower image boundary (vertical direction) to the radar in km.
87
-
- ymax FLOAT Distance of the upper image boundary (vertical direction) to the radar in km.
88
-
- dpi INT Resolution of the image in dots per inch.
89
-
spectraImageConfig STRUCT Structure defining the Doppler spectral plots:
90
-
- xsize INT Number of horizontal pixels of the picture (without frame).
91
-
- ysize INT Number of vertical pixels of the picture (without frame).
92
-
- ymin FLOAT Minimum range above radar [km]
93
-
- ymax FLOAT Maximum range above radar [km]
94
-
- velmin FLOAT Minimum Doppler velocity that should be displayed.
95
-
- velmax FLOAT Maximum Doppler velocity that should be displayed.
96
-
- dpi INT Resolution of the image in dots per inch.
97
-
sunhitsImageConfig STRUCT Structure defining the sun hits image. The following 6 fields are described below:
98
-
- xsize INT Number of horizontal pixels of the picture (without frame).
99
-
- ysize INT Number of vertical pixels of the picture (without frame).
100
-
- xmin FLOAT Minimum azimuth angle difference (between sun and radar).
101
-
- xmax FLOAT Maximum azimuth angle difference (between sun and radar).
102
-
- ymin FLOAT Minimum elevation angle difference (between sun and radar).
103
-
- ymax FLOAT Maximum azimuth angle difference (between sun and radar).
104
-
- dpi INT Resolution of the image in dots per inch.
105
-
azPatternFile STRING Name of the azimuth pattern file of the antenna. This file and path must be ``<configpath>/antenna/<azPatternFile>``.
106
-
elPatternFile STRING Name of the elevation pattern file of the antenna. This file and path must be ``<configpath>/antenna/<elPatternFile>``.
107
-
fixed_angle FLOAT Fixed angle of a PAR antenna in degrees. For the PAR azimuth antenna this is the elevation angle. For the elevation antenna it is the azimuth angle.
- Short version name of a C-band radar (i.e., A, D, L, P) or DX50, MXPol for the X-band radars.
19
+
* - RadarRes
20
+
- STRING
21
+
- rad4alp radar resolution (H or L). Only necessary if rad4alp (swiss C-band) data is processed.
22
+
* - RadarBeamwidth
23
+
- FLOAT
24
+
- Radar antenna beam width [Deg].
25
+
* - DataTypeIDInFiles
26
+
- STRUCT
27
+
- Structure of strings defining the mapping between pyrad names and variable names in input files. If not provided it will be expected that the name in the files are the standard py-ART names (defined in the py-ART config file). If you process multiple radars, you can append the index of the radar to DataTypeIDInFiles: DataTypeIDInFiles1, will be used for radar 1, DataTypeIDInFiles2, for radar 2, and so on. If you don't add this index, the same DataTypeIDInFiles struc will be used for all radars. An example of such a struct could be:
112
28
29
+
- dBZ: DBZ
30
+
- ZDR: ZDR
31
+
- RhoHV: RHOHV
32
+
- PhiDP: PHIDP
33
+
- KDP: KDP
34
+
- V: VEL
35
+
- W: WIDTH
36
+
* - AntennaGaindB
37
+
- FLOAT
38
+
- Antenna gain [dB].
39
+
* - ScanList
40
+
- STRARR
41
+
- A list with the scans used for this data processing. Note that the first scan in this list is used as master scan. The master scan must be the first (temporal) scan of the corresponding rainbow task. In case of composite volumes the master scan is usually a PPI and the following are RHIs. If the radar processed is MCH C-band the scan list consists of the radar elevation (i.e., from 001 to 020). All scan names must have a trailing '/' except if rad4alp data is processed.
42
+
* - ScanPeriod
43
+
- FLOAT
44
+
- Repetition period of each scan in minutes.
45
+
* - MasterScanTimeTol
46
+
- INT
47
+
- Add a tolerance to the scan times when creating radar volumes. If set to 1 will consider all scans which timestamp falls within T0 to T0 + ScanPeriod as belonging to the same volume. If set to -1 will consider all scans which timestamp falls within T0 - ScanPeriod to T0 as belonging to the same volume. T0 = timestamp of masterscan. Default is 0 (= no tolerance)
48
+
* - Azimtol
49
+
- FLOAT
50
+
- Tolerance in azimuth for irregular data. (0.5 is a good value).
51
+
* - clutterMap
52
+
- STRING
53
+
- Clutter map of the data processing. The clutter map is located at ``<configpath>/clutter/<clutterMap>``.
54
+
* - AntennaGain
55
+
- FLOAT
56
+
- Radar antenna gain. Not used for X-band MCH data.
57
+
* - radarconsth(v)
58
+
- FLOAT
59
+
- Radar constant h (v). Not mandatory.
60
+
* - mflossh(v)
61
+
- FLOAT
62
+
- Matched filter losses h (v). Not mandatory.
63
+
* - attg
64
+
- FLOAT
65
+
- Gas attenuation coefficient (units? (1 way attenuation)).
66
+
* - IconRunFreq
67
+
- INT
68
+
- Frequency of a Icon model run in hours.
69
+
* - IconForecasted
70
+
- INT
71
+
- Hours forecasted by the Icon model.
72
+
* - rmax
73
+
- FLOAT
74
+
- For C-band data, the maximum range in [m] to be considered. Useful for speed considerations.
75
+
* - elmax
76
+
- FLOAT
77
+
- Maximum elevation [°] to consider.
78
+
* - ppiImageConfig
79
+
- STRUCT
80
+
- Structure defining the PPI image generating (PPI_IMAGE or PSEUDOPPI_IMAGE products).
81
+
* - rhiImageConfig
82
+
- STRUCT
83
+
- Structure defining the RHI image generating (RHI_IMAGE or PSEUDORHI_IMAGE products).
84
+
* - ppiMapImageConfig
85
+
- STRUCT
86
+
- Structure defining the PPI image overlaid on a map (PPI_MAP product).
87
+
* - gridMapImageConfig
88
+
- STRUCT
89
+
- Structure defining the display of gridded data overlaid on a map (SURFACE_IMAGE product).
90
+
* - xsecImageConfig
91
+
- STRUCT
92
+
- Structure defining the cross-section images generated from gridded data (CROSS_SECTION, LATITUDE_SLICE and LONGITUDE_SLICE products).
93
+
* - spectraImageConfig
94
+
- STRUCT
95
+
- Structure defining the Doppler spectral plots.
96
+
* - sunhitsImageConfig
97
+
- STRUCT
98
+
- Structure defining the sun hits image.
99
+
* - azPatternFile
100
+
- STRING
101
+
- Name of the azimuth pattern file of the antenna. This file and path must be ``<configpath>/antenna/<azPatternFile>``.
102
+
* - elPatternFile
103
+
- STRING
104
+
- Name of the elevation pattern file of the antenna. This file and path must be ``<configpath>/antenna/<elPatternFile>``.
105
+
* - fixed_angle
106
+
- FLOAT
107
+
- Fixed angle of a PAR antenna in degrees. For the PAR azimuth antenna this is the elevation angle. For the elevation antenna it is the azimuth angle.
0 commit comments