codes:uvaccess
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
codes:uvaccess [2023/05/08 09:30] jlsolano [Get UVL0] |
codes:uvaccess [2024/04/11 11:51] (current) jlsolano [UV Access Functions] |
||
|---|---|---|---|
| Line 2: | Line 2: | ||
| 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]] | 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]] | ||
| + | |||
| + | See [[https://drive.google.com/file/d/1JPpzt8Ab_1A_QzWpZThd0xAXWe3l5ymM/view?usp=sharing|this presentation]] for a short overview of the UV configuration and processing levels. | ||
| ---- | ---- | ||
| Line 27: | Line 29: | ||
| ^ 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]] | | ^ 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]] | | ^ 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]] | | ||
| + | ^ uvrbydate | return the UVR operative in EUBREWNET for a specific Brewer and date | [[codes:uvaccess#get_uvrbydate|uvrbydate]] | [[http://rbcce.aemet.es/eubrewnet/data/get/uvrbydate?brewerid=185&date=today&format=text|Get uvrbydate]] | | ||
| ^ 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]] | | ^ 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]] | | ||
| Line 67: | Line 70: | ||
| * Example: https://rbcce.aemet.es/eubrewnet/data/get/compareuv?brewerid=157&compid=183&date=2022-03-07&maxminutes=0.5&format=text | * Example: https://rbcce.aemet.es/eubrewnet/data/get/compareuv?brewerid=157&compid=183&date=2022-03-07&maxminutes=0.5&format=text | ||
| * Input: | * Input: | ||
| - | - ''brewerid'': this is the ID of the reference Brewer. This follows the format described in [[codes:dbaccess#common_inputs|Brewerid in common inputs]] | + | - ''brewerid'': 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 | + | - ''compid'': ID of the Brewer which is being compared to the reference Brewer |
| - ''date'': see [[codes:dbaccess#common_inputs|Date in common inputs]] | - ''date'': see [[codes:dbaccess#common_inputs|Date in common inputs]] | ||
| - ''enddate'': see [[codes:dbaccess#common_inputs|Enddate in common inputs]] | - ''enddate'': see [[codes:dbaccess#common_inputs|Enddate in common inputs]] | ||
| Line 95: | Line 98: | ||
| - ''config_id'': ID internally used by EUBREWNET to identify the configuration | - ''config_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. | ||
| + | * Example: http://rbcce.aemet.es/eubrewnet/data/get/uvrbydate?brewerid=185&date=today&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]] | ||
| + | - ''date'': date in YYYY-MM-DD format | ||
| + | - ''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_id'': ID internally used by EUBREWNET to identify the configuration | ||
| + | - ''wavelength'': wavelength in Angstroms | ||
| + | - ''responsivity'' : responsivity in counts/mW/m<sup>2</sup>/nm | ||
| ==== Get UVL0 ==== | ==== Get UVL0 ==== | ||
| * Function: UVL0 | * Function: UVL0 | ||
| Line 105: | Line 122: | ||
| - ''time'': see [[codes:uvaccess#input|Time in UV-specific inputs]] | - ''time'': see [[codes:uvaccess#input|Time in UV-specific inputs]] | ||
| - ''endtime'': see [[codes:uvaccess#input|Endtime in UV-specific inputs]] | - ''endtime'': see [[codes:uvaccess#input|Endtime in UV-specific inputs]] | ||
| - | - ''scan'': optional, selects a scan type (''ux'', ''ua'' , or ''uv'') | + | - ''scan'': optional, use to select an scan type (''ux'', ''ua'' , or ''uv'') |
| - ''format'': see [[codes:dbaccess#format|Format]] and [[codes:uvaccess#formats|UV format]] | - ''format'': see [[codes:dbaccess#format|Format]] and [[codes:uvaccess#formats|UV format]] | ||
| - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]] | - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]] | ||
| Line 154: | Line 171: | ||
| - ''time'': see [[codes:uvaccess#input|Time in UV-specific inputs]] | - ''time'': see [[codes:uvaccess#input|Time in UV-specific inputs]] | ||
| - ''endtime'': see [[codes:uvaccess#input|Endtime 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]] | - ''format'': see [[codes:dbaccess#format|Format]] and [[codes:uvaccess#formats|UV format]] | ||
| - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]] | - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]] | ||
| Line 170: | Line 188: | ||
| ==== Process UVL1_5 ==== | ==== Process UVL1_5 ==== | ||
| * Function: 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]] | + | * 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 [[devel:eubrewnetconfiguration&#temperature | Temperature correction coefficients]] 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 | * Example: https://rbcce.aemet.es/eubrewnet/data/process/UVL1_5?brewerid=185&date=2021-09-15&enddate=2021-09-16&format=text | ||
| * Input: | * Input: | ||
| Line 178: | Line 196: | ||
| - ''time'': see [[codes:uvaccess#input|Time in UV-specific inputs]] | - ''time'': see [[codes:uvaccess#input|Time in UV-specific inputs]] | ||
| - ''endtime'': see [[codes:uvaccess#input|Endtime 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]] | - ''format'': see [[codes:dbaccess#format|Format]] and [[codes:uvaccess#formats|UV format]] | ||
| - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]] | - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]] | ||
| Line 196: | Line 215: | ||
| ==== Process UVL1_6 ==== | ==== Process UVL1_6 ==== | ||
| * Function: 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]] | + | * 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, shift-corrected 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 | * Example: https://rbcce.aemet.es/eubrewnet/data/process/UVL1_6?brewerid=185&date=2021-09-15&format=text | ||
| * Input: | * Input: | ||
| Line 204: | Line 223: | ||
| - ''time'': see [[codes:uvaccess#input|Time in UV-specific inputs]] | - ''time'': see [[codes:uvaccess#input|Time in UV-specific inputs]] | ||
| - ''endtime'': see [[codes:uvaccess#input|Endtime 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]] | - ''format'': see [[codes:dbaccess#format|Format]] and [[codes:uvaccess#formats|UV format]] | ||
| - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]] | - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]] | ||
| Line 210: | Line 230: | ||
| - ''mmmm'': decimal minutes from 00:00 to the start of the UV scan | - ''mmmm'': decimal minutes from 00:00 to the start of the UV scan | ||
| - ''scan'': type of UV scan performed (uv, ux, ua, ...) | - ''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. | + | - ''irr_l'', where l=2865, 2870, ..., 3630: shift-corrected irradiance at the l wavelength, in W/m2/nm. Corresponds to the ''Irr instr'' output of SHICRIVM. |
| - ''shift_l'': wavelength shifts calculated by SHICRIVM | - ''shift_l'': wavelength shifts calculated by SHICRIVM | ||
| - ''mmmm_l'': decimal minute from 00:00 at which the measurement at the l wavelength started | - ''mmmm_l'': decimal minute from 00:00 at which the measurement at the l wavelength started | ||
| Line 224: | Line 244: | ||
| ==== Process UVL2 ==== | ==== Process UVL2 ==== | ||
| * Function: 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]] | + | * 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 [[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 | * Example: https://rbcce.aemet.es/eubrewnet/data/process/UVL2?brewerid=185&date=2021-09-15&enddate=2021-09-16&format=text | ||
| * Input: | * Input: | ||
| Line 230: | Line 250: | ||
| - ''date'': see [[codes:dbaccess#common_inputs|Date in common inputs]] | - ''date'': see [[codes:dbaccess#common_inputs|Date in common inputs]] | ||
| - ''enddate'': see [[codes:dbaccess#common_inputs|Enddate in common inputs]] | - ''enddate'': see [[codes:dbaccess#common_inputs|Enddate in common 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]] | - ''format'': see [[codes:dbaccess#format|Format]] and [[codes:uvaccess#formats|UV format]] | ||
| - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]] | - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]] | ||
codes/uvaccess.1683538238.txt.gz · Last modified: 2023/05/08 09:30 by jlsolano
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 3.0 Unported
