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.
===== AOD Access Functions =====

This pages describes AOD-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 common formats described [[codes:dbaccess#format|here]], the [[codes:uvaccess#formats|jsona]] format can also be used to produce 2d arrays for the ''aod_l'' and ''std_aod_l'' variables, see [[https://rbcce.aemet.es/eubrewnet/data/process/AODL1_5?brewerid=005&date=2017-07-01&format=jsona|this example]]

----

===== GET FUNCTIONS =====

The output of the GET functions is stored in Eubrewnet's database, from where it's retrieved on each function call with little further processing. They are faster than their equivalent PROCESS functions, which process the data in real time, usually starting from the previous level. Whenever possible, GET functions should be used instead of the PROCESS equivalents. 

^ Function ^ Short Description ^ Long Description ^Link          ^
^ JG | Returns the raw, L0 data from the JG measurements as measured by the Brewer | [[codes:aodaccess#get_JG|JG]] | [[https://eubrewnet.aemet.es/eubrewnet/data/get/JG?brewerid=185&date=2022-07-15&format=text|Get JG]] |
^ JL | Returns the raw, L0 data from the JL measurements as measured by the Brewer | [[codes:aodaccess#get_JL|JL]] | [[https://eubrewnet.aemet.es/eubrewnet/data/get/JL?brewerid=257&date=2023-05-07&format=text|Get JL]] |
^ AODL1_5 | Returns the Aerosol Optical Depth Level 1.5 product |[[codes:aodaccess#get_AODL1_5|AODL1_5]] | [[https://eubrewnet.aemet.es/eubrewnet/data/get/AODL1_5?brewerid=185&date=2020-10-01&enddate=2020-10-10|Get AODL1_5]] |
^ AODL1_5byStation | For the selected station, returns the Aerosol Optical Depth Level 1.5 product |[[codes:aodaccess#get_AODL1_5byStation|AODL1_5byStation]] | [[http://eubrewnet.aemet.es/eubrewnet/data/get/AODL1_5byStation?gaw_id=IZO&date=2020-04-05&enddate=2020-04-06&format=text|Get AODL1_5byStation]] |
==== Get JG ====
  * Function: JG
  * Description: returns the raw, L0 JG data as measured by the Brewer.
  * 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|common formats]] and [[codes:uvaccess#formats|jsona format]]
      - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]]
  * Output: the output data includes:
      - ''nd_filter_position'': filter used in the measurement. 0 corresponds to filter position #0, 64 to #1, 128 to #2, 192 to #3, and 256 to #4
      - ''raw_counts_w0'' to ''raw_counts_w5'': counts in the 6 slits 
      - ''steps'': micrometer step

==== Get JL ====
  * Function: JL
  * Description: returns the raw, L0 JL data as measured by the Brewer.
  * 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|common formats]] and [[codes:uvaccess#formats|jsona format]]
      - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]]
  * Output: the output data includes:
      - ''nd_filter_position'': filter used in the measurement. 0 corresponds to filter position #0, 64 to #1, 128 to #2, 192 to #3, and 256 to #4
      - ''raw_counts_w0'' to ''raw_counts_w5'': counts in the 6 slits 
      - ''steps'': micrometer step
==== Get AODL1_5 ====
  * Function: AODL1_5
  * Description: returns Aerosol Optical Depth summaries for the wavelengths considered -- as of October 2020, counts are taken from DS measurements so the AOD is calculated for the six wavelengths at  approx. 303, 306, 310, 313, 317, and 320 nm, provided a calibration exists for each of them. For the the Ozone contribution to the AOD, the O3L1.5 data is used. For full details of the AOD determination, see [[https://www.atmos-chem-phys.net/18/3885/2018/ | J. López-Solano et al., Atmos. Chem. Phys. 18, 3885–3902 (2018)]]. An operative [[http://eubrewnet.aemet.es/dokuwiki/doku.php?id=devel:eubrewnetconfiguration&#brewer_aod_configuration | AOD configuration]] must be available for the requested period.
  * 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|common formats]] and [[codes:uvaccess#formats|jsona format]]
      - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]]
      - ''means'': see [[codes:dbaccess#means|means]]
  * Output: the following AOD-specific fields are included in the standard output alongside the other usual ones (Brewer ID, pressure, sza, ...):
      - ''aodconfigid'': ID of the AOD configuration used in the calculation
      - ''aodconfigdate'': date of the AOD configuration used in the calculation 
      - ''wavelengths_i'': wavelength //i//, in nm. As of October 2020, counts are taken from DS measurements so the AOD is calculated for the six wavelengths at approx. 303, 306, 310, 313, 317, and 320 nm
      - ''aod_i'': AOD for the wavelength //i//
      - ''std_aod_i'': standard deviation of the AOD summaries at wavelength //i//

 **Note**: the ''airmass'' field corresponds to the aerosol airmass, which is currently approximated by the Rayleigh airmass.

==== Get AODL1_5byStation ====
  * Function: O3L1_5byStation
  * Description: This function provides the same output as the [[codes:aodaccess#get_aodl1_5|AODL1_5]]  described above, but for the requested station. As of September 2020, the station products will output the data of the first Brewer defined for a station, or, if not available, that of the second. If data of the second Brewer is also not available, data of the third Brewer will be used, and so on.
  * Example: http://eubrewnet.aemet.es/eubrewnet/data/get/AODL1_5byStation?gaw_id=IZO&date=2020-04-05&enddate=2020-04-06&format=text -- note that in the output there is data for both Brewers #157 and #185: the former is the first Brewer defined in the station view (http://eubrewnet.aemet.es/eubrewnet/station/view/9) but it was not operating on 2020-04-05; Brewer #183 is the second instrument defined for the station, but it was also not operating on this day, so the data of B#185 has been used.
  * Input:
      - ''gaw_id'' or ''woudc_id'': GAW or WOUDC ID of the station
      - ''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]]
      - ''means'': see [[codes:dbaccess#means|means]]
  * Output: same as [[codes:aodaccess#get_aodl1_5|AODL1_5]]

----

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

^ Function ^ Description ^ Help ^ Example ^
^ AODL1_5 | Returns Level 1.5 AOD | [[codes:aodaccess#process_AODL1_5|AODL1_5]] | [[http://eubrewnet.aemet.es/eubrewnet/data/process/AODL1_5?brewerid=185&date=2019-11-01&enddate=2019-11-12|Process AODL1_5]] |
^ AODL1_5JG | Returns Level 1.5 AOD from JG measurements | [[codes:aodaccess#process_AODL1_5JG|AODL1_5JG]] | [[https://rbcce-test.aemet.es/eubrewnet/data/process/AODL1_5JG?brewerid=185&date=2022-08-01&format=text|Process AODL1_5JG]] |
^ AODL1_5ALL | Returns Level 1.5 AOD from DS and JG measurements | [[codes:aodaccess#process_AODL1_5ALL|AODL1_5ALL]] | [[https://rbcce-test.aemet.es/eubrewnet/data/process/AODL1_5ALL?brewerid=185&date=2022-08-01&format=text&fields=gmt,wavel|Process AODL1_5ALL]] |

==== AOD Filter Flags ====

^ Flag name ^ Flag value ^ Description ^
| FLAG_AOD_STD_FILT | 1 | The standard deviation of the AOD summaries is > 0.02 |
| FLAG_AOD_AIRMASS_FILT | 2 | The airmass is larger than some threshold value (Nov 2020: not in use yet) |
| FLAG_AOD_MIN_FILT | 8 | AOD < 0 |
| FLAG_AOD_MAX_FILT | 16 | AOD > 4 |
| FLAG_AOD_BLACKLIST | 32 | Date in the exclusion list |
| FLAG_AOD_BAD_OZONE_FILT | 64 | The ozone data does not have a filter_flag of 0 |

==== Process AODL1_5 ====
  * Function: AODL1_5
  * Description: returns Aerosol Optical Depth summaries for the wavelengths considered -- as of October 2020, counts are taken from DS measurements so the AOD is calculated for the six wavelengths at  approx. 303, 306, 310, 313, 317, and 320 nm, provided a calibration exists for each of them. For the the Ozone contribution to the AOD, the O3L1.5 data is used. For full details of the AOD determination, see [[https://www.atmos-chem-phys.net/18/3885/2018/ | J. López-Solano et al., Atmos. Chem. Phys. 18, 3885–3902 (2018)]]. An operative [[http://eubrewnet.aemet.es/dokuwiki/doku.php?id=devel:eubrewnetconfiguration&#brewer_aod_configuration | AOD configuration]] must be available for the requested period.
  * Example: http://eubrewnet.aemet.es/eubrewnet/data/process/AODL1_5?brewerid=185&date=2019-11-01&enddate=2019-11-12
  * 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|common formats]] and [[codes:uvaccess#formats|jsona format]]
      - ''fields'': see [[codes:dbaccess#common_inputs|Fields in common inputs]]
      - ''debug'': returns additional information, including separate contributions to the AOD from the Ozone, Rayleigh, and counts.
      - ''rejected'': returns all the individual measurements, including those rejected. As in the case of Ozone, the cause for rejection is coded in the ''aod_filter_flag'' fields -- the values are analogue to those of the [[codes:ozoneproduct#level_15_realtime_observation | Ozone filter flag]], see [[codes:aodaccess#aod_filter_flag|this table]]
      - ''showerrors'': displays errors found during the calculation.
      - ''means'': see [[codes:dbaccess#means|means]]
  * Output: the following AOD-specific fields are included in the standard output alongside the other usual ones (Brewer ID, pressure, sza, ...):
      - ''aodconfigid'': ID of the AOD configuration used in the calculation
      - ''aodconfigdate'': date of the AOD configuration used in the calculation 
      - ''wavelengths_i'': wavelength //i//, in nm. As of October 2020, counts are taken from DS measurements so the AOD is calculated for the six wavelengths at approx. 303, 306, 310, 313, 317, and 320 nm
      - ''aod_i'': AOD for the wavelength //i//
      - ''std_aod_i'': standard deviation of the AOD summaries at wavelength //i//

==== Process AODL1_5JG ====
  * Function: AODL1_5JG
  * Description: returns Aerosol Optical Depth summaries for the wavelengths in the AOD-specific JG measurements. An operative [[http://eubrewnet.aemet.es/dokuwiki/doku.php?id=devel:eubrewnetconfiguration&#brewer_aod_configuration | AOD configuration]] for JG wavelengths must be available for the requested period.
  * Example: https://rbcce-test.aemet.es/eubrewnet/data/process/AODL1_5JG?brewerid=185&date=2022-08-01&format=text
  * Input: same as [[codes:aodaccess#process_aodl1_5|process AOD L1.5]]. Note that ''means'' might mix different wavelengths!
  * Ouput: same as [[codes:aodaccess#process_aodl1_5|process AOD L1.5]]

==== Process AODL1_5ALL ====
  * Function: AODL1_5ALL
  * Description: returns Aerosol Optical Depth summaries for the wavelengths in both the DS and the AOD-specific JG measurements. An operative [[http://eubrewnet.aemet.es/dokuwiki/doku.php?id=devel:eubrewnetconfiguration&#brewer_aod_configuration | AOD configuration]] must be available for the requested period.
  * Example: return the wavelengths measured in each observation: [[https://rbcce-test.aemet.es/eubrewnet/data/process/AODL1_5ALL?brewerid=185&date=2022-08-01&format=text&fields=gmt,wavel*]]
  * Input: same as [[codes:aodaccess#process_aodl1_5|process AOD L1.5]]. Note that ''means'' might mix different wavelengths!
  * Ouput: same as [[codes:aodaccess#process_aodl1_5|process AOD L1.5]]
Eubrewnet Wiki

User Tools

Site Tools

Page Tools
