IODA Bundle
ioda_conv_ncio.NcWriter Class Reference

CLASSES. More...

Inheritance diagram for ioda_conv_ncio.NcWriter:
[legend]
Collaboration diagram for ioda_conv_ncio.NcWriter:
[legend]

Public Member Functions

def __init__ (self, NcFname, LocKeyList, TestKeyList=None)
 
def __del__ (self)
 
def OvalName (self)
 
def ObiastermName (self)
 
def ObiaspredName (self)
 
def OerrName (self)
 
def OqcName (self)
 
def NumpyToNcDtype (self, NumpyDtype)
 
def NumpyToIodaDtype (self, NumpyDtype)
 
def ConvertToTimeOffset (self, datestr_vec)
 
def CreateNcVector (self, Nsize, Dtype)
 
def FillNcVector (self, Values, Dtype)
 
def WriteNcAttr (self, AttrData)
 
def WriteNcObsVars (self, ObsVars, VarMdata, VarUnits)
 
def WriteNcMetadata (self, MdataGroup, DimName, Mdata, VarUnits)
 
def ExtractObsData (self, ObsData)
 
def BuildNetcdf (self, ObsVars, LocMdata, VarMdata, AttrData, VarUnits={}, TestData=None)
 

Private Attributes

 _loc_key_list
 
 _test_key_list
 
 _oval_name
 
 _oerr_name
 
 _oqc_name
 
 _obiasterm_name
 
 _obiaspred_name
 
 _nlocs_dim_name
 
 _nvars_dim_name
 
 _nstr_dim_name
 
 _ndatetime_dim_name
 
 _nlocs
 
 _nvars
 This method will extract information from the ObsData dictionary and reformat it into a more amenable form for writing into the output file. More...
 
 _nstring
 
 _ndatetime
 
 _defaultF4
 
 _defaultI4
 
 _rec_num_name
 
 _var_list_name
 
 _loc_md_name
 
 _var_md_name
 
 _test_md_name
 
 _ref_date_time
 This method will dump out the netcdf global attribute data contained in the dictionary AttrData. More...
 
 _fid
 

Detailed Description

CLASSES.

Definition at line 49 of file ioda_conv_ncio.py.

Constructor & Destructor Documentation

◆ __init__()

def ioda_conv_ncio.NcWriter.__init__ (   self,
  NcFname,
  LocKeyList,
  TestKeyList = None 
)

Definition at line 51 of file ioda_conv_ncio.py.

◆ __del__()

def ioda_conv_ncio.NcWriter.__del__ (   self)

Definition at line 104 of file ioda_conv_ncio.py.

Member Function Documentation

◆ BuildNetcdf()

def ioda_conv_ncio.NcWriter.BuildNetcdf (   self,
  ObsVars,
  LocMdata,
  VarMdata,
  AttrData,
  VarUnits = {},
  TestData = None 
)

Definition at line 423 of file ioda_conv_ncio.py.

Here is the call graph for this function:

◆ ConvertToTimeOffset()

def ioda_conv_ncio.NcWriter.ConvertToTimeOffset (   self,
  datestr_vec 
)
Convert from date strings in ioda reference format "YYYY-mm-ddTHH:MM:SSZ" to decimal hour offsets from reference datetime.

Input: datestr_vec is an array of numpy chararrays, representing the raw bytes of the date string
Output: numpy dtype:'f4' array of time offsets in decimal hours from the reference date.

Definition at line 179 of file ioda_conv_ncio.py.

Here is the caller graph for this function:

◆ CreateNcVector()

def ioda_conv_ncio.NcWriter.CreateNcVector (   self,
  Nsize,
  Dtype 
)

Definition at line 201 of file ioda_conv_ncio.py.

Here is the caller graph for this function:

◆ ExtractObsData()

def ioda_conv_ncio.NcWriter.ExtractObsData (   self,
  ObsData 
)

Definition at line 330 of file ioda_conv_ncio.py.

Here is the call graph for this function:

◆ FillNcVector()

def ioda_conv_ncio.NcWriter.FillNcVector (   self,
  Values,
  Dtype 
)

Definition at line 220 of file ioda_conv_ncio.py.

Here is the caller graph for this function:

◆ NumpyToIodaDtype()

def ioda_conv_ncio.NcWriter.NumpyToIodaDtype (   self,
  NumpyDtype 
)

Definition at line 154 of file ioda_conv_ncio.py.

Here is the caller graph for this function:

◆ NumpyToNcDtype()

def ioda_conv_ncio.NcWriter.NumpyToNcDtype (   self,
  NumpyDtype 
)

Definition at line 125 of file ioda_conv_ncio.py.

Here is the caller graph for this function:

◆ ObiaspredName()

def ioda_conv_ncio.NcWriter.ObiaspredName (   self)

Definition at line 116 of file ioda_conv_ncio.py.

◆ ObiastermName()

def ioda_conv_ncio.NcWriter.ObiastermName (   self)

Definition at line 113 of file ioda_conv_ncio.py.

◆ OerrName()

def ioda_conv_ncio.NcWriter.OerrName (   self)

Definition at line 119 of file ioda_conv_ncio.py.

◆ OqcName()

def ioda_conv_ncio.NcWriter.OqcName (   self)

Definition at line 122 of file ioda_conv_ncio.py.

◆ OvalName()

def ioda_conv_ncio.NcWriter.OvalName (   self)

Definition at line 110 of file ioda_conv_ncio.py.

◆ WriteNcAttr()

def ioda_conv_ncio.NcWriter.WriteNcAttr (   self,
  AttrData 
)

Definition at line 245 of file ioda_conv_ncio.py.

Here is the caller graph for this function:

◆ WriteNcMetadata()

def ioda_conv_ncio.NcWriter.WriteNcMetadata (   self,
  MdataGroup,
  DimName,
  Mdata,
  VarUnits 
)

Definition at line 294 of file ioda_conv_ncio.py.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteNcObsVars()

def ioda_conv_ncio.NcWriter.WriteNcObsVars (   self,
  ObsVars,
  VarMdata,
  VarUnits 
)

Definition at line 266 of file ioda_conv_ncio.py.

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ _defaultF4

ioda_conv_ncio.NcWriter._defaultF4
private

Definition at line 83 of file ioda_conv_ncio.py.

◆ _defaultI4

ioda_conv_ncio.NcWriter._defaultI4
private

Definition at line 84 of file ioda_conv_ncio.py.

◆ _fid

ioda_conv_ncio.NcWriter._fid
private

Definition at line 101 of file ioda_conv_ncio.py.

◆ _loc_key_list

ioda_conv_ncio.NcWriter._loc_key_list
private

Definition at line 56 of file ioda_conv_ncio.py.

◆ _loc_md_name

ioda_conv_ncio.NcWriter._loc_md_name
private

Definition at line 93 of file ioda_conv_ncio.py.

◆ _ndatetime

ioda_conv_ncio.NcWriter._ndatetime
private

Definition at line 80 of file ioda_conv_ncio.py.

◆ _ndatetime_dim_name

ioda_conv_ncio.NcWriter._ndatetime_dim_name
private

Definition at line 74 of file ioda_conv_ncio.py.

◆ _nlocs

ioda_conv_ncio.NcWriter._nlocs
private

Definition at line 77 of file ioda_conv_ncio.py.

◆ _nlocs_dim_name

ioda_conv_ncio.NcWriter._nlocs_dim_name
private

Definition at line 71 of file ioda_conv_ncio.py.

◆ _nstr_dim_name

ioda_conv_ncio.NcWriter._nstr_dim_name
private

Definition at line 73 of file ioda_conv_ncio.py.

◆ _nstring

ioda_conv_ncio.NcWriter._nstring
private

Definition at line 79 of file ioda_conv_ncio.py.

◆ _nvars

ioda_conv_ncio.NcWriter._nvars
private

This method will extract information from the ObsData dictionary and reformat it into a more amenable form for writing into the output file.

Definition at line 78 of file ioda_conv_ncio.py.

◆ _nvars_dim_name

ioda_conv_ncio.NcWriter._nvars_dim_name
private

Definition at line 72 of file ioda_conv_ncio.py.

◆ _obiaspred_name

ioda_conv_ncio.NcWriter._obiaspred_name
private

Definition at line 68 of file ioda_conv_ncio.py.

◆ _obiasterm_name

ioda_conv_ncio.NcWriter._obiasterm_name
private

Definition at line 67 of file ioda_conv_ncio.py.

◆ _oerr_name

ioda_conv_ncio.NcWriter._oerr_name
private

Definition at line 63 of file ioda_conv_ncio.py.

◆ _oqc_name

ioda_conv_ncio.NcWriter._oqc_name
private

Definition at line 64 of file ioda_conv_ncio.py.

◆ _oval_name

ioda_conv_ncio.NcWriter._oval_name
private

Definition at line 62 of file ioda_conv_ncio.py.

◆ _rec_num_name

ioda_conv_ncio.NcWriter._rec_num_name
private

Definition at line 87 of file ioda_conv_ncio.py.

◆ _ref_date_time

ioda_conv_ncio.NcWriter._ref_date_time
private

This method will dump out the netcdf global attribute data contained in the dictionary AttrData.

Definition at line 98 of file ioda_conv_ncio.py.

◆ _test_key_list

ioda_conv_ncio.NcWriter._test_key_list
private

Definition at line 59 of file ioda_conv_ncio.py.

◆ _test_md_name

ioda_conv_ncio.NcWriter._test_md_name
private

Definition at line 95 of file ioda_conv_ncio.py.

◆ _var_list_name

ioda_conv_ncio.NcWriter._var_list_name
private

Definition at line 90 of file ioda_conv_ncio.py.

◆ _var_md_name

ioda_conv_ncio.NcWriter._var_md_name
private

Definition at line 94 of file ioda_conv_ncio.py.


The documentation for this class was generated from the following file: