Eubrewnet Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===== 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 [[codes:dbaccess#access_functions|ozone access functions]]

----
===== COMMON OPTIONS =====

==== Formats ====
Besides the formats described [[codes:dbaccess#format|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 | [[http://eubrewnet.aemet.es/eubrewnet/data/process/UVL1_6?brewerid=185&date=2021-09-15&format=zip|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 | [[http://eubrewnet.aemet.es/eubrewnet/data/process/UVL1_6?brewerid=185&date=2021-09-15&format=jsona|jsona  example]] |

==== Input ====
Beside the input options described in [[codes:dbaccess#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 | [[http://eubrewnet.aemet.es/eubrewnet/data/process/UVL1_6?brewerid=185&date=2021-09-15&time=11&format=text|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 | [[http://eubrewnet.aemet.es/eubrewnet/data/process/UVL1_6?brewerid=185&date=2021-09-15&time=11&endtime=15:30&format=text|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 | [[codes:uvaccess#get_uvscans|uvscans]] | [[https://rbcce.aemet.es/eubrewnet/data/get/uvscans?brewerid=157&date=2022-03-09&format=text|Get uvscans]] |
^ compareuvtimes | For two brewers, return the scans starting within some time delta | [[codes:uvaccess#get_compareuvtimes|compareuvtimes]] | [[https://rbcce.aemet.es/eubrewnet/data/get/compareuvtimes?brewerid=157&compid=183&date=2022-03-07&format=text|Get compareuvtimes]] |
^ compareuv | For two brewers, compare the irradiances for the scans starting within some time delta | [[codes:uvaccess#get_compareuv|compareuv]] | [[https://rbcce.aemet.es/eubrewnet/data/get/compareuv?brewerid=157&compid=183&date=2022-03-07&format=text|Get compareuv]] |
^ uvrall | return the start dates of all the operative configurations available in EUBREWNET for a specific Brewer  | [[codes:uvaccess#get_uvrall|uvrall]] | [[http://rbcce.aemet.es/eubrewnet/data/get/uvrall?brewerid=185&format=text|Get uvrall]] |
^ uvl0 | return the raw counts measured by the Brewer | [[codes:uvaccess#get_uvl0|uvl0]] | [[http://rbcce.aemet.es/eubrewnet/data/get/uvl0?brewerid=150&date=2021-08-03&format=text|Get uvl0]] |

==== Get uvscans ====
  * Function: uvscans
  * Description: This function lists the UV scans available in Eubrewnet for a specific Brewer and date range
  * Example: https://rbcce.aemet.es/eubrewnet/data/get/uvscans?brewerid=157&date=2022-03-09&format=text
  * Input:
      - ''brewerid'': see [[codes:dbaccess#common_inputs|Brewerid in common inputs]]
      - ''date'': see [[codes:dbaccess#common_inputs|Date in common inputs]]
      - ''enddate'': see [[codes:dbaccess#common_inputs|Enddate in common inputs]]
      - ''format'': see [[codes:dbaccess#format|Format]]
      - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]]
      - ''scans'': a comma-separated list of UV scan types to list. If ommited, defaults to ''ux,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.
  * Example: https://rbcce.aemet.es/eubrewnet/data/get/compareuvtimes?brewerid=157&compid=183&date=2022-03-07&format=text
  * Input:
      - ''brewerid'': this is the ID of the reference Brewer. This follows the format described in [[codes:dbaccess#common_inputs|Brewerid in common inputs]]
      - ''compid'': this is the ID of the Brewer which is being compared to the reference Brewer
      - ''date'': see [[codes:dbaccess#common_inputs|Date in common inputs]]
      - ''enddate'': see [[codes:dbaccess#common_inputs|Enddate in common inputs]]
      - ''format'': see [[codes:dbaccess#format|Format]]
      - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]]
      - ''scans'': a comma-separated list of UV scan types to list. If ommited, defaults to ''ux,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'' and ''compscan'': type of UV-scan (ua, ux, uv) of the two Brewers
      - ''mmmm'' and ''compmmmm'': decimal minutes from 00:00 to the start of the UV scan for the two Brewers
      - ''deltaminutes'': 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.
  * Example: https://rbcce.aemet.es/eubrewnet/data/get/compareuv?brewerid=157&compid=183&date=2022-03-07&maxminutes=0.5&format=text
  * Input:
      - ''brewerid'': this is the ID of the reference Brewer. This follows the format described in [[codes:dbaccess#common_inputs|Brewerid in common inputs]]
      - ''compid'': this is the ID of the Brewer which is being compared to the reference Brewer
      - ''date'': see [[codes:dbaccess#common_inputs|Date in common inputs]]
      - ''enddate'': see [[codes:dbaccess#common_inputs|Enddate in common inputs]]
      - ''format'': see [[codes:dbaccess#format|Format]]
      - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]]
      - ''scans'': a comma-separated list of UV scan types to list. If ommited, defaults to ''ux,ua,uv''
      - ''maxminutes'': maximum difference between the scans of the two Brewers. If omitted, it defaults to 5 minutes 
      - ''level'': 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'' and ''compscan'': type of UV-scan (ua, ux, uv) of the two Brewers
      - ''mmmm'' and ''compmmmm'': decimal minutes from 00:00 to the start of the UV scan for the two Brewers
      - ''deltaminutes'': diference in decimal minutes between the starting times of the two UV scans
      - ''ratio_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.
  * Example: http://rbcce.aemet.es/eubrewnet/data/get/uvrall?brewerid=185&format=text
  * Input:
      - ''brewerid'': this is the ID of the reference Brewer. This follows the format described in [[codes:dbaccess#common_inputs|Brewerid in common inputs]]
      - ''format'': see [[codes:dbaccess#format|Format]]
      - ''fields'': see [[codes:dbaccess#common_inputs|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 YYYYMMDD 
      - ''config_doy'': same as above, but in JJJYY format, where JJJ is the day number of the year
      - ''config_id'': ID internally used by EUBREWNET to identify the configuration

==== Get UVL0 ====
  * Function: UVL0
  * Description: return the raw counts measured by the Brewer.
  * Example: http://rbcce.aemet.es/eubrewnet/data/get/uvl0?brewerid=150&date=2021-08-03&format=text
  * Input:
      - ''brewerid'': see [[codes:dbaccess#common_inputs|Brewerid in common inputs]]
      - ''date'': see [[codes:dbaccess#common_inputs|Date in common inputs]]
      - ''enddate'': see [[codes:dbaccess#common_inputs|Enddate in common inputs]]
      - ''time'': see [[codes:uvaccess#input|Time in UV-specific inputs]]
      - ''endtime'': see [[codes:uvaccess#input|Endtime in UV-specific inputs]]
      - ''scan'': optional, use to select an scan type (''ux'', ''ua'' , or ''uv'')
      - ''format'': see [[codes:dbaccess#format|Format]] and [[codes:uvaccess#formats|UV format]]
      - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]]
      - ''means'': see [[codes:dbaccess#means|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 wavelength
      - ''mmmm_l'': decimal minute from 00:00 at which the measurement at the l wavelength started
      - ''micrometer_l'': micrometer position at which the measurement at the l wavelength was performed

----

===== PROCESS FUNCTIONS =====

^ Function ^ Description ^ Help ^ Example ^
^ UVL1 | Returns Level 1 UV | [[codes:uvaccess#process_uvl1|UVL1]] | [[https://rbcce.aemet.es/eubrewnet/data/process/UVL1?brewerid=185&date=2021-09-15&enddate=2021-09-16&format=text|Process UVL1]] |
^ UVL1_5 | Returns Level 1.5 UV | [[codes:uvaccess#process_uvl1_5|UVL1_5]] | [[https://rbcce.aemet.es/eubrewnet/data/process/UVL1_5?brewerid=185&date=2021-09-15&enddate=2021-09-16&format=text|Process UVL1_5]] |
^ UVL1_6 | Returns Level 1.6 UV | [[codes:uvaccess#process_uvl1_6|UVL1_6]] | [[https://rbcce.aemet.es/eubrewnet/data/process/UVL1_6?brewerid=185&date=2021-09-15&format=text|Process UVL1_6]] |
^ UVL2 | Returns Level 2 UV | [[codes:uvaccess#process_uvl2|UVL2]] | [[https://rbcce.aemet.es/eubrewnet/data/process/UVL2?brewerid=185&date=2021-09-15&enddate=2021-09-16&format=text|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 [[devel:eubrewnetconfiguration#exclusion_list | 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 [[devel:eubrewnetconfiguration&#uv_response | UV response]] must be available for the requested period.
  * Example: https://rbcce.aemet.es/eubrewnet/data/process/UVL1?brewerid=185&date=2021-09-15&enddate=2021-09-16&format=text
  * Input:
      - ''brewerid'': see [[codes:dbaccess#common_inputs|Brewerid in common inputs]]
      - ''date'': see [[codes:dbaccess#common_inputs|Date in common inputs]]
      - ''enddate'': see [[codes:dbaccess#common_inputs|Enddate in common inputs]]
      - ''time'': see [[codes:uvaccess#input|Time in UV-specific inputs]]
      - ''endtime'': see [[codes:uvaccess#input|Endtime in UV-specific inputs]]
      - ''scan'': optional, use to select an scan type (''ux'', ''ua'' , or ''uv'')
      - ''format'': see [[codes:dbaccess#format|Format]] and [[codes:uvaccess#formats|UV format]]
      - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]]
      - ''means'': see [[codes:dbaccess#means|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 scan
      - ''scan'': type of UV scan performed (uv, ux, ua, ...)
      - ''irr_l'', where l=2865, 2870, ..., 3630: irradiance at the l wavelength, in W/m2/nm
      - ''mmmm_l'': decimal minute from 00:00 at which the measurement at the l wavelength started
      - ''duv'' and ''duv_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'' and ''uvi_cost'': UV indexes calculated as ''duv''/25 and ''duv_cost''/25
      - ''correction_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 [[codes:uvaccess#uv_corrections_flag | 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 l
      - ''straylight_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. An operative UV configuration with the [[devel:eubrewnetconfiguration&#temperature | Temperature correction data]] must be available for the requested period. Output data is further filtered by the [[devel:eubrewnetconfiguration&#exclusion_list | UV Exclusion List]]
  * Example: https://rbcce.aemet.es/eubrewnet/data/process/UVL1_5?brewerid=185&date=2021-09-15&enddate=2021-09-16&format=text
  * Input:
      - ''brewerid'': see [[codes:dbaccess#common_inputs|Brewerid in common inputs]]
      - ''date'': see [[codes:dbaccess#common_inputs|Date in common inputs]]
      - ''enddate'': see [[codes:dbaccess#common_inputs|Enddate in common inputs]]
      - ''time'': see [[codes:uvaccess#input|Time in UV-specific inputs]]
      - ''endtime'': see [[codes:uvaccess#input|Endtime in UV-specific inputs]]
      - ''scan'': optional, use to select an scan type (''ux'', ''ua'' , or ''uv'')
      - ''format'': see [[codes:dbaccess#format|Format]] and [[codes:uvaccess#formats|UV format]]
      - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]]
      - ''means'': see [[codes:dbaccess#means|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 scan
      - ''scan'': type of UV scan performed (uv, ux, ua, ...)
      - ''irr_l'', where l=2865, 2870, ..., 3630: irradiance at the l wavelength, in W/m2/nm
      - ''mmmm_l'': decimal minute from 00:00 at which the measurement at the l wavelength started
      - ''duv'' and ''duv_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'' and ''uvi_cost'': UV indexes calculated as ''duv''/25 and ''duv_cost''/25, respectively
      - ''correction_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 [[codes:uvaccess#uv_corrections_flag | 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 l
      - ''wl_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 [[devel:eubrewnetconfiguration#exclusion_list | UV exclusion list]], and aditionally returns the field:
      - ''filter_flag'': [[codes:uvaccess#uv_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 [[https://www.rivm.nl/en/uv-ozone-layer-and-climate/shicrivm|SHICRIVM code]] developed by Harry Slaper at the [[https://www.rivm.nl/en|National Institute of Public Health and the Environment (RIVM)]]. As of 2022-06-22, the output irradiances are calculated using the same generic slit function for all Brewer instruments. 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 [[devel:eubrewnetconfiguration&#exclusion_list | UV Exclusion List]]
  * Example: https://rbcce.aemet.es/eubrewnet/data/process/UVL1_6?brewerid=185&date=2021-09-15&format=text
  * Input:
      - ''brewerid'': see [[codes:dbaccess#common_inputs|Brewerid in common inputs]]
      - ''date'': see [[codes:dbaccess#common_inputs|Date in common inputs]]
      - ''enddate'': see [[codes:dbaccess#common_inputs|Enddate in common inputs]]
      - ''time'': see [[codes:uvaccess#input|Time in UV-specific inputs]]
      - ''endtime'': see [[codes:uvaccess#input|Endtime in UV-specific inputs]]
      - ''scan'': optional, use to select an scan type (''ux'', ''ua'' , or ''uv'')
      - ''format'': see [[codes:dbaccess#format|Format]] and [[codes:uvaccess#formats|UV format]]
      - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]]
      - ''means'': see [[codes:dbaccess#means|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 scan
      - ''scan'': type of UV scan performed (uv, ux, ua, ...)
      - ''irr_l'', where l=2865, 2870, ..., 3630: irradiance at the l wavelength, in W/m2/nm. Corresponds to the ''Irr instr'' output of SHICRIVM.
      - ''shift_l'': wavelength shifts calculated by SHICRIVM
      - ''mmmm_l'': decimal minute from 00:00 at which the measurement at the l wavelength started
      - ''duv'' and ''duv_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'' and ''uvi_cost'': UV indexes calculated as ''duv''/25 and ''duv_cost''/25, respectively
      - ''correction_flag'': binary flag with the corrections applied. For the complete list of corrections and their flag values see [[codes:uvaccess#uv_corrections_flag | 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 l
      - ''shicrivm_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'': [[codes:uvaccess#uv_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. An operative UV configuration with the [[devel:eubrewnetconfiguration&#cosine_correction | 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 [[devel:eubrewnetconfiguration&#exclusion_list | UV Exclusion List]]
  * Example: https://rbcce.aemet.es/eubrewnet/data/process/UVL2?brewerid=185&date=2021-09-15&enddate=2021-09-16&format=text
  * Input:
      - ''brewerid'': see [[codes:dbaccess#common_inputs|Brewerid in common inputs]]
      - ''date'': see [[codes:dbaccess#common_inputs|Date in common inputs]]
      - ''enddate'': see [[codes:dbaccess#common_inputs|Enddate in common inputs]]
      - ''format'': see [[codes:dbaccess#format|Format]] and [[codes:uvaccess#formats|UV format]]
      - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]]
      - ''means'': see [[codes:dbaccess#means|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 scan
      - ''scan'': type of UV scan performed (uv, ux, ua, ...)
      - ''irr_l'', where l=2865, 2870, ..., 3630: irradiance at the l wavelength, in W/m2/nm
      - ''mmmm_l'': decimal minute from 00:00 at which the measurement at the l wavelength started
      - ''duv'' and ''duv_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'' and ''uvi_cost'': UV indexes calculated as ''duv''/25 and ''duv_cost''/25, respectively
      - ''correction_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 [[codes:uvaccess#uv_corrections_flag | 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 l
      - ''o3'': ozone value used by BUVIC
      - ''alpha'': Angström's alpha used by BUVIC
      - ''beta'': Angström's beta used by BUVIC
      - ''albedo'': albedo vallue used by BUVIC
      - ''cos_corr'': type of cosine correction, either ''diffuse'' or ''clear_sky''

----
Eubrewnet Wiki

User Tools

Site Tools

Page Tools
