This is an old revision of the document!
Table of Contents
UV Access Functions
This pages describes UV-specific access functions. For a general overview of EUBREWNET's access functions, as well as a description of common inputs, see the wiki page on the ozone access functions
See this presentation for a short overview of the UV configuration and processing levels.
COMMON OPTIONS
Formats
Besides the formats described here, two further values can be passed in the URL to the format
argument:
Format input | Description | Example |
---|---|---|
zip | returns a zip with separate files for each scan; these separate files are written in the SHICrivm text format | zip example |
jsona | spectral variables such as irr_l or aod_l , where l is the wavelength, are written together as single 2d arrays, with the first dimension as the date and time, and the second as the wavelength. The date and time are written in the gmt variable as usual, and wavelengths, in the new wavel variable | jsona example |
Input
Beside the input options described in common_inputs, selected UV functions also support:
Parameter | Description | Example |
---|---|---|
time | time in HH[:MM[:SS]] format, to select the time to start the UV processing in each day | Process UV scans starting after 11:00:00 |
endtime | time in HH[:MM[:SS]] format, to be used together with the time variable (see above) to select a time range in each day for the UV processing. If omitted, defaults to 23:59:59 | Process UV scans starting after 11:00:00 and ending before 15:30:00 |
GET FUNCTIONS
Function | Description | Help | Example |
---|---|---|---|
uvscans | Return available UV scans | uvscans | Get uvscans |
compareuvtimes | For two brewers, return the scans starting within some time delta | compareuvtimes | Get compareuvtimes |
compareuv | For two brewers, compare the irradiances for the scans starting within some time delta | compareuv | Get compareuv |
uvrall | return the start dates of all the operative configurations available in EUBREWNET for a specific Brewer | uvrall | Get uvrall |
uvrbydate | return the UVR operative in EUBREWNET for a specific Brewer and date | uvrbydate | Get uvrbydate |
uvl0 | return the raw counts measured by the Brewer | uvl0 | Get uvl0 |
Get uvscans
- Function: uvscans
- Description: This function lists the UV scans available in Eubrewnet for a specific Brewer and date range
- Input:
brewerid
: see Brewerid in common inputsdate
: see Date in common inputsenddate
: see Enddate in common inputsformat
: see Formatfields
: see Fields in common inputsscans
: a comma-separated list of UV scan types to list. If ommited, defaults toux,ua,uv
- Output: besides de standard output (Brewer ID, gmt, …) the following UV-specific fields are provided:
scan
: type of UV-scan (ua, ux, uv)mmmm
: decimal minutes from 00:00 to the start of the UV scan
Get compareuvtimes
- Function: compareuvtimes
- Description: This function lists the UV scans available in Eubrewnet in a date range, for two input Brewers.
- Input:
brewerid
: this is the ID of the reference Brewer. This follows the format described in Brewerid in common inputscompid
: this is the ID of the Brewer which is being compared to the reference Brewerdate
: see Date in common inputsenddate
: see Enddate in common inputsformat
: see Formatfields
: see Fields in common inputsscans
: a comma-separated list of UV scan types to list. If ommited, defaults toux,ua,uv
maxminutes
: maximum difference between the scans of the two Brewers. If omitted, it defaults to 5 minutes
- Output: besides the usual output, the following UV-specific fields are provided:
scan
andcompscan
: type of UV-scan (ua, ux, uv) of the two Brewersmmmm
andcompmmmm
: decimal minutes from 00:00 to the start of the UV scan for the two Brewersdeltaminutes
: diference in decimal minutes between the starting times of the two UV scans
Get compareuv
- Function: compareuv
- Description: This function lists the irradiance ratios in a date range, for two input Brewers.
- Input:
brewerid
: ID of the reference Brewer. This follows the format described in Brewerid in common inputscompid
: ID of the Brewer which is being compared to the reference Brewerdate
: see Date in common inputsenddate
: see Enddate in common inputsformat
: see Formatfields
: see Fields in common inputsscans
: a comma-separated list of UV scan types to list. If ommited, defaults toux,ua,uv
maxminutes
: maximum difference between the scans of the two Brewers. If omitted, it defaults to 5 minuteslevel
: UV product level used to calculate the irradiances. If omitted, defaults to level 1
- Output: besides the usual output, the following UV-specific fields are provided:
scan
andcompscan
: type of UV-scan (ua, ux, uv) of the two Brewersmmmm
andcompmmmm
: decimal minutes from 00:00 to the start of the UV scan for the two Brewersdeltaminutes
: diference in decimal minutes between the starting times of the two UV scansratio_l
: where l=2865, 2870, …, 3630: ratio of compared to reference irradiances at the l wavelength
Get uvrall
- Function: uvrall
- Description: This function lists the start dates of the operative UV configurations available in EUBREWNET.
- Input:
brewerid
: this is the ID of the reference Brewer. This follows the format described in Brewerid in common inputsformat
: see Formatfields
: see Fields in common inputs
- Output: besides the usual output, the following UV-specific fields are provided:
config_date
: date at which the configuration becomes operative, in YYYYMMDDconfig_doy
: same as above, but in JJJYY format, where JJJ is the day number of the yearconfig_id
: ID internally used by EUBREWNET to identify the configuration
Get uvrbydate
- Function: uvrbydate
- Description: This function lists the wavelengths and responsivites for the operative UV configuration at the requested date.
- Input:
brewerid
: this is the ID of the reference Brewer. This follows the format described in Brewerid in common inputsdate
: date in YYYY-MM-DD formatformat
: see Formatfields
: see Fields in common inputs
- Output: besides the usual output, the following UV-specific fields are provided:
config_date
: date at which the configuration becomes operative, in YYYYMMDDconfig_id
: ID internally used by EUBREWNET to identify the configurationwavelength
: wavelength in Angstromsresponsivity
: responsivity in counts/mW/m2/nm
Get UVL0
- Function: UVL0
- Description: return the raw counts measured by the Brewer.
- Input:
brewerid
: see Brewerid in common inputsdate
: see Date in common inputsenddate
: see Enddate in common inputstime
: see Time in UV-specific inputsendtime
: see Endtime in UV-specific inputsscan
: optional, use to select an scan type (ux
,ua
, oruv
)fields
: see Fields in common inputsmeans
: see means
- Output: the following UV-specific fields are included in the standard output alongside the other usual ones (Brewer ID, latitude, pressure, …):
scan
: type of UV scan performed (uv, ux, ua, …)counts_l
, where l=2865, 2870, …, 3630: raw counts at the l wavelengthmmmm_l
: decimal minute from 00:00 at which the measurement at the l wavelength startedmicrometer_l
: micrometer position at which the measurement at the l wavelength was performed
PROCESS FUNCTIONS
Function | Description | Help | Example |
---|---|---|---|
UVL1 | Returns Level 1 UV | UVL1 | Process UVL1 |
UVL1_5 | Returns Level 1.5 UV | UVL1_5 | Process UVL1_5 |
UVL1_6 | Returns Level 1.6 UV | UVL1_6 | Process UVL1_6 |
UVL2 | Returns Level 2 UV | UVL2 | Process UVL2 |
UV Corrections Flag
The following table shows the complete list of UV-specific corrections and their flag values. The final flag value corresponds to the sum of all the individual flag values applied.
Flag name | Flag value | Description |
---|---|---|
FLAG_UV_STRAYLIGHT_COR | 1 | Straylight correction for non MK III Brewers has been applied in UVL1 |
FLAG_UV_SPIKES_COR | 2 | Spike correction has been applied in UVL1_5 |
FLAG_UV_TEMPERATURE_COR | 4 | Temperature correction has been applied in UVL1_5 |
FLAG_UV_SHICRIVM_INSTR | 8 | Instrumental irradiances calculated with SHICRIVM in UVL1_6 |
FLAG_UV_COSINE_CLEARSKY_COR | 16 | Cosine correction in clear-sky conditions has been applied in UVL2 |
FLAG_UV_COSINE_DIFFUSE_COR | 32 | Cosine correction in cloudy conditions has been applied in UVL2 |
UV Filter Flag
The following table shows the complete list of UV-specific data filters and their flag values. The final flag value corresponds to the sum of all the individual flag values applied.
Flag name | Flag value | Description |
---|---|---|
FLAG_UV_SHICRIVM_BLACK_GREY_RED | 16 | Observation flagged as black, grey or red by SHICRIVM in UVL1.6 |
FLAG_UV_BLACKLIST | 32 | Observation date and time is affected by the UV exclusion list and has been removed from UVL1.5, UVL1.6, and UVL2 products |
Process UVL1
- Function: UVL1
- Description: converts the raw counts measured by the Brewer to irradiances (in W/m2/nm) using the operative UV response. An operative UV configuration with the UV response must be available for the requested period.
- Input:
brewerid
: see Brewerid in common inputsdate
: see Date in common inputsenddate
: see Enddate in common inputstime
: see Time in UV-specific inputsendtime
: see Endtime in UV-specific inputsscan
: optional, use to select an scan type (ux
,ua
, oruv
)fields
: see Fields in common inputsmeans
: see means
- Output: the following UV-specific fields are included in the standard output alongside the other usual ones (Brewer ID, config_date, config_id, pressure, …):
mmmm
: decimal minutes from 00:00 to the start of the UV scanscan
: type of UV scan performed (uv, ux, ua, …)irr_l
, where l=2865, 2870, …, 3630: irradiance at the l wavelength, in W/m2/nmmmmm_l
: decimal minute from 00:00 at which the measurement at the l wavelength startedduv
andduv_cost
: erythema-weighted UV irradiances, using the same method as in the standard Brewer software, and the method proposed during COST Action ES1207 (EUBREWNET)uvi
anduvi_cost
: UV indexes calculated asduv
/25 andduv_cost
/25correction_flag
: flag with the corrections applied. In the level 1 UV product, only the straylight correction for non MK III Brewers is applied. For the complete list of corrections and their flag values see here
- Debug output: if the
debug
argument is passed in the URL, this function additionally returns the following fields:count_l0_l
: raw counts at wavelength lstraylight_corr
: straylight correction applied to non-MKIII Brewers
Process UVL1_5
- Function: UVL1_5
- Description: Starting from the level 1 UV product, spike and temperature corrections are applied to the irradiances. The spike correction is always applied if needed. For the temperature correction, an operative UV configuration with the Temperature correction coefficients must be available for the requested period. Output data is further filtered by the UV Exclusion List
- Input:
brewerid
: see Brewerid in common inputsdate
: see Date in common inputsenddate
: see Enddate in common inputstime
: see Time in UV-specific inputsendtime
: see Endtime in UV-specific inputsscan
: optional, use to select an scan type (ux
,ua
, oruv
)fields
: see Fields in common inputsmeans
: see means
- Output: the following UV-specific fields are included in the standard output alongside the other usual ones (Brewer ID, config_date, config_id, pressure, …):
mmmm
: decimal minutes from 00:00 to the start of the UV scanscan
: type of UV scan performed (uv, ux, ua, …)irr_l
, where l=2865, 2870, …, 3630: irradiance at the l wavelength, in W/m2/nmmmmm_l
: decimal minute from 00:00 at which the measurement at the l wavelength startedduv
andduv_cost
: erythema-weighted UV irradiances, using the same method as in the standard Brewer software, and the method proposed during COST Action ES1207 (EUBREWNET)uvi
anduvi_cost
: UV indexes calculated asduv
/25 andduv_cost
/25, respectivelycorrection_flag
: binary flag with the corrections applied. In the level 1.5 UV product, the spike and temperature correction may be applied. For the complete list of corrections and their flag values see here
- Debug output: if the
debug
argument is passed in the URL, this function additionally returns the following fields:irr_l1_l
: l1 irradiance at wavelength lwl_with_spikes
: wavelengths in which spikes have been detected and corrected
- Rejected output: if the
rejected
argument is passed in the URL, UVL1_5 also returns the observations inside the UV exclusion list, and aditionally returns the field:filter_flag
: filter flag for each observation
Process UVL1_6
- Function: UVL1_6
- Description: Starting from the level 1.5 UV product, process the data using the SHICRIVM code developed by Harry Slaper at the National Institute of Public Health and the Environment (RIVM). Shift-corrected irradiances are calculated using the http://eubrewnet.aemet.es/dokuwiki/doku.php?id=devel:eubrewnetconfiguration&#slit_function. Output data is further filtered by SHICRIVM's QA/QC, retaining only measurements with GREEN and YELLOW flags. As in the case of level 1.5, output data is further filtered by the UV Exclusion List
- Input:
brewerid
: see Brewerid in common inputsdate
: see Date in common inputsenddate
: see Enddate in common inputstime
: see Time in UV-specific inputsendtime
: see Endtime in UV-specific inputsscan
: optional, use to select an scan type (ux
,ua
, oruv
)fields
: see Fields in common inputsmeans
: see means
- Output: the following UV-specific fields are included in the standard output alongside the other usual ones (Brewer ID, config_date, config_id, pressure, …):
mmmm
: decimal minutes from 00:00 to the start of the UV scanscan
: type of UV scan performed (uv, ux, ua, …)irr_l
, where l=2865, 2870, …, 3630: shift-corrected irradiance at the l wavelength, in W/m2/nm. Corresponds to theIrr instr
output of SHICRIVM.shift_l
: wavelength shifts calculated by SHICRIVMmmmm_l
: decimal minute from 00:00 at which the measurement at the l wavelength startedduv
andduv_cost
: erythema-weighted UV irradiances, using the same method as in the standard Brewer software, and the method proposed during COST Action ES1207 (EUBREWNET)uvi
anduvi_cost
: UV indexes calculated asduv
/25 andduv_cost
/25, respectivelycorrection_flag
: binary flag with the corrections applied. For the complete list of corrections and their flag values see here
- Debug output: if the
debug
argument is passed in the URL, this function additionally returns the following fields:irr_l15_l
: L1.5 irradiance at wavelength lshicrivm_qaqc
: SHICRIVM's QA/QC flag colors
- Rejected output: if the
rejected
argument is passed in the URL, UVL1_6 also returns the observations flagged as black, grey, or red by SHICRIVM, and aditionally returns the field:filter_flag
: filter flag for each observation
Process UVL2
- Function: UVL2
- Description: Starting from the level 1.6 UV product, the cosine correction is applied to the irradiances.The cosine correction is calculated using the BUVIC (Brewer UV Irradiance Calculation) code, developed by J. Gröbner and B. Maret at the PMOD/WRC in 2020, and available at https://github.com/pec0ra/buvic. An operative UV configuration with the Cosine correction data must be available for the requested period. As in the case of level 1.6, output data is further filtered by the UV Exclusion List
- Input:
brewerid
: see Brewerid in common inputsdate
: see Date in common inputsenddate
: see Enddate in common inputsscan
: optional, use to select an scan type (ux
,ua
, oruv
)fields
: see Fields in common inputsmeans
: see means
- Output: the following UV-specific fields are included in the standard output alongside the other usual ones (Brewer ID, config_date, config_id, pressure, …):
mmmm
: decimal minutes from 00:00 to the start of the UV scanscan
: type of UV scan performed (uv, ux, ua, …)irr_l
, where l=2865, 2870, …, 3630: irradiance at the l wavelength, in W/m2/nmmmmm_l
: decimal minute from 00:00 at which the measurement at the l wavelength startedduv
andduv_cost
: erythema-weighted UV irradiances, using the same method as in the standard Brewer software, and the method proposed during COST Action ES1207 (EUBREWNET)uvi
anduvi_cost
: UV indexes calculated asduv
/25 andduv_cost
/25, respectivelycorrection_flag
: binary flag with the corrections applied. In the level 2 UV product, either a clear sky or a diffuse cosine correction may be applied. For the complete list of corrections and their flag values see here
- Debug output: if the
debug
argument is passed in the URL, this function additionally returns the following fields:irr_l16_l
: L1.6 irradiance at wavelength lo3
: ozone value used by BUVICalpha
: Angström's alpha used by BUVICbeta
: Angström's beta used by BUVICalbedo
: albedo vallue used by BUVICcos_corr
: type of cosine correction, eitherdiffuse
orclear_sky