ESA.instrument.cloud_file_ecmwf
index
/home/lfeng/otool/ESA/instrument/cloud_file_ecmwf.py

Functions to read cloud file  
Functions:
===============================================
 
1.  open_cloud_file: setup file access class
2.  read_cloud_file: read file to variable list 
3.  close_cloud_file: close file 
4.  get_value: get value at given location 
 
 
Parameters:
=========================================================
1. cld_filename_format='cld_ecmwf.'+'XYYYYX'+'XMMX'+'.nc'
2. cf_lon_nm='longitude'  # longitude name used in cloud file  
3. cf_lat_nm='latitude'   # latitude name used in cloud file  
4. cf_time_nm='time'      # time name used in cloud file 
5. cf_var_nm='tcc'        # total column cloud

 
Modules
       
ESA.util.gp_axis_m
ESA.util.gp_grid_m
ESA.util.message_m
ESA.util.otool_ncfile_io
numpy
ESA.util.otool_obj
ESA.util.otool_var_io
ESA.util.process_nf_array
ESA.util.time_module

 
Functions
       
close_cloud_file(fdesc)
get_value(fdesc, olon, olat, otau)
get cloud data at given coordinate 
 
Inputs: 
----------------------------------------------
1.fdesc:<<ncfile_desc_cl>: file access
2. olon:<float>: longitude
3. olat:<float>: latitude
4. otau:<float>: time (in hours since 1985.01.01)
 
 
Returns:
--------------------------------------------
1. pcld:<float>: cloud cover percentage
open_cloud_file(datapath, flnm, yyyy, mm, dd, read_to_array=False, use_current_time=False)
open cloud netcdf file 
Inputs:
---------------------------------------
1. datapath:<str>: file path
2. flnm:<str>: file name (not used)
3. yyyy:<int>: year
4. mm:<int>: month 
5. dd:<int>: day 
6. read_to_array:<T/F>: if Ture, a copy of data, instead of the method,  will be read.
7.  use_current_time:<T/F>: 
---if Ture, the input year (year) will be used
---if False, the default year (cld_def_year) will be used
 
Returns
-----------------------------------------
1. fdesc: <ncfile_desc_cl>: file access to netcdf file
read_cloud_file(fdesc)
Read data from netcdf file
 
Inputs:
---------------------------------------
1. fdesc:<ncfile_desc_cl>: netcdf file access

 
Data
        cf_lat_nm = 'latitude'
cf_lon_nm = 'longitude'
cf_time_nm = 'time'
cf_var_nm = 'tcc'
cld_def_dd = 1
cld_def_mm = 1
cld_def_yyyy = 2003
cld_filename_format = 'cld_ecmwf.XYYYYXXMMX.nc'