pyrad.prod.generate_sun_hits_products#

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 User defined parameters:

voltype: str

name of the pyrad variable to use, it must be available in the dataset in the dataset

‘PLOT_SUN_RETRIEVAL’: Plots in a sun-radar azimuth difference-sun-

radar elevation difference grid the retrieved sun pattern User defined parameters:

voltype: str

name of the pyrad variable to use, it must be available in the dataset in the dataset

‘PLOT_SUN_RETRIEVAL_TS’: Plots time series of the retrieved sun

pattern parameters User defined parameters:

voltype: str

name of the pyrad variable to use, it must be available in the dataset in the dataset

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

‘PLOT_SUNSCAN’: Plots a constant range radar azimuth-elevation of the

sunscan field data

‘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

‘WRITE_SUNSCAN’: Writes the sunscan parameters in a csv file

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