Changeset 268ee86 in flex_extract.git for source/python/classes/GribUtil.py

Timestamp:

Dec 13, 2018, 11:51:17 PM (5 years ago)

Author:

Anne Philipp <anne.philipp@…>

Branches:

master, ctbto, dev

Children:

145fbe0

Parents:

fdfaf00

Message:

renamed class; added some docstring information for input parameters; added a function to read a dummy grib message

File:

• source/python/classes/GribUtil.py (modified) (12 diffs)

source/python/classes/GribUtil.py

@@ -32 +32 @@
 #    - get_keys
 #    - set_keys
-#    - copy
+#    - copy_dummy_msg
 #    - index
 #
@@ -48 +48 @@
                      codes_release, codes_set, codes_write, codes_index_read,
                      codes_index_new_from_file, codes_index_add_file,
-                     codes_index_write)
+                     codes_index_write, codes_set_values)
 
 # ------------------------------------------------------------------------------
 # CLASS
 # ------------------------------------------------------------------------------
-class GribTools(object):
+class GribUtil(object):
     '''
     Class for GRIB utilities (new methods) based on GRIB API
@@ -61 +61 @@
     # --------------------------------------------------------------------------
     def __init__(self, filenames):
-        '''Initialise an object of GribTools and assign a list of filenames.
+        '''Initialise an object of GribUtil and assign a list of filenames.
 
         Parameters
@@ -139 +139 @@
                  wherekeyvalues=[], strict=False, filemode='w'):
         '''Opens the file to read the grib messages and then write
-        them to a new output file. By default all messages are
-        written out. Also, the keyvalues of the passed list of
-        keynames are set or only those meeting the where statement.
-        (list of key and list of values).
+        the selected messages (with wherekeys) to a new output file.
+        Also, the keyvalues of the passed list of keynames are set.
 
         Parameters
@@ -150 +148 @@
 
         keynames : :obj:`list` of :obj:`string`
-            List of keynames. Default is an empty list.
+            List of keynames to set in the selected messages.
+            Default is an empty list.
 
         keyvalues : :obj:`list` of :obj:`string`
-            List of keynames. Default is an empty list.
+            List of keyvalues to set in the selected messages.
+            Default is an empty list.
 
         wherekeynames : :obj:`list` of :obj:`string`, optional
+            List of keynames to select correct message.
             Default value is an empty list.
 
         wherekeyvalues : :obj:`list` of :obj:`string`, optional
+            List of keyvalues for keynames to select correct message.
             Default value is an empty list.
 
@@ -173 +175 @@
 
         '''
+        if len(wherekeynames) != len(wherekeyvalues):
+            raise Exception("Give a value for each keyname!")
+
         fout = open(self.filenames, filemode)
         fin = open(fromfile)
 
         while 1:
-            gid = codes_new_from_file(fin)
+            gid = codes_grib_new_from_file(fin)
 
             if gid is None:
                 break
-
-            if len(wherekeynames) != len(wherekeyvalues):
-                raise Exception("Give a value for each keyname!")
 
             select = True
@@ -189 +191 @@
             for wherekey in wherekeynames:
                 if not codes_is_defined(gid, wherekey):
-                    raise Exception("where Key was not defined")
+                    raise Exception("wherekey was not defined")
 
                 select = (select and (str(wherekeyvalues[i]) ==
@@ -198 +200 @@
                 i = 0
                 for key in keynames:
-                    codes_set(gid, key, keyvalues[i])
+                    if key == 'values':
+                        codes_set_values(gid, keyvalues[i])
+                    else:
+                        codes_set(gid, key, keyvalues[i])
                     i += 1
 
-            codes_write(gid, fout)
+                codes_write(gid, fout)
 
             codes_release(gid)
@@ -210 +215 @@
         return
 
-    def copy(self, filename_in, selectWhere=True,
-             keynames=[], keyvalues=[], filemode='w'):
+    def copy_dummy_msg(self, filename_in, selectWhere=True,
+                 keynames=[], keyvalues=[], filemode='w'):
         '''Add the content of another input grib file to the objects file but
         only messages corresponding to keys/values passed to the function.
@@ -231 +236 @@
 
         keyvalues : :obj:`list` of :obj:`string`, optional
-            List of keynames. Default is an empty list.
+            List of keyvalues. Default is an empty list.
 
         filemode : :obj:`string`, optional
@@ -240 +245 @@
 
         '''
+        if len(keynames) != len(keyvalues):
+            raise Exception("Give a value for each keyname!")
 
         fin = open(filename_in)
         fout = open(self.filenames, filemode)
 
-        while 1:
-            gid = codes_new_from_file(fin)
+        fields = 0
+
+        while fields < 1:
+            gid = codes_grib_new_from_file(fin)
 
             if gid is None:
                 break
-
-            if len(keynames) != len(keyvalues):
-                raise Exception("Give a value for each keyname!")
 
             select = True
@@ -268 +274 @@
 
             if select:
+                fields = fields + 1
                 codes_write(gid, fout)