# BEAT-II Record: OMI_L2_OMTO3

## Fields

The table below gives an overview of possible fields that can be returned from an ingestion of OMI_L2_OMTO3 data. The 'default' column indicates whether the specified data item is included in the ingestion by default or not. You can change which data items are ingested by making use of the `include`

and `exclude`

filter options (see below).

field name | type | dimensions | default | description |
---|---|---|---|---|

`type` | string | included | reference to the type of data in this record | |

`time` | double | [main] | included | The time of the measurement (in seconds since 2000-01-01 00:00:00) |

`latitude` | double | [main] | included | The center latitude for a ground pixel |

`longitude` | double | [main] | included | The center longitude for a ground pixel |

`corner_latitude` | double | [main, 4] | included | The corner latitude values for a ground pixel |

`corner_longitude` | double | [main, 4] | included | The corner longitude values for a ground pixel |

`o3_column` | double | [main] | included | Ozone vertical column density |

`o3_column_unit` | string | included | DU | |

`o3_column_validity` | int32 | [main] | excluded | Flags describing the ozone vertical column processing quality |

`cloud_fraction` | double | [main] | excluded | Effective or radiative cloud fraction |

`pressure_cloud` | double | [main] | excluded | Effective cloud pressure |

`pressure_cloud_unit` | string | excluded | hPa | |

`pressure_cloud_top` | double | [main] | excluded | Cloud top pressure |

`pressure_cloud_top_unit` | string | excluded | hPa | |

`solar_zenith_angle_wgs84` | double | [main] | excluded | Solar zenith angle at WGS84 ellipsoid for center co-ordinate of the ground pixel |

`solar_azimuth_angle_wgs84` | double | [main] | excluded | Solar azimuth angle at WGS84 ellipsoid for center co-ordinate of the ground pixel, defined Easth-of-North |

`viewing_zenith_angle_wgs84` | double | [main] | excluded | Viewing zenith angle at WGS84 ellipsoid for center co-ordinate of the ground pixel |

`viewing_azimuth_angle_wgs84` | double | [main] | excluded | Solar azimuth angle at WGS84 ellipsoid for center co-ordinate of the ground pixel, defined Easth-of-North |

## Ingestion filter options

Ingestion filter options are passed as a '`,`

' or '`;`

' separated string to the ingestion function. Each filter option needs to be formulated as `option_name=value[ value value]`

(some options accept more than one value). For example, if a product has filter options '`altitude_min`

' and '`time_min`

' you can provide a filter option string `"latitude_min=30,time_min=2003-01-01"`

to get all measurements at or above 30km and on or after January 1st 2003.

option name | type | description |
---|---|---|

`include` | string | Provide a space-separated list of field names to ingest additional data items (i.e. fields that are not ingested by default). You can use the special case `include=*` to indicate that you want to ingest all available data items. |

`exclude` | string | Provide a space-separated list of field names that you don't want ingested. Mind that the exclude filter is processed after the include filter. |

`time_min` | time^{*} | Only include elements for which the value is greater than or equal to the provided filter option value |

`time_max` | time^{*} | Only include elements for which the value is less than or equal to the provided filter option value |

`time` | time^{*} | Only include elements that match the list of given filter option values |

`latitude_min` | double | Only include elements for which the value is greater than or equal to the provided filter option value |

`latitude_max` | double | Only include elements for which the value is less than or equal to the provided filter option value |

`latitude` | double | Only include elements that match the list of given filter option values |

`longitude_min` | double | Only include elements for which the value is greater than or equal to the provided filter option value |

`longitude_max` | double | Only include elements for which the value is less than or equal to the provided filter option value |

`longitude` | double | Only include elements that match the list of given filter option values |

`o3_column_min` | double | |

`o3_column_max` | double | Only include elements for which the value is less than or equal to the provided filter option value |

`o3_column` | double | Only include elements that match the list of given filter option values |

`o3_column_validity_min` | integer | |

`o3_column_validity_max` | integer | Only include elements for which the value is less than or equal to the provided filter option value |

`o3_column_validity` | integer | Only include elements that match the list of given filter option values |

`cloud_fraction_min` | double | |

`cloud_fraction_max` | double | Only include elements for which the value is less than or equal to the provided filter option value |

`cloud_fraction` | double | Only include elements that match the list of given filter option values |

`pressure_cloud_min` | double | |

`pressure_cloud_max` | double | Only include elements for which the value is less than or equal to the provided filter option value |

`pressure_cloud` | double | Only include elements that match the list of given filter option values |

`pressure_cloud_top_min` | double | |

`pressure_cloud_top_max` | double | Only include elements for which the value is less than or equal to the provided filter option value |

`pressure_cloud_top` | double | Only include elements that match the list of given filter option values |

`solar_zenith_angle_wgs84_min` | double | |

`solar_zenith_angle_wgs84_max` | double | Only include elements for which the value is less than or equal to the provided filter option value |

`solar_zenith_angle_wgs84` | double | Only include elements that match the list of given filter option values |

`solar_azimuth_angle_wgs84_min` | double | |

`solar_azimuth_angle_wgs84_max` | double | Only include elements for which the value is less than or equal to the provided filter option value |

`solar_azimuth_angle_wgs84` | double | Only include elements that match the list of given filter option values |

`viewing_zenith_angle_wgs84_min` | double | |

`viewing_zenith_angle_wgs84_max` | double | Only include elements for which the value is less than or equal to the provided filter option value |

`viewing_zenith_angle_wgs84` | double | Only include elements that match the list of given filter option values |

`viewing_azimuth_angle_wgs84_min` | double | |

`viewing_azimuth_angle_wgs84_max` | double | Only include elements for which the value is less than or equal to the provided filter option value |

