| | |
- add_cloud_data(fdesc, ref, **keywords)
- add the cloud 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
Returns:
=====================================
1. idx:<int>: index of the data set with reference =ref.
- close_cloud_file(fdesc)
- Close fdesc file
Inputs:
--------------------------------------------------
1. fdesc:<file_desc_cl>: class for file access
Returns:
1. None
- get_cld_column_name()
- check column names defined in cloud file
Returns
---------------------------------------
1. fl_colnm_lst:<list, str>: name of columns in file
- get_cld_file_ref(yyyy, mm, dd, **keywords)
- check file reference
for cloud 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.
- get_cloud_data(fdesc, olon, olat, oyyyy, omm, odd, osec, do_debug=False, **keywords)
- read cloud 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.
Returns:
================================================
cld:<array, (nob, )>: cloud at the (olon, olat, otime)
- open_cloud_file(datapath, flnm, yyyy, mm, dd, **keywords)
- setup fdesc for average kernal data
Inputs:
-----------------------------------------------------------
1. flnm:<str>: name of file (reserved for future use )
2. datapath:<str>: file path
3. yyyy: <int>: year
4. mm:<int>: month
5. dd: <int>: day
6: keywords:<dict>: extra for reading file
---Reserved Words:
--->'fl_colnm_lst': <list, t:str>: names of all
columns in the cloud file
--->'delim':<str>: separator in the columns
Returns:
--------------------------------------------------------
1. fdesc:<file_desc_cl>: class for file access
- read_cloud_file(fdesc, **keywords)
- Read cloud data into fdesc
Inputs:
--------------------------------------------------
1. fdesc:<grdfile_desc_cl>: class for file access
2. keywords:<dict>: extra for data reading.
---Reserved Entries
--->replaces: <dict, old:new>: texts should be replaced.
---> zname: <str>: axis name for vertical (e.g., log10(pressure)) axis
---> zval: <array, (nz,)>: vertical axis
---> ax_colnm_lst: <list, t:str>: column name for horizontal axis
---> fl_colno_lst:<lst, t:int>: columns to be read
Returns:
-------------------------------------
1. fdesc:<grdfile_desc_cl>: file access
Notes:
-------------------------------------
1.fdesc.grd_lst and fdesc.gdata_lst will store 1) grid; and 2) gridded data
|