Products generation (pyrad.prod
)¶
Initiate the products generation.
Auxiliary functions¶
get_dsformat_func |
Product generation¶
generate_occurrence_products (dataset, prdcfg) |
generates occurrence products. Accepted product types: |
generate_cosmo_coord_products (dataset, prdcfg) |
generates COSMO coordinates products. Accepted product types: |
generate_cosmo_to_radar_products (dataset, prdcfg) |
generates COSMO data in radar coordinates products. |
generate_sun_hits_products (dataset, prdcfg) |
generates sun hits products. Accepted product types: |
generate_intercomp_products (dataset, prdcfg) |
Generates radar intercomparison products. Accepted product types: |
generate_colocated_gates_products (dataset, …) |
Generates colocated gates products. Accepted product types: |
generate_time_avg_products (dataset, prdcfg) |
generates time average products. Accepted product types: |
generate_qvp_products (dataset, prdcfg) |
Generates quasi vertical profile-like products. |
generate_vol_products (dataset, prdcfg) |
Generates radar volume products. Accepted product types: |
generate_timeseries_products (dataset, prdcfg) |
Generates time series products. Accepted product types: |
generate_monitoring_products (dataset, prdcfg) |
generates a monitoring product. |
generate_spectra_products (dataset, prdcfg) |
generates spectra products. Accepted product types: |
generate_grid_products (dataset, prdcfg) |
generates grid products. Accepted product types: |
generate_grid_time_avg_products (dataset, prdcfg) |
generates time average products. Accepted product types: |
generate_traj_product (traj, prdcfg) |
Generates trajectory products. Accepted product types: |
generate_ml_products (dataset, prdcfg) |
Generates melting layer products. Accepted product types: |
-
pyrad.prod.
generate_colocated_gates_products
(dataset, prdcfg)[source]¶ - Generates colocated gates products. Accepted product types:
- ‘WRITE_COLOCATED_GATES’: Writes the position of the co-located gates
- in a csv file
All the products of the ‘VOL’ dataset group
Parameters: - dataset : tuple
radar objects and colocated gates dictionary
- prdcfg : dictionary of dictionaries
product configuration dictionary of dictionaries
Returns: - filename : str
the name of the file created. None otherwise
-
pyrad.prod.
generate_cosmo_coord_products
(dataset, prdcfg)[source]¶ - generates COSMO coordinates products. Accepted product types:
- ‘SAVEVOL’: Save an object containing the index of the COSMO model grid
that corresponds to each radar gate in a C/F radial file. User defined parameters:
- file_type: str
- The type of file used to save the data. Can be ‘nc’ or ‘h5’. Default ‘nc’
- physical: Bool
- If True the data will be saved in physical units (floats). Otherwise it will be quantized and saved as binary
- compression: str
- For ODIM file formats, the type of compression. Can be any of the allowed compression types for hdf5 files. Default gzip
- compression_opts: any
- The compression options allowed by the hdf5. Depends on the type of compression. Default 6 (The gzip compression level).
Parameters: - dataset : tuple
radar object containing the COSMO coordinates
- prdcfg : dictionary of dictionaries
product configuration dictionary of dictionaries
Returns: - filename : str
the name of the file created. None otherwise
-
pyrad.prod.
generate_cosmo_to_radar_products
(dataset, prdcfg)[source]¶ generates COSMO data in radar coordinates products. Accepted product types:
- ‘SAVEVOL’: Save an object containing the COSMO data in radar
- coordinatesin a C/F radial or ODIM file.
User defined parameters: file_type: str
The type of file used to save the data. Can be ‘nc’ or ‘h5’. Default ‘nc’- physical: Bool
- If True the data will be saved in physical units (floats). Otherwise it will be quantized and saved as binary
- compression: str
- For ODIM file formats, the type of compression. Can be any of the allowed compression types for hdf5 files. Default gzip
- compression_opts: any
- The compression options allowed by the hdf5. Depends on the type of compression. Default 6 (The gzip compression level).
All the products of the ‘VOL’ dataset group
Parameters: - dataset : tuple
radar object containing the COSMO coordinates
- prdcfg : dictionary of dictionaries
product configuration dictionary of dictionaries
Returns: - filename : str
the name of the file created. None otherwise
-
pyrad.prod.
generate_grid_products
(dataset, prdcfg)[source]¶ - generates grid products. Accepted product types:
- ‘CROSS_SECTION’: Plots a cross-section of gridded data
- User defined parameters:
- coord1, coord2: dict
- The two lat-lon coordinates marking the limits. They have the keywords ‘lat’ and ‘lon’ [degree]. The altitude limits are defined by the parameters in ‘rhiImageConfig’ in the ‘loc’ configuration file
- ‘HISTOGRAM’: Computes a histogram of the radar volum data
- User defined parameters:
- step: float or None
- the data quantization step. If none it will be obtained from the Py-ART configuration file
- vmin, vmax: float or None
- The minimum and maximum values. If None they will be obtained from the Py-ART configuration file
- mask_val: float or None
- A value to mask.
- write_data: Bool
- If true the histogram data is written in a csv file
- ‘LATITUDE_SLICE’: Plots a cross-section of gridded data over a
constant latitude. User defined parameters:
- lon, lat: floats
- The starting point of the cross-section. The ending point is defined by the parameters in ‘rhiImageConfig’ in the ‘loc’ configuration file
- ‘LONGITUDE_SLICE’: Plots a cross-ection of gridded data over a
constant longitude. User defined parameters:
- lon, lat: floats
- The starting point of the cross-section. The ending point is defined by the parameters in ‘rhiImageConfig’ in the ‘loc’ configuration file
- ‘SAVEALL’: Saves a gridded data object including all or a list of
user-defined fields in a netcdf file User defined parameters:
- datatypes: list of str or None
- The list of data types to save. If it is None, all fields in the radar object will be saved
‘SAVEVOL’: Saves on field of a gridded data object in a netcdf file. ‘STATS’: Computes statistics over the whole images and stores them in
a file. User defined parameters:
- stat: str
- The statistic used. Can be mean, median, min, max
- ‘SURFACE_IMAGE’: Plots a surface image of gridded data.
- User defined parameters:
- level: int
- The altitude level to plot. The rest of the parameters are defined by the parameters in ‘ppiImageConfig’ and ‘ppiMapImageConfig’ in the ‘loc’ configuration file
- ‘SURFACE_CONTOUR’: Plots a surface image of contour gridded data.
- User defined parameters:
- level: int
- The altitude level to plot. The rest of the parameters are defined by the parameters in ‘ppiImageConfig’ and ‘ppiMapImageConfig’ in the ‘loc’ configuration file
- contour_values : float array or None
- The contour values. If None the values are taken from the ‘boundaries’ keyword in the field description in the Py-ART config file. If ‘boundaries’ is not set the countours are 10 values linearly distributed from vmin to vmax
- linewidths : float
- width of the contour lines
- colors : color string or sequence of colors
- The contour colours
- SURFACE_CONTOUR_OVERPLOT:
Plots a surface image of gridded data with a contour overplotted. User defined parameters:
- level: int
- The altitude level to plot. The rest of the parameters are defined by the parameters in ‘ppiImageConfig’ and ‘ppiMapImageConfig’ in the ‘loc’ configuration file
- contour_values : float array or None
- The contour values. If None the values are taken from the ‘boundaries’ keyword in the field description in the Py-ART config file. If ‘boundaries’ is not set the countours are 10 values linearly distributed from vmin to vmax
- linewidths : float
- width of the contour lines
- colors : color string or sequence of colors
- The contour colours
- SURFACE_OVERPLOT:
Plots on the same surface two images, one on top of the other. User defined parameters:
- level: int
- The altitude level to plot. The rest of the parameters are defined by the parameters in ‘ppiImageConfig’ and ‘ppiMapImageConfig’ in the ‘loc’ configuration file
- contour_values : float array or None
- The contour values. If None the values are taken from the ‘boundaries’ keyword in the field description in the Py-ART config file. If ‘boundaries’ is not set the countours are 10 values linearly distributed from vmin to vmax
Parameters: - dataset : grid
grid object
- prdcfg : dictionary of dictionaries
product configuration dictionary of dictionaries
Returns: - None or name of generated files
-
pyrad.prod.
generate_grid_time_avg_products
(dataset, prdcfg)[source]¶ - generates time average products. Accepted product types:
- All the products of the ‘VOL’ dataset group
Parameters: - dataset : tuple
radar objects and colocated gates dictionary
- prdcfg : dictionary of dictionaries
product configuration dictionary of dictionaries
Returns: - filename : str
the name of the file created. None otherwise
-
pyrad.prod.
generate_intercomp_products
(dataset, prdcfg)[source]¶ - Generates radar intercomparison products. Accepted product types:
- ‘PLOT_AND_WRITE_INTERCOMP_TS’: Writes statistics of radar
intercomparison in a file and plots the time series of the statistics. User defined parameters:
- ‘add_date_in_fname’: Bool
- If true adds the year in the csv file containing the statistics. Default False
- ‘sort_by_date’: Bool
- If true sorts the statistics by date when reading the csv file containing the statistics. Default False
- ‘rewrite’: Bool
- If true rewrites the csv file containing the statistics. Default False
- ‘npoints_min’: int
- The minimum number of points to consider the statistics valid and therefore use the data point in the plotting. Default 0
- ‘corr_min’: float
- The minimum correlation to consider the statistics valid and therefore use the data point in the plotting. Default 0.
- ‘PLOT_SCATTER_INTERCOMP’: Plots a density plot with the points of
radar 1 versus the points of radar 2 User defined parameters:
- ‘step’: float
- The quantization step of the data. If none it will be computed using the Py-ART config file. Default None
- ‘scatter_type’: str
- Type of scatter plot. Can be a plot for each radar volume (‘instant’) or at the end of the processing period (‘cumulative’). Default is ‘cumulative’
- ‘WRITE_INTERCOMP’: Writes the instantaneously intercompared data
- (gate positions, values, etc.) in a csv file.
- ‘WRITE_INTERCOMP_TIME_AVG’: Writes the time-averaged intercompared
- data (gate positions, values, etc.) in a csv file.
Parameters: - dataset : tuple
values of colocated gates dictionary
- prdcfg : dictionary of dictionaries
product configuration dictionary of dictionaries
Returns: - filename : str
the name of the file created. None otherwise
-
pyrad.prod.
generate_ml_products
(dataset, prdcfg)[source]¶ - Generates melting layer products. Accepted product types:
- ‘ML_TS’: Plots and writes a time series of the melting layer, i.e.
the evolution of the average and standard deviation of the melting layer top and thickness and the the number of rays used in the retrieval. User defined parameters:
- dpi: int
- The pixel density of the plot. Default 72
- ‘SAVE_ML’: Saves an object containing the melting layer retrieval
- information in a C/F radial file
All the products of the ‘VOL’ dataset group
Parameters: - dataset : dict
dictionary containing the radar object and a keyword stating the status of the processing
- prdcfg : dictionary of dictionaries
product configuration dictionary of dictionaries
Returns: - filename : str
the name of the file created. None otherwise
-
pyrad.prod.
generate_monitoring_products
(dataset, prdcfg)[source]¶ generates a monitoring product. With the parameter ‘hist_type’ the user may define if the product is computed for each radar volume (‘instant’) or at the end of the processing period (‘cumulative’). Default is ‘cumulative’. Accepted product types:
- ‘ANGULAR_DENSITY’: For a specified elevation angle, plots a 2D
histogram with the azimuth angle in the X-axis and the data values in the Y-axis. The reference values and the user defined quantiles are also plot on the same figure User defined parameters:
- anglenr: int
- The elevation angle number to plot
- quantiles: list of floats
- The quantiles to plot. Default 25., 50., 75.
- ref_value: float
- The reference value
- vmin, vmax : floats or None
- The minimum and maximum values of the data points. If not specified they are obtained from the Py-ART config file
- ‘CUMUL_VOL_TS’: Plots time series of the average of instantaneous
quantiles stored in a csv file. User defined parameters:
- quantiles: list of 3 floats
- the quantiles to compute. Default 25., 50., 75.
- ref_value: float
- The reference value. Default 0
- sort_by_date: Bool
- If true when reading the csv file containing the statistics the data is sorted by date. Default False
- rewrite: Bool
- If true the csv file containing the statistics is rewritten
- add_data_in_fname: Bool
- If true and the data used is cumulative the year is written in the csv file name and the plot file name
- npoints_min: int
- Minimum number of points to use the data point in the plotting and to send an alarm. Default 0
- vmin, vmax: float or None
- Limits of the Y-axis (data value). If None the limits are obtained from the Py-ART config file
- alarm: Bool
- If true an alarm is sent
- tol_abs: float
- Margin of tolerance from the reference value. If the current value is above this margin an alarm is sent. If the margin is not specified it is not possible to send any alarm
- tol_trend: float
- Margin of tolerance from the reference value. If the trend of the last X events is above this margin an alarm is sent. If the margin is not specified it is not possible to send any alarm
- nevents_min: int
- Minimum number of events with sufficient points to send an alarm related to the trend. If not specified it is not possible to send any alarm
- sender: str
- The mail of the alarm sender. If not specified it is not possible to send any alarm
- receiver_list: list of str
- The list of emails of the people that will receive the alarm.. If not specified it is not possible to send any alarm
- ‘PPI_HISTOGRAM’: Plots a histogram of data at a particular
elevation angle. User defined parameters:
- anglenr: int
- The elevation angle number to plot
- ‘SAVEVOL’: Saves the monitoring data in a C/F radar file. The data
- field contains histograms of data for each pair of azimuth and elevation angles
- ‘VOL_HISTOGRAM’: Plots a histogram of data collected from all the
radar volume. User defined parameters:
- write_data: bool
- If true the resultant histogram is also saved in a csv file. Default True.
- ‘VOL_TS’: Computes statistics of the gathered data and writes them in
a csv file and plots a time series of those statistics. User defined parameters:
- quantiles: list of 3 floats
- the quantiles to compute. Default 25., 50., 75.
- ref_value: float
- The reference value. Default 0
- sort_by_date: Bool
- If true when reading the csv file containing the statistics the data is sorted by date. Default False
- rewrite: Bool
- If true the csv file containing the statistics is rewritten
- add_data_in_fname: Bool
- If true and the data used is cumulative the year is written in the csv file name and the plot file name
- npoints_min: int
- Minimum number of points to use the data point in the plotting and to send an alarm. Default 0
- vmin, vmax: float or None
- Limits of the Y-axis (data value). If None the limits are obtained from the Py-ART config file
- alarm: Bool
- If true an alarm is sent
- tol_abs: float
- Margin of tolerance from the reference value. If the current value is above this margin an alarm is sent. If the margin is not specified it is not possible to send any alarm
- tol_trend: float
- Margin of tolerance from the reference value. If the trend of the last X events is above this margin an alarm is sent. If the margin is not specified it is not possible to send any alarm
- nevents_min: int
- Minimum number of events with sufficient points to send an alarm related to the trend. If not specified it is not possible to send any alarm
- sender: str
- The mail of the alarm sender. If not specified it is not possible to send any alarm
- receiver_list: list of str
- The list of emails of the people that will receive the alarm.. If not specified it is not possible to send any alarm
Parameters: - dataset : dictionary
dictionary containing a histogram object and some metadata
- prdcfg : dictionary of dictionaries
product configuration dictionary of dictionaries
Returns: - filename : str
the name of the file created. None otherwise
-
pyrad.prod.
generate_occurrence_products
(dataset, prdcfg)[source]¶ - generates occurrence products. Accepted product types:
- ‘WRITE_EXCESS_GATES’: Write the data that identifies radar gates
with clutter that has a frequency of occurrence above a certain threshold. User defined parameters:
- quant_min: float
- Minimum frequency of occurrence in percentage to keep the gate as valid. Default 95.
All the products of the ‘VOL’ dataset group
Parameters: - dataset : tuple
radar object and metadata dictionary
- prdcfg : dictionary of dictionaries
product configuration dictionary of dictionaries
Returns: - filename : str
the name of the file created. None otherwise
-
pyrad.prod.
generate_qvp_products
(dataset, prdcfg)[source]¶ Generates quasi vertical profile-like products. Quasi vertical profiles come from azimuthal averaging of polarimetric radar data. With the variable ‘qvp_type’ the user decides if the product has to be generated at the end of the processing period (‘final’) or instantaneously (‘instant’) Accepted product types:
All the products of the ‘VOL’ dataset groupParameters: - dataset : dict
dictionary containing the radar object and a keyword stating the status of the processing
- prdcfg : dictionary of dictionaries
product configuration dictionary of dictionaries
Returns: - filename : str
the name of the file created. None otherwise
-
pyrad.prod.
generate_spectra_products
(dataset, prdcfg)[source]¶ - generates spectra products. Accepted product types:
- ‘AMPLITUDE_PHASE_ANGLE_DOPPLER’: Makes an angle Doppler plot of
complex spectra or IQ data. The plot can be along azimuth or along range. It is plotted separately the module and the phase of the signal. User defined parameters:
- along_azi : bool
- If true the plot is performed along azimuth, otherwise along elevation. Default true
- ang : float
- The fixed angle (deg). Default 0.
- rng : float
- The fixed range (m). Default 0.
- ang_tol : float
- The fixed angle tolerance (deg). Default 1.
- rng_tol : float
- The fixed range tolerance (m). Default 50.
- xaxis_info : str
- The xaxis type. Can be ‘Doppler_velocity’, ‘Doppler_frequency’ or ‘pulse_number’
- ampli_vmin, ampli_vmax, phase_vmin, phase_vmax : float or None
- Minimum and maximum of the color scale for the module and phase
- ‘AMPLITUDE_PHASE_DOPPLER’: Plots a complex Doppler spectrum or IQ data
making two separate plots for the module and phase of the signal User defined parameters:
- azi, ele, rng : float
- azimuth and elevation (deg) and range (m) of the ray to plot
- azi_to, ele_tol, rng_tol : float
- azimuth and elevation (deg) and range (m) tolerance respect to nominal position to plot. Default 1, 1, 50.
- ind_ray, ind_rng : int
- index of the ray and range to plot. Alternative to defining its antenna coordinates
- xaxis_info : str
- The xaxis type. Can be ‘Doppler_velocity’, ‘Doppler_frequency’ or ‘pulse_number’
- ampli_vmin, ampli_vmax, phase_vmin, phase_vmax : float or None
- Minimum and maximum of the color scale for the module and phase
- ‘AMPLITUDE_PHASE_RANGE_DOPPLER’: Plots a complex spectra or IQ data
range-Doppler making two separate plots for the module and phase of the signal User defined parameters:
- azi, ele : float
- azimuth and elevation (deg) of the ray to plot
- azi_to, ele_tol : float
- azimuth and elevation (deg) tolerance respect to nominal position to plot. Default 1, 1.
- ind_ray : int
- index of the ray to plot. Alternative to defining its antenna coordinates
- xaxis_info : str
- The xaxis type. Can be ‘Doppler_velocity’, ‘Doppler_frequency’ or ‘pulse_number’
- ampli_vmin, ampli_vmax, phase_vmin, phase_vmax : float or None
- Minimum and maximum of the color scale for the module and phase
- ‘AMPLITUDE_PHASE_TIME_DOPPLER’: Plots a complex spectra or IQ data
time-Doppler making two separate plots for the module and phase of the signal User defined parameters:
- xaxis_info : str
- The xaxis type. Can be ‘Doppler_velocity’ or ‘Doppler frequency’
- ampli_vmin, ampli_vmax, phase_vmin, phase_vmax : float or None
- Minimum and maximum of the color scale for the module and phase
- plot_type : str
- Can be ‘final’ or ‘temporal’. If final the data is only plotted at the end of the processing
- ‘ANGLE_DOPPLER’: Makes an angle Doppler plot. The plot can be along
azimuth or along range User defined parameters:
- along_azi : bool
- If true the plot is performed along azimuth, otherwise along elevation. Default true
- ang : float
- The fixed angle (deg). Default 0.
- rng : float
- The fixed range (m). Default 0.
- ang_tol : float
- The fixed angle tolerance (deg). Default 1.
- rng_tol : float
- The fixed range tolerance (m). Default 50.
- xaxis_info : str
- The xaxis type. Can be ‘Doppler_velocity’, ‘Doppler_frequency’ or ‘pulse_number’
- vmin, vmax : float or None
- Minimum and maximum of the color scale
- ‘COMPLEX_ANGLE_DOPPLER’: Makes an angle Doppler plot of complex
spectra or IQ data. The plot can be along azimuth or along range. The real and imaginary parts are plotted separately User defined parameters:
- along_azi : bool
- If true the plot is performed along azimuth, otherwise along elevation. Default true
- ang : float
- The fixed angle (deg). Default 0.
- rng : float
- The fixed range (m). Default 0.
- ang_tol : float
- The fixed angle tolerance (deg). Default 1.
- rng_tol : float
- The fixed range tolerance (m). Default 50.
- xaxis_info : str
- The xaxis type. Can be ‘Doppler_velocity’, ‘Doppler_frequency’ or ‘pulse_number’
- vmin, vmax : float or None
- Minimum and maximum of the color scale
- ‘COMPLEX_DOPPLER’: Plots a complex Doppler spectrum or IQ data making
two separate plots for the real and imaginary parts User defined parameters:
- azi, ele, rng : float
- azimuth and elevation (deg) and range (m) of the ray to plot
- azi_to, ele_tol, rng_tol : float
- azimuth and elevation (deg) and range (m) tolerance respect to nominal position to plot. Default 1, 1, 50.
- ind_ray, ind_rng : int
- index of the ray and range to plot. Alternative to defining its antenna coordinates
- xaxis_info : str
- The xaxis type. Can be ‘Doppler_velocity’, ‘Doppler_frequency’ or ‘pulse_number’
- vmin, vmax : float or None
- Minimum and maximum of the color scale
- ‘COMPLEX_RANGE_DOPPLER’: Plots the complex spectra or IQ data
range-Doppler making two separate plots for the real and imaginary parts User defined parameters:
- azi, ele : float
- azimuth and elevation (deg) of the ray to plot
- azi_to, ele_tol : float
- azimuth and elevation (deg) tolerance respect to nominal position to plot. Default 1, 1.
- ind_ray : int
- index of the ray to plot. Alternative to defining its antenna coordinates
- xaxis_info : str
- The xaxis type. Can be ‘Doppler_velocity’, ‘Doppler_frequency’ or ‘pulse_number’
- vmin, vmax : float or None
- Minimum and maximum of the color scale
- ‘COMPLEX_TIME_DOPPLER’: Plots the complex spectra or IQ data
time-Doppler making two separate plots for the real and imaginary parts User defined parameters:
- xaxis_info : str
- The xaxis type. Can be ‘Doppler_velocity’ or ‘Doppler frequency’
- vmin, vmax : float or None
- Minimum and maximum of the color scale
- plot_type : str
- Can be ‘final’ or ‘temporal’. If final the data is only plotted at the end of the processing
- ‘DOPPLER’: Plots a Doppler spectrum variable or IQ data variable
- User defined parameters:
- azi, ele, rng : float
- azimuth and elevation (deg) and range (m) of the ray to plot
- azi_to, ele_tol, rng_tol : float
- azimuth and elevation (deg) and range (m) tolerance respect to nominal position to plot. Default 1, 1, 50.
- ind_ray, ind_rng : int
- index of the ray and range to plot. Alternative to defining its antenna coordinates
- xaxis_info : str
- The xaxis type. Can be ‘Doppler_velocity’, ‘Doppler_frequency’ or ‘pulse_number’
- vmin, vmax : float or None
- Minimum and maximum of the color scale
- ‘RANGE_DOPPLER’: Makes a range-Doppler plot of spectral or IQ data
- User defined parameters:
- azi, ele : float
- azimuth and elevation (deg) of the ray to plot
- azi_to, ele_tol : float
- azimuth and elevation (deg) tolerance respect to nominal position to plot. Default 1, 1.
- ind_ray : int
- index of the ray to plot. Alternative to defining its antenna coordinates
- xaxis_info : str
- The xaxis type. Can be ‘Doppler_velocity’, ‘Doppler_frequency’ or ‘pulse_number’
- vmin, vmax : float or None
- Minimum and maximum of the color scale
- ‘SAVEALL’: Saves radar spectra or IQ volume data including all or a
list of userdefined fields in a netcdf file User defined parameters:
- datatypes: list of str or None
- The list of data types to save. If it is None, all fields in the radar object will be saved
- physical: Bool
- If True the data will be saved in physical units (floats). Otherwise it will be quantized and saved as binary
- ‘SAVEVOL’: Saves one field of a radar spectra or IQ volume data in a
netcdf file User defined parameters:
- physical: Bool
- If True the data will be saved in physical units (floats). Otherwise it will be quantized and saved as binary
- ‘TIME_DOPPLER’: Makes a time-Doppler plot of spectral or IQ data at a
point of interest. User defined parameters:
- xaxis_info : str
- The xaxis type. Can be ‘Doppler_velocity’, ‘Doppler_frequency’ or ‘pulse_number’
- vmin, vmax : float or None
- Minimum and maximum of the color scale
- plot_type : str
- Can be ‘final’ or ‘temporal’. If final the data is only plotted at the end of the processing
Parameters: - dataset : spectra
spectra object
- prdcfg : dictionary of dictionaries
product configuration dictionary of dictionaries
Returns: - None or name of generated files
-
pyrad.prod.
generate_sun_hits_products
(dataset, prdcfg)[source]¶ - generates sun hits products. Accepted product types:
- ‘PLOT_SUN_HITS’: Plots in a sun-radar azimuth difference-sun-radar
- elevation difference grid the values of all sun hits obtained during the processing period
- ‘PLOT_SUN_RETRIEVAL’: Plots in a sun-radar azimuth difference-sun-
- radar elevation difference grid the retrieved sun pattern
- ‘PLOT_SUN_RETRIEVAL_TS’: Plots time series of the retrieved sun
pattern parameters User defined parameters:
- dpi: int
- The pixel density of the plot. Default 72
- add_date_in_fname: Bool
- If true the year is added in the plot file name
- ‘WRITE_SUN_HITS’: Writes the information concerning possible sun hits
- in a csv file
- ‘WRITE_SUN_RETRIEVAL’: Writes the retrieved sun pattern parameters in
a csv file. User defined parameters:
- add_date_in_fname: Bool
- If true the year is added in the csv file name
All the products of the ‘VOL’ dataset group
Parameters: - dataset : tuple
radar object and sun hits dictionary
- prdcfg : dictionary of dictionaries
product configuration dictionary of dictionaries
Returns: - filename : str
the name of the file created. None otherwise
-
pyrad.prod.
generate_time_avg_products
(dataset, prdcfg)[source]¶ - generates time average products. Accepted product types:
- All the products of the ‘VOL’ dataset group
Parameters: - dataset : tuple
radar objects and colocated gates dictionary
- prdcfg : dictionary of dictionaries
product configuration dictionary of dictionaries
Returns: - filename : str
the name of the file created. None otherwise
-
pyrad.prod.
generate_timeseries_products
(dataset, prdcfg)[source]¶ - Generates time series products. Accepted product types:
- ‘COMPARE_CUMULATIVE_POINT’: Plots in the same graph 2 time series of
data accumulation (tipically rainfall rate). One time series is a point measurement of radar data while the other is from a co-located instrument (rain gauge or disdrometer) User defined parameters:
- dpi: int
- The pixel density of the plot. Default 72
- vmin, vmax: float
- The limits of the Y-axis. If none they will be obtained from the Py-ART config file.
- sensor: str
- The sensor type. Can be ‘rgage’ or ‘disdro’
- sensorid: str
- The sensor ID.
- location: str
- A string identifying the location of the disdrometer
- freq: float
- The frequency used to retrieve the polarimetric variables of a disdrometer
- ele: float
- The elevation angle used to retrieve the polarimetric variables of a disdrometer
- ScanPeriod: float
- The scaning period of the radar in seconds. This parameter is defined in the ‘loc’ config file
- ‘COMPARE_POINT’: Plots in the same graph 2 time series of
data . One time series is a point measurement of radar data while the other is from a co-located instrument (rain gauge or disdrometer) User defined parameters:
- dpi: int
- The pixel density of the plot. Default 72
- vmin, vmax: float
- The limits of the Y-axis. If none they will be obtained from the Py-ART config file.
- sensor: str
- The sensor type. Can be ‘rgage’ or ‘disdro’
- sensorid: str
- The sensor ID.
- location: str
- A string identifying the location of the disdrometer
- freq: float
- The frequency used to retrieve the polarimetric variables of a disdrometer
- ele: float
- The elevation angle used to retrieve the polarimetric variables of a disdrometer
- ‘COMPARE_TIME_AVG’: Creates a scatter plot of average radar data
versus average sensor data. User defined parameters:
- dpi: int
- The pixel density of the plot. Default 72
- sensor: str
- The sensor type. Can be ‘rgage’ or ‘disdro’
- sensorid: str
- The sensor ID.
- location: str
- A string identifying the location of the disdrometer
- freq: float
- The frequency used to retrieve the polarimetric variables of a disdrometer
- ele: float
- The elevation angle used to retrieve the polarimetric variables of a disdrometer
- cum_time: float
- Data accumulation time [s]. Default 3600.
- base_time: float
- Starting moment of the accumulation [s from midnight]. Default 0.
- ‘PLOT_AND_WRITE’: Writes and plots a trajectory time series.
- User defined parameters:
- ymin, ymax: float
- The minimum and maximum value of the Y-axis. If none it will be obtained from the Py-ART config file.
- ‘PLOT_AND_WRITE_POINT’: Plots and writes a time series of radar data
at a particular point User defined parameters:
- dpi: int
- The pixel density of the plot. Default 72
- vmin, vmax: float
- The limits of the Y-axis. If none they will be obtained from the Py-ART config file.
- ‘PLOT_CUMULATIVE_POINT’: Plots a time series of radar data
accumulation at a particular point. User defined parameters:
- dpi: int
- The pixel density of the plot. Default 72
- vmin, vmax: float
- The limits of the Y-axis. If none they will be obtained from the Py-ART config file.
- ScanPeriod: float
- The scaning period of the radar in seconds. This parameter is defined in the ‘loc’ config file
- ‘PLOT_HIST’: plots and writes a histogram of all the data gathered
during the trajectory processing User defined parameters:
- step: float or None
- The quantization step of the data. If None it will be obtained from the Py-ART config file
- ‘TRAJ_CAPPI_IMAGE’: Creates a CAPPI image with the trajectory position
overplot on it. User defined parameters:
- color_ref: str
- The meaning of the color code with which the trajectory is plotted. Can be ‘None’, ‘altitude’ (the absolute altitude), ‘rel_altitude’ (altitude relative to the CAPPI altitude), ‘time’ (trajectory time respect of the start of the radar scan leading to the CAPPI)
- altitude: float
- The CAPPI altitude [m]
- wfunc: str
- Function used in the gridding of the radar data. The function types are defined in pyart.map.grid_from_radars. Default ‘NEAREST’
- res: float
- The CAPPI resolution [m]. Default 500.
Parameters: - dataset : dictionary
radar object
- prdcfg : dictionary of dictionaries
product configuration dictionary of dictionaries
Returns: - no return
-
pyrad.prod.
generate_traj_product
(traj, prdcfg)[source]¶ - Generates trajectory products. Accepted product types:
- ‘TRAJ_MAP’: Plots the trajectory on a lat-lon map with the altitude
- color coded
- ‘TRAJ_PLOT’: Plots time series of the trajectory respect to the radar
elevation, azimuth or range User defined parameters:
- ‘datatype’: str
- The type of parameter: ‘EL’, ‘AZ’, or ‘RANGE’
‘TRAJ_TEXT’: Writes the trajectory information in a csv file
Parameters: - traj : Trajectory object
- prdcfg : dictionary of dictionaries
product configuration dictionary of dictionaries
Returns: - None
-
pyrad.prod.
generate_vol_products
(dataset, prdcfg)[source]¶ - Generates radar volume products. Accepted product types:
- ‘CDF’: plots and writes the cumulative density function of data
- User defined parameters:
- quantiles: list of floats
- The quantiles to compute in percent. Default None
- sector: dict
dictionary defining the sector where to compute the CDF. Default is None and the CDF is computed over all the data May contain:
- rmin, rmax: float
- min and max range [m]
- azmin, azmax: float
- min and max azimuth angle [deg]
- elmin, elmax: float
- min and max elevation angle [deg]
- hmin, hmax: float
- min and max altitude [m MSL]
- vismin: float
- The minimum visibility to use the data. Default None
- absolute: Bool
- If true the absolute values of the data will be used. Default False
- use_nans: Bool
- If true NaN values will be used. Default False
- nan_value: Bool
- The value by which the NaNs are substituted if NaN values are to be used in the computation
- filterclt: Bool
- If True the gates containing clutter are filtered
- filterprec: list of ints
- The hydrometeor types that are filtered from the analysis. Default empty list.
- ‘BSCOPE_IMAGE’: Creates a B-scope image (azimuth, range)
- User defined parameters:
- anglenr : int
- The elevation angle number to use
- ray_dim : str
- the ray dimension. Can be ‘ang’ or ‘time’. Default ‘ang’
- xaxis_rng : bool
- if True the range will be in the x-axis. Otherwise it will be in the y-axis. Default True
- vmin, vmax: float or None
- The minimum and maximum values of the color scale. If None the scale is going to be set according to the Py-ART config file
- ‘CAPPI_IMAGE’: Creates a CAPPI image
- User defined parameters:
- altitude: flt
- CAPPI altitude [m MSL]
- wfunc: str
- The function used to produce the CAPPI as defined in pyart.map.grid_from_radars. Default ‘NEAREST’
- cappi_res: float
- The CAPPI resolution [m]. Default 500.
- ‘FIELD_COVERAGE’: Gets the field coverage over a certain sector
- User defined parameters:
- threshold: float or None
- Minimum value to consider the data valid. Default None
- nvalid_min: float
- Minimum number of valid gates in the ray to consider it valid. Default 5
- ele_res, azi_res: float
- Elevation and azimuth resolution of the sectors [deg]. Default 1. and 2.
- ele_min, ele_max: float
- Min and max elevation angle defining the sector [deg]. Default 0. and 30.
- ele_step: float
- Elevation step [deg]. Default 5.
- ele_sect_start, ele_sect_stop: float or None
- start and stop angles of the sector coverage. Default None
- quantiles: list of floats
- The quantiles to compute in the sector. Default 10. to 90. by steps of 10.
- AngTol: float
- The tolerance in elevation angle when putting the data in a fixed grid
- ‘FIXED_RNG_IMAGE’: Plots a fixed range image
- User defined parameters:
- AngTol : float
- The tolerance between the nominal angles and the actual radar angles. Default 1.
- ele_res, azi_res: float or None
- The resolution of the fixed grid [deg]. If None it will be obtained from the separation between angles
- vmin, vmax : float or None
- Min and Max values of the color scale. If None the values are taken from the Py-ART config file
- ‘FIXED_RNG_SPAN_IMAGE’: Plots a user-defined statistic over a fixed
range image User defined parameters:
- AngTol : float
- The tolerance between the nominal angles and the actual radar angles. Default 1.
- ele_res, azi_res: float or None
- The resolution of the fixed grid [deg]. If None it will be obtained from the separation between angles
- stat : str
- The statistic to compute. Can be ‘min’, ‘max’, ‘mean’, ‘mode’. Default ‘max’
- ‘HISTOGRAM’: Computes a histogram of the radar volum data
- User defined parameters:
- step: float or None
- the data quantization step. If none it will be obtained from the Py-ART configuration file
- write_data: Bool
- If true the histogram data is written in a csv file
- ‘PLOT_ALONG_COORD’: Plots the radar volume data along a particular
coordinate User defined parameters:
- colors: list of str or None
- The colors of each ploted line
- mode: str
- Ploting mode. Can be ‘ALONG_RNG’, ‘ALONG_AZI’ or ‘ALONG_ELE’
- value_start, value_stop: float
- The starting and ending points of the data to plot. According to the mode it may refer to the range, azimuth or elevation. If not specified the minimum and maximum possible values are used
- fix_elevations, fix_azimuths, fix_ranges: list of floats
- The elevations, azimuths or ranges to plot for each mode. ‘ALONG_RNG’ would use fix_elevations and fix_azimuths ‘ALONG_AZI’ fix_ranges and fix_elevations ‘ALONG_ELE’ fix_ranges and fix_azimuths
- AngTol: float
- The tolerance to match the radar angle to the fixed angles Default 1.
- RngTol: float
- The tolerance to match the radar range to the fixed ranges Default 50.
- ‘PPI_CONTOUR’: Plots a PPI countour plot
- User defined parameters:
- contour_values: list of floats or None
- The list of contour values to plot. If None the contour values are going to be obtained from the Py-ART config file either with the dictionary key ‘contour_values’ or from the minimum and maximum values of the field with an assumed division of 10 levels.
- anglenr: float
- The elevation angle number
- ‘PPI_CONTOUR_OVERPLOT’: Plots a PPI of a field with another field
overplotted as a contour plot. User defined parameters:
- contour_values: list of floats or None
- The list of contour values to plot. If None the contour values are going to be obtained from the Py-ART config file either with the dictionary key ‘contour_values’ or from the minimum and maximum values of the field with an assumed division of 10 levels.
- anglenr: float
- The elevation angle number
- ‘PPI_IMAGE’: Plots a PPI image. It can also plot the histogram and the
quantiles of the data in the PPI. User defined parameters:
- anglenr: float
- The elevation angle number
- plot_type: str
- The type of plot to perform. Can be ‘PPI’, ‘QUANTILES’ or ‘HISTOGRAM’
- step: float or None
- If the plot type is ‘HISTOGRAM’, the width of the histogram bin. If None it will be obtained from the Py-ART config file
- quantiles: list of float or None
- If the plot type is ‘QUANTILES’, the list of quantiles to compute. If None a default list of quantiles will be computed
- vmin, vmax: float or None
- The minimum and maximum values of the color scale. If None the scale is going to be set according to the Py-ART config file
- ‘PPI_MAP’: Plots a PPI image over a map. The map resolution and the
type of maps used are defined in the variables ‘mapres’ and ‘maps’ in ‘ppiMapImageConfig’ in the loc config file. User defined parameters:
- anglenr: float
- The elevation angle number
- ‘PPIMAP_ROI_OVERPLOT’: Over plots a polygon delimiting a region of
interest on a PPI map. The map resolution and the type of maps used are defined in the variables ‘mapres’ and ‘maps’ in ‘ppiMapImageConfig’ in the loc config file. User defined parameters:
- anglenr: float
- The elevation angle number
- ‘PROFILE_STATS’: Computes and plots a vertical profile statistics.
The statistics are saved in a csv file User defined parameters:
- heightResolution: float
- The height resolution of the profile [m]. Default 100.
- heightMin, heightMax: float or None
- The minimum and maximum altitude of the profile [m MSL]. If None the values will be obtained from the minimum and maximum gate altitude.
- quantity: str
- The type of statistics to plot. Can be ‘quantiles’, ‘mode’, ‘reqgression_mean’ or ‘mean’.
- quantiles: list of floats
- If quantity type is ‘quantiles’ the list of quantiles to compute. Default 25., 50., 75.
- nvalid_min: int
- The minimum number of valid points to consider the statistic valid. Default 4
- make_linear: Bool
- If true the data is converted from log to linear before computing the stats
- include_nans: Bool
- If true NaN values are included in the statistics
- fixed_span: Bool
- If true the profile plot has a fix X-axis
- vmin, vmax: float or None
- If fixed_span is set, the minimum and maximum values of the X-axis. If None, they are obtained from the Py-ART config file
- ‘PSEUDOPPI_CONTOUR’: Plots a pseudo-PPI countour plot
- User defined parameters:
- contour_values: list of floats or None
- The list of contour values to plot. If None the contour values are going to be obtained from the Py-ART config file either with the dictionary key ‘contour_values’ or from the minimum and maximum values of the field with an assumed division of 10 levels.
- angle: float
- The elevation angle at which compute the PPI
- EleTol: float
- The tolerance between the actual radar elevation angle and the nominal pseudo-PPI elevation angle.
- ‘PSEUDOPPI_CONTOUR_OVERPLOT’: Plots a pseudo-PPI of a field with
another field over-plotted as a contour plot User defined parameters:
- contour_values: list of floats or None
- The list of contour values to plot. If None the contour values are going to be obtained from the Py-ART config file either with the dictionary key ‘contour_values’ or from the minimum and maximum values of the field with an assumed division of 10 levels.
- angle: float
- The elevation angle at which compute the PPI
- EleTol: float
- The tolerance between the actual radar elevation angle and the nominal pseudo-PPI elevation angle.
- ‘PSEUDOPPI_IMAGE’: Plots a pseudo-PPI image. It can also plot the
histogram and the quantiles of the data in the pseudo-PPI. User defined parameters:
- angle: float
- The elevation angle of the pseudo-PPI
- EleTol: float
- The tolerance between the actual radar elevation angle and the nominal pseudo-PPI elevation angle.
- plot_type: str
- The type of plot to perform. Can be ‘PPI’, ‘QUANTILES’ or ‘HISTOGRAM’
- step: float or None
- If the plot type is ‘HISTOGRAM’, the width of the histogram bin. If None it will be obtained from the Py-ART config file
- quantiles: list of float or None
- If the plot type is ‘QUANTILES’, the list of quantiles to compute. If None a default list of quantiles will be computed
- vmin, vmax : float or None
- Min and Max values of the color scale. If None the values are taken from the Py-ART config file
- ‘PSEUDOPPI_MAP’: Plots a pseudo-PPI image over a map. The map
resolution and the type of maps used are defined in the variables ‘mapres’ and ‘maps’ in ‘ppiMapImageConfig’ in the loc config file. User defined parameters:
- angle: float
- The elevation angle of the pseudo-PPI
- EleTol: float
- The tolerance between the actual radar elevation angle and the nominal pseudo-PPI elevation angle.
- ‘PSEUDORHI_CONTOUR’: Plots a pseudo-RHI countour plot
- User defined parameters:
- contour_values: list of floats or None
- The list of contour values to plot. If None the contour values are going to be obtained from the Py-ART config file either with the dictionary key ‘contour_values’ or from the minimum and maximum values of the field with an assumed division of 10 levels.
- angle: float
- The azimuth angle at which to compute the RPI
- AziTol: float
- The tolerance between the actual radar azimuth angle and the nominal pseudo-RHI azimuth angle.
- ‘PSEUDORHI_CONTOUR_OVERPLOT’: Plots a pseudo-RHI of a field with
another field over-plotted as a contour plot User defined parameters:
- contour_values: list of floats or None
- The list of contour values to plot. If None the contour values are going to be obtained from the Py-ART config file either with the dictionary key ‘contour_values’ or from the minimum and maximum values of the field with an assumed division of 10 levels.
- angle: float
- The azimuth angle at which to compute the RPI
- AziTol: float
- The tolerance between the actual radar azimuth angle and the nominal pseudo-RHI azimuth angle.
- ‘PSEUDORHI_IMAGE’: Plots a pseudo-RHI image. It can also plot the
histogram and the quantiles of the data in the pseudo-RHI. User defined parameters:
- angle: float
- The azimuth angle at which to compute the RPI
- AziTol: float
- The tolerance between the actual radar azimuth angle and the nominal pseudo-RHI azimuth angle.
- plot_type: str
- The type of plot to perform. Can be ‘RHI’, ‘QUANTILES’ or ‘HISTOGRAM’
- step: float or None
- If the plot type is ‘HISTOGRAM’, the width of the histogram bin. If None it will be obtained from the Py-ART config file
- quantiles: list of float or None
- If the plot type is ‘QUANTILES’, the list of quantiles to compute. If None a default list of quantiles will be computed
- vmin, vmax : float or None
- Min and Max values of the color scale. If None the values are taken from the Py-ART config file
- ‘QUANTILES’: Plots and writes the quantiles of a radar volume
- User defined parameters:
- quantiles: list of floats or None
- the list of quantiles to compute. If None a default list of quantiles will be computed.
- write_data: Bool
- If True the computed data will be also written in a csv file
- fixed_span: Bool
- If true the quantile plot has a fix Y-axis
- vmin, vmax: float or None
- If fixed_span is set, the minimum and maximum values of the Y-axis. If None, they are obtained from the Py-ART config file
- ‘RHI_CONTOUR’: Plots an RHI countour plot
- User defined parameters:
- contour_values: list of floats or None
- The list of contour values to plot. If None the contour values are going to be obtained from the Py-ART config file either with the dictionary key ‘contour_values’ or from the minimum and maximum values of the field with an assumed division of 10 levels.
- anglenr: int
- The azimuth angle number
- ‘RHI_CONTOUR_OVERPLOT’: Plots an RHI of a field with another field
over-plotted as a contour plot User defined parameters:
- contour_values: list of floats or None
- The list of contour values to plot. If None the contour values are going to be obtained from the Py-ART config file either with the dictionary key ‘contour_values’ or from the minimum and maximum values of the field with an assumed division of 10 levels.
- anglenr: int
- The azimuth angle number
- ‘RHI_IMAGE’: Plots an RHI image. It can also plot the
histogram and the quantiles of the data in the RHI. User defined parameters:
- anglenr: int
- The azimuth angle number
- plot_type: str
- The type of plot to perform. Can be ‘RHI’, ‘QUANTILES’ or ‘HISTOGRAM’
- step: float or None
- If the plot type is ‘HISTOGRAM’, the width of the histogram bin. If None it will be obtained from the Py-ART config file
- quantiles: list of float or None
- If the plot type is ‘QUANTILES’, the list of quantiles to compute. If None a default list of quantiles will be computed
- vmin, vmax: float or None
- The minimum and maximum values of the color scale. If None the scale is going to be set according to the Py-ART config file
- ‘RHI_PROFILE’: Computes and plots a vertical profile statistics out of
an RHI. The statistics are saved in a csv file User defined parameters:
- rangeStart, rangeStop: float
- The range start and stop of the data to extract from the RHI to compute the statistics [m]. Default 0., 25000.
- heightResolution: float
- The height resolution of the profile [m]. Default 100.
- heightMin, heightMax: float or None
- The minimum and maximum altitude of the profile [m MSL]. If None the values will be obtained from the minimum and maximum gate altitude.
- quantity: str
- The type of statistics to plot. Can be ‘quantiles’, ‘mode’, ‘reqgression_mean’ or ‘mean’.
- quantiles: list of floats
- If quantity type is ‘quantiles’ the list of quantiles to compute. Default 25., 50., 75.
- nvalid_min: int
- The minimum number of valid points to consider the statistic valid. Default 4
- make_linear: Bool
- If true the data is converted from log to linear before computing the stats
- include_nans: Bool
- If true NaN values are included in the statistics
- fixed_span: Bool
- If true the profile plot has a fix X-axis
- vmin, vmax: float or None
- If fixed_span is set, the minimum and maximum values of the X-axis. If None, they are obtained from the Py-ART config file
- ‘SAVEALL’: Saves radar volume data including all or a list of user-
defined fields in a C/F radial or ODIM file User defined parameters:
- file_type: str
- The type of file used to save the data. Can be ‘nc’ or ‘h5’. Default ‘nc’
- datatypes: list of str or None
- The list of data types to save. If it is None, all fields in the radar object will be saved
- physical: Bool
- If True the data will be saved in physical units (floats). Otherwise it will be quantized and saved as binary
- compression: str
- For ODIM file formats, the type of compression. Can be any of the allowed compression types for hdf5 files. Default gzip
- compression_opts: any
- The compression options allowed by the hdf5. Depends on the type of compression. Default 6 (The gzip compression level).
- ‘SAVESTATE’: Saves the last processed data in a file. Used for real-
- time data processing
- ‘SAVEVOL’: Saves one field of a radar volume data in a C/F radial or
ODIM file User defined parameters:
- file_type: str
- The type of file used to save the data. Can be ‘nc’ or ‘h5’. Default ‘nc’
- physical: Bool
- If True the data will be saved in physical units (floats). Otherwise it will be quantized and saved as binary
- compression: str
- For ODIM file formats, the type of compression. Can be any of the allowed compression types for hdf5 files. Default gzip
- compression_opts: any
- The compression options allowed by the hdf5. Depends on the type of compression. Default 6 (The gzip compression level).
- ‘SAVE_FIXED_ANGLE’: Saves the position of the first fix angle in a
- csv file
- ‘SELFCONSISTENCY’: Plots a ZDR versus KDP/ZH histogram of data.
- User defined parameters:
- retrieve_relation : bool
- If True plots also the retrieved relationship. Default True
- plot_theoretical : bool
- If True plots also the theoretical relationship. Default True
- normalize : bool
- If True the occurrence density of ZK/KDP for each ZDR bin is going to be represented. Otherwise it will show the number of gates at each bin. Default True
- ‘SELFCONSISTENCY2’: Plots a ZH measured versus ZH inferred from a self-consistency
relation histogram of data. User defined parameters:
- normalize : bool
- If True the occurrence density of ZK/KDP for each ZDR bin is going to be represented. Otherwise it will show the number of gates at each bin. Default True
- ‘TIME_RANGE’: Plots a time-range/azimuth/elevation plot
- User defined parameters:
- anglenr: float
- The number of the fixed angle to plot
- vmin, vmax: float or None
- The minimum and maximum values of the color scale. If None the scale is going to be set according to the Py-ART config file
- ‘VOL_TS’: Writes and plots a value corresponding to a time series.
Meant primarily for writing and plotting the results of the SELFCONSISTENCY2 algorithm User defined parameters:
- ref_value: float
- The reference value. Default 0
- sort_by_date: Bool
- If true when reading the csv file containing the statistics the data is sorted by date. Default False
- rewrite: Bool
- If true the csv file containing the statistics is rewritten
- add_data_in_fname: Bool
- If true and the data used is cumulative the year is written in the csv file name and the plot file name
- npoints_min: int
- Minimum number of points to use the data point in the plotting and to send an alarm. Default 0
- vmin, vmax: float or None
- Limits of the Y-axis (data value). If None the limits are obtained from the Py-ART config file
- alarm: Bool
- If true an alarm is sent
- tol_abs: float
- Margin of tolerance from the reference value. If the current value is above this margin an alarm is sent. If the margin is not specified it is not possible to send any alarm
- tol_trend: float
- Margin of tolerance from the reference value. If the trend of the last X events is above this margin an alarm is sent. If the margin is not specified it is not possible to send any alarm
- nevents_min: int
- Minimum number of events with sufficient points to send an alarm related to the trend. If not specified it is not possible to send any alarm
- sender: str
- The mail of the alarm sender. If not specified it is not possible to send any alarm
- receiver_list: list of str
- The list of emails of the people that will receive the alarm.. If not specified it is not possible to send any alarm
- ‘WIND_PROFILE’: Plots vertical profile of wind data (U, V, W
components and wind velocity and direction) out of a radar volume containing the retrieved U,V and W components of the wind, the standard deviation of the retrieval and the velocity difference between the estimated radial velocity (assuming the wind to be uniform) and the actual measured radial velocity. User defined parameters:
- heightResolution: float
- The height resolution of the profile [m]. Default 100.
- heightMin, heightMax: float or None
- The minimum and maximum altitude of the profile [m MSL]. If None the values will be obtained from the minimum and maximum gate altitude.
- min_ele: float
- The minimum elevation to be used in the computation of the vertical velocities. Default 5.
- max_ele: float
- The maximum elevation to be used in the computation of the horizontal velocities. Default 85.
- fixed_span: Bool
- If true the profile plot has a fix X-axis
- vmin, vmax: float or None
- If fixed_span is set, the minimum and maximum values of the X-axis. If None, they are obtained from the span of the U component defined in the Py-ART config file
Parameters: - dataset : dict
dictionary with key radar_out containing a radar object
- prdcfg : dictionary of dictionaries
product configuration dictionary of dictionaries
Returns: - The list of created fields or None
-
pyrad.prod.
get_prodgen_func
(dsformat, dsname, dstype)[source]¶ maps the dataset format into its processing function
Parameters: - dsformat : str
dataset group. The following is a list of dataset groups with the function that is called to generate their products. For details about what the functions do check the function documentation:
‘VOL’: generate_vol_products ‘COLOCATED_GATES’: generate_colocated_gates_products ‘COSMO_COORD’: generate_cosmo_coord_products ‘COSMO2RADAR’: generate_cosmo_to_radar_products ‘GRID’: generate_grid_products ‘SPECTRA’: generate_spectra_products ‘GRID_TIMEAVG’: generate_grid_time_avg_products ‘INTERCOMP’: generate_intercomp_products ‘ML’: generate_ml_products ‘MONITORING’: generate_monitoring_products ‘OCCURRENCE’: generate_occurrence_products ‘QVP’: generate_qvp_products ‘SPARSE_GRID’: generate_sparse_grid_products ‘SUN_HITS’: generate_sun_hits_products ‘TIMEAVG’: generate_time_avg_products ‘TIMESERIES’: generate_timeseries_products ‘TRAJ_ONLY’: generate_traj_product
Returns: - func : function
pyrad function used to generate the products