Table of Contents
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 ozone access functions
See this presentation for a short overview of the AOD configuration and processing of DS measurements.
COMMON OPTIONS
Formats
Besides the common formats described here, the jsona format can also be used to produce 2d arrays for the aod_l
and std_aod_l
variables, see 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 | JG | Get JG |
JL | Returns the raw, L0 data from the JL measurements as measured by the Brewer | JL | Get JL |
AODL1 | Returns the Aerosol Optical Depth Level 1 product for DS measurements | AODL1 | |
AODL1ALL | Returns the Aerosol Optical Depth Level 1 product for both DS and JG measurements | AODL1ALL | Get AODL1ALL |
AODL1_5 | Returns the Aerosol Optical Depth Level 1.5 product for DS measurements | AODL1_5 | Get AODL1_5 |
AODL1_5ALL | Returns the Aerosol Optical Depth Level 1.5 product for both DS and JG measurements | AODL1_5ALL | Get AODL1_5ALL |
AODL1_5byStation | For the selected station, returns the Aerosol Optical Depth Level 1.5 product | AODL1_5byStation | Get AODL1_5byStation |
AODConfigAll | return all AOD configurations | AODConfigAll | Get AODConfigAll |
AODConfigbyDate | return the operative AOD configuration for the requested Brewer and date | AODConfigbyDate | Get AODConfigbyDate |
Get JG
- Function: JG
- Description: returns the raw, L0 JG data as measured by the Brewer.
- Input:
brewerid
: see Brewerid in common inputsdate
: see Date in common inputsenddate
: see Enddate in common inputsfields
: see 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 #4raw_counts_w0
toraw_counts_w5
: counts in the 6 slitssteps
: micrometer step
Get JL
- Function: JL
- Description: returns the raw, L0 JL data as measured by the Brewer.
- Input:
brewerid
: see Brewerid in common inputsdate
: see Date in common inputsenddate
: see Enddate in common inputsfields
: see 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 #4raw_counts_w0
toraw_counts_w5
: counts in the 6 slitssteps
: micrometer step
Get AODL1
- Function: AODL1
- Description: for DS measurements, returns the AOD and corrected counts for the AOD calculation. Corrections included are dark counts, dead time, temperature, filter attenuation, Earth-Sun distance, and polarization. O3L1 ozone is used in the AOD calculation. For full details of the AOD determination, see J. López-Solano et al., Atmos. Chem. Phys. 18, 3885–3902 (2018). An operative AOD configuration must be available for the requested period.
- Input:
brewerid
: see Brewerid in common inputsdate
: see Date in common inputsenddate
: see Enddate in common inputsfields
: see Fields in common inputsshowerrors
: displays errors found during the calculation.
- 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 calculationaodconfigdate
: date of the AOD configuration used in the calculationwavelengths_i
: wavelength i, in nmaod_i
: AOD for the wavelength icounts_i
: corrected counts for the wavelength i
Get AODL1ALL
- Function: AODL1ALL
- Description: for both DS and JG measurements, returns the AOD and corrected counts for the AOD calculation. Corrections included are dark counts, dead time, temperature, filter attenuation, Earth-Sun distance, and polarization. O3L1 ozone is used in the AOD calculation. For full details of the AOD determination, see J. López-Solano et al., Atmos. Chem. Phys. 18, 3885–3902 (2018). An operative AOD configuration must be available for the requested period.
- Input:
brewerid
: see Brewerid in common inputsdate
: see Date in common inputsenddate
: see Enddate in common inputsfields
: see Fields in common inputsshowerrors
: displays errors found during the calculation.
- 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 calculationaodconfigdate
: date of the AOD configuration used in the calculationwavelengths_i
: wavelength i, in nmaod_i
: AOD for the wavelength icounts_i
: corrected counts for the wavelength i
Get AODL1_5
- Function: AODL1_5
- Description: returns Aerosol Optical Depth summaries for the DS wavelengths, 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 J. López-Solano et al., Atmos. Chem. Phys. 18, 3885–3902 (2018). An operative AOD configuration must be available for the requested period.
- Input:
brewerid
: see Brewerid in common inputsdate
: see Date in common inputsenddate
: see Enddate in common inputsfields
: see Fields in common inputsmeans
: see 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 calculationaodconfigdate
: date of the AOD configuration used in the calculationwavelengths_i
: wavelength i, in nm. The DS wavelengths are approx. 303, 306, 310, 313, 317, and 320 nmaod_i
: AOD for the wavelength istd_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_5ALL
- Function: AODL1_5ALL
- Description: For both DS and JG, returns Aerosol Optical Depth summaries for all the wavelengths with a calibration. For the the Ozone contribution to the AOD, the O3L1.5 data is used. For full details of the AOD determination, see J. López-Solano et al., Atmos. Chem. Phys. 18, 3885–3902 (2018). An operative AOD configuration must be available for the requested period.
- Input:
brewerid
: see Brewerid in common inputsdate
: see Date in common inputsenddate
: see Enddate in common inputsfields
: see Fields in common inputsmeans
: see meansgroupsum
: (work in progress, use at your own risk!) group all measurements with the samen_sum
value and, if there are 30 measurements (4*6 from JG and 1*6 from DS), return them; should only be used on single days, with both DS and JG measurements
- 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 calculationaodconfigdate
: date of the AOD configuration used in the calculationwavelengths_i
: wavelength i, in nm.aod_i
: AOD for the wavelength istd_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: AODL1_5byStation
- Description: This function provides the same output as the 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
orwoudc_id
: GAW or WOUDC ID of the stationdate
: see Date in common inputsenddate
: see Enddate in common inputsformat
: see Formatmeans
: see means
- Output: same as AODL1_5
Get AODConfigAll
- Function: AODConfigAll
- Description: return a summary of all the available AOD configurations
- Input:
brewerid
: optional, to show only the configurations of the requested Brewernon_operative
: optional, to show also non-operative configurations
- Output: a table with
brewerid
,date
, andcomments
fields
Get AODConfigbyDate
- Function: AODConfigbyDate
- Description: return the operative AOD configuration for the requested Brewer and date
- Input:
brewerid
: id of the requested Brewerdate
: date to check
- Output: a table with the complete AOD configuration, one line for each wavelength
PROCESS FUNCTIONS
Function | Description | Help | Example |
---|---|---|---|
JGL1 | Returns Level 1 JG corrected counts (dark counts, dead time, temperature, and filter attenuation) | JGL1 | Process AODL1JG |
AODL1 | Returns Level 1 DS corrected counts (dark counts, dead time, temperature, filter attenuation, Sun-Earth distance, and polarization) and AOD | AODL1 | Process AODL1 |
AODL1JG | Returns Level 1 JG corrected counts and AOD | AODL1JG | Process AODL1JG |
AODL1ALL | Returns Level 1 DS and JG corrected counts and AOD | AODL1ALL | Process AODL1_5ALL |
AODL1_5 | Returns Level 1.5 AOD for DS measurements | AODL1_5 | Process AODL1_5 |
AODL1_5JG | Returns Level 1.5 AOD for JG measurements | AODL1_5JG | Process AODL1_5JG |
AODL1_5ALL | Returns Level 1.5 AOD for DS and JG measurements | AODL1_5ALL | 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 JGL1
- Function: JGL1
- Description: returns the JG counts corrected for dark counts, dead time, temperature, and filter attenuation – ie, the same corrections as O3L1. An operative AOD configuration must be available for the requested period.
- Input:
brewerid
: see Brewerid in common inputsdate
: see Date in common inputsenddate
: see Enddate in common inputsfields
: see Fields in common inputsshowerrors
: displays errors found during the calculation.step
: optional, return data only for the requested micrometer step.
- 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 calculationaodconfigdate
: date of the AOD configuration used in the calculationwavelengths_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 nmcounts_i
: corrected counts for the wavelength i
Process AODL1
- Function: AODL1
- Description: returns the AOD and DS corrected counts for the AOD calculation. Corrections included are dark counts, dead time, temperature, filter attenuation, Earth-Sun distance, and polarization. O3L1 ozone is used in the AOD calculation. For full details of the AOD determination, see J. López-Solano et al., Atmos. Chem. Phys. 18, 3885–3902 (2018). An operative AOD configuration must be available for the requested period.
- Input:
brewerid
: see Brewerid in common inputsdate
: see Date in common inputsenddate
: see Enddate in common inputsfields
: see Fields in common inputsshowerrors
: displays errors found during the calculation.step
: optional, return data only for the requested micrometer step
- 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 calculationaodconfigdate
: date of the AOD configuration used in the calculationwavelengths_i
: wavelength i, in nm. The DS six wavelengths are approx. 303, 306, 310, 313, 317, and 320 nmaod_i
: AOD for the wavelength icounts_i
: corrected counts for the wavelength i in real (not brewer) space
Process AODL1JG
- Function: AODL1JG
- Description: returns the corrected counts for the wavelengths in the AOD-specific JG measurements. An operative AOD configuration for JG wavelengths must be available for the requested period.
- Input: same as process AOD L1
- Ouput: same as process AOD L1
Process AODL1ALL
- Function: AODL1ALL
- Description: returns corrected counts for the wavelengths in both the DS and the AOD-specific JG measurements. An operative AOD configuration must be available for the requested period.
- Example: return the wavelengths measured in each observation: https://eubrewnet.aemet.es/eubrewnet/data/process/AODL1ALL?brewerid=185&date=2023-11-12&format=text&fields=gmt,wavel*
- Input: same as process AOD L1
- Ouput: same as process AOD L1
Process AODL1_5
- Function: AODL1_5
- Description: returns Aerosol Optical Depth summaries for the DS measurements, at wavelengths of 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 J. López-Solano et al., Atmos. Chem. Phys. 18, 3885–3902 (2018). An operative AOD configuration must be available for the requested period.
- Input:
brewerid
: see Brewerid in common inputsdate
: see Date in common inputsenddate
: see Enddate in common inputsfields
: see Fields in common inputsdebug
: 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 theaod_filter_flag
fields – the values are analogue to those of the Ozone filter flag, see this tableshowerrors
: displays errors found during the calculation.step
: optional, return data only for the requested micrometer stepmeans
: see 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 calculationaodconfigdate
: date of the AOD configuration used in the calculationwavelengths_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 nmaod_i
: AOD for the wavelength istd_aod_i
: standard deviation of the AOD summaries at wavelength icounts_i
: corrected counts for the wavelength i in real (not brewer) space
Process AODL1_5JG
- Function: AODL1_5JG
- Description: returns Aerosol Optical Depth summaries for the wavelengths in the AOD-specific JG measurements. An operative AOD configuration for JG wavelengths must be available for the requested period.
- Input: same as process AOD L1.5. Note that
means
might mix different wavelengths! - Ouput: same as 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 AOD configuration must be available for the requested period.
- Example: return the wavelengths measured in each observation: https://eubrewnet.aemet.es/eubrewnet/data/process/AODL1_5ALL?brewerid=185&date=2023-11-12&format=text&fields=gmt,wavel*
- Input: same as process AOD L1.5. Note that
means
might mix different wavelengths! - Ouput: same as process AOD L1.5