| | |
- add_aod_data(fdesc, ref, **keywords)
- add AOD data defined by ref to the fdesc
Inputs:
=====================================
1. fdesc:<grdfile_io_cl>: class for file access
2. ref:<str/numeric>: reference for data sets read from file
3. keywords:<dict>: extra parameters
--->ax_colnm_lst:<list, t:str>: column names for 'horizontal' (such as lon and lat) axises
--->zname: <str>: axis name for vertical (i.e, log10(pressure)) axis
--->zval: <array, (nz,)>: vertical axis
--->'replaces':<dict>: words to be replaced when decoding line
Returns:
=====================================
1. idx:<int>: index of the data set with reference =ref.
- close_aod_file(fdesc)
- Close fdesc file
Inputs:
--------------------------------------------------
1. fdesc:<file_desc_cl>: class for file access
Returns:
1. None
- get_aod_column_name()
- check column names defined in AK file
Returns
---------------------------------------
1. fl_colnm_lst:<list, str>: name of columns in file
- get_aod_data(fdesc, olon, olat, oyyyy, omm, odd, osec, do_debug=False, **keywords)
- read aod data at given point
Inputs:
---------------------------------------
1. fdesc:<grdfile_io_cl>: file access
2. olon: <array, (nob,)>: longitude
3. olat: <array, (nob,)>: latitude
4. oyyyy:<array (nob)>: year (for future use)
--- oyyyy can also be a single value
5. omm: <int/array (nob)>: month
--- omm can also be a single value
6. odd:<int/array (nob)>: day (for future use)
7. osec:<float/array (nob)>: seconds (for future use)
8. keywords:<dict>: extra inputs
---Reserved Entries
---common_ref:<str/numeric>: the reference shared by observations.
--->ax_colnm_lst:<list, t:str>: column names for 'horizontal' (such as sza and aod) axises
--->zname: <str>: axis name for vertical (i.e, log10(pressure)) axis
--->zval: <array, (nz,)>: vertical axis
--->'replaces':<dict>: words to be replaced when decoding line
Returns:
================================================
1.zval:<array, (nob,nz)>: aod values
2.aod_pb:<array, (nob,nz)>: aod PDF at the (olon, olat, otime)
- get_aod_file_ref(yyyy, mm, dd, **keywords)
- check file reference
for aod climatology, the reference number is
climatology months [1, 4, 7, 10]
Inputs:
----------------------------------------------------
1. yyyy:<array, (ntime,)>: year
2. mm: <array, (ntime,)>: month
3. dd:<array, (ntime,)>: dd
4. keywords:<dict>: extra information
Returns:
------------------------------------------------------
1. ref:<int>: reference number
--- ref can be [1, 4, 7 or 10] for climatology month.
- open_aod_file(datapath, flnm, yyyy, mm, dd, **keywords)
- setup fdesc for aerosol optical depth file
Inputs:
-----------------------------------------------------------
1. flnm:<str>: name of file (reserved for future use )
2. datapath:<str>: file path
3. viewtype:<str>: instrument type
4. viewmode:<str>: nadir or glint view
5. yyyy: <int>: year
6. doy: <int>: day of year
7. keywords:<dict>: extra for reading file
---Reserved words
---fl_colnm_lst:<list, t:str>: names of all columns in the averaging kernel file
Returns:
--------------------------------------------------------
1. fdesc:<file_desc_cl>: class for file access
- read_aod_file(fdesc, **keywords)
- Read averaging kernel data into fdesc
Inputs:
--------------------------------------------------
1. fdesc:<file_desc_cl>: class for file access
2. keywords:<dict>: extra for file reading
---Reserved keys
--->ax_colnm_lst:<list, t:str>: column names for 'horizontal' (such as sza and aod) axises
--->zname: <str>: axis name for vertical (i.e, log10(pressure)) axis
--->zval: <array, (nz,)>: vertical axis
--->'replaces':<dict>: words to be replaced when decoding line
Returns:
-------------------------------------
1. ndata:<int>: size of AK table
Notes:
-------------------------------------
1.fdesc.grd and fdesc.gdata will store 1) grid; and 2) gridded table
|