`viewing_azimuth_angle_wgs84` | double | Only include elements that match the list of given filter option values |

`cloud_fraction_variant` | string | 'effective' (default) or 'radiative' |

^{*} Time values can be passed as either '`yyyy-mm-dd`

', '`yyyy-mm-ddThh:mm:ss`

', '`yyyy-mm-ddThh:mm:ss.uuuuuu`

' or a floating point value indicating the amount of seconds since 2000-01-01 00:00:00.

## Mapping description

Below a description is provided on how each data item in the ingested record was retrieved from the product.

field name | mapping description | |
---|---|---|

`time` |
path | `/HDFEOS/SWATHS/OMI_Column_Amount_O3/Geolocation_Fields/Time[]` |

description | The time converted from TAI93 to seconds since 2000-01-01T00:00:00 | |

`latitude` |
path | `/HDFEOS/SWATHS/OMI_Column_Amount_O3/Geolocation_Fields/Latitude[]` |

`longitude` |
path | `/HDFEOS/SWATHS/OMI_Column_Amount_O3/Geolocation_Fields/Longitude[]` |

`corner_latitude` |
description | The shape and size of each ground pixel is not included in the product. BEAT therefore provides its own approximation. The calculation is based on interpolation of the available center coordinates for each of the ground pixels. Each corner coordinate is determined by its four surrounding center coordinates. The corner coordinate is exactly at the intersection of the cross that can be made with these four points (each line of the cross is the minimal distance along the earth surface from one center coordinate to the other). In situations where a corner coordinate is not surrounded by four center coordinates (i.e. at the boundaries) virtual center coordinates are created by means of extrapolation. The virtual center coordinate is placed such that the distance to its nearest real center coordinate equals the distance between that nearest real center coordinate and the next center coordinate going further inwards. In mathematical notation: when c(i,m+1) is the virtual center coordinate and c(i,m) and c(i,m-1) are real center coordinates, then |c(i,m+1) - c(i,m)| = |c(i,m) - c(i,m-1)| and all three coordinates should lie on the same great circle. The four virtual coordinates that lie in the utmost corners of the boundaries are calculated by extrapolating in a diagonal direction (e.g. c(n+1,m+1) is calculated from c(n,m) and c(n-1,m-1)) |

`corner_longitude` |
description | The shape and size of each ground pixel is not included in the product. BEAT therefore provides its own approximation. The calculation is based on interpolation of the available center coordinates for each of the ground pixels. Each corner coordinate is determined by its four surrounding center coordinates. The corner coordinate is exactly at the intersection of the cross that can be made with these four points (each line of the cross is the minimal distance along the earth surface from one center coordinate to the other). In situations where a corner coordinate is not surrounded by four center coordinates (i.e. at the boundaries) virtual center coordinates are created by means of extrapolation. The virtual center coordinate is placed such that the distance to its nearest real center coordinate equals the distance between that nearest real center coordinate and the next center coordinate going further inwards. In mathematical notation: when c(i,m+1) is the virtual center coordinate and c(i,m) and c(i,m-1) are real center coordinates, then |c(i,m+1) - c(i,m)| = |c(i,m) - c(i,m-1)| and all three coordinates should lie on the same great circle. The four virtual coordinates that lie in the utmost corners of the boundaries are calculated by extrapolating in a diagonal direction (e.g. c(n+1,m+1) is calculated from c(n,m) and c(n-1,m-1)) |

`o3_column` |
path | `/HDFEOS/SWATHS/OMI_Column_Amount_O3/Data_Fields/ColumnAmountO3[]` |

`o3_column_unit` |
description | Will be set to "DU" |

`o3_column_validity` |
path | `/HDFEOS/SWATHS/OMI_Column_Amount_O3/Data_Fields/QualityFlags[]` |

`cloud_fraction` |
condition | V2 product |

path | `/HDFEOS/SWATHS/OMI_Column_Amount_O3/Data_Fields/CloudFraction[]` | |

condition | cloud_fraction_variant=effective and V3 product | |

path | `/HDFEOS/SWATHS/OMI_Column_Amount_O3/Data_Fields/fc[]` | |

condition | cloud_fraction_variant=radiative and V3 product | |

path | `/HDFEOS/SWATHS/OMI_Column_Amount_O3/Data_Fields/RadiativeCloudFraction[]` | |

`pressure_cloud` |
condition | V3 product |

path | `/HDFEOS/SWATHS/OMI_Column_Amount_O3/Data_Fields/CloudPressure[]` | |

`pressure_cloud_unit` |
condition | V3 product |

description | Will be set to "hPa" | |

`pressure_cloud_top` |
condition | V2 product |

path | `/HDFEOS/SWATHS/OMI_Column_Amount_O3/Data_Fields/CloudTopPressure[]` | |

`pressure_cloud_top_unit` |
condition | V2 product |

description | Will be set to "hPa" | |

`solar_zenith_angle_wgs84` |
path | `/HDFEOS/SWATHS/OMI_Column_Amount_O3/Geolocation_Fields/SolarZenithAngle[]` |

`solar_azimuth_angle_wgs84` |
path | `/HDFEOS/SWATHS/OMI_Column_Amount_O3/Geolocation_Fields/SolarAzimuthAngle[]` |

`viewing_zenith_angle_wgs84` |
path | `/HDFEOS/SWATHS/OMI_Column_Amount_O3/Geolocation_Fields/ViewingZenithAngle[]` |

`viewing_azimuth_angle_wgs84` |
path | `/HDFEOS/SWATHS/OMI_Column_Amount_O3/Geolocation_Fields/ViewingAzimuthAngle[]` |