Changeset 1835 for inundation/pyvolution/util.py

Timestamp:

Sep 15, 2005, 5:32:31 PM (19 years ago)

Author:

ole

Message:

Implemented tms file format (like sww without x, y)
Fixed broken test in sww2ers

File:

• inundation/pyvolution/util.py (modified) (4 diffs)

inundation/pyvolution/util.py

@@ -137 +137 @@
                   quantities = None,
                   interpolation_points = None, verbose = False):
-    """If quantities is not specified, derive them from domain
-    (if that is specified)
-
-
-    see get_netcdf_file_function
-    """
-
+    """Read time history of spatial data from NetCDF file and return
+    a callable object.
+
+    If the file has extension 'sww' then it is assumed to be spatio-temporal
+    or temporal and the callable object will have the form f(t,x,y) or f(t)
+    depending on whether the file contains spatial data
+
+    If the file has extension 'tms' then it is assumed to be temporal only
+    and the callable object will have the form f(t)
+
+    Either form will return interpolated values based on the input file
+    using the underlying interpolation_function.
+
+    If domain is specified, model time (domain.starttime)
+    will be checked and possibly modified.
+    
+    All times are assumed to be in UTC
+
+    All spatial information is assumed to be in UTM coordinates.
+
+    See Interpolation function for further documentation
+    """
+    
 
     #FIXME (OLE): Should check origin of domain against that of file
@@ -230 +246 @@
     #are present in file 
     missing = []
-    for quantity in ['time'] + quantity_names:  #FIXME: Add x, y back
+    for quantity in ['time'] + quantity_names:
         if not fid.variables.has_key(quantity):
             missing.append(quantity)
@@ -241 +257 @@
 
     #Decide whether this data has a spatial dimension
-    #FIXME: Let us split this up into two functions: One that reads
-    #sww and one that reads tms (time series only)
-    #Definitely! (Ole 25 August 2005)
     spatial = True
     for quantity in ['x', 'y']:
@@ -249 +262 @@
             spatial = False
 
-
+    if filename[-3:] == 'tms' and spatial is True:
+        msg = 'Files of type tms must not contain spatial information'
+        raise msg
+
+    if filename[-3:] == 'sww' and spatial is False:
+        msg = 'Files of type sww must contain spatial information'        
+        raise msg        
 
     #Get first timestep