Changeset 1905


Ignore:
Timestamp:
Oct 13, 2005, 11:39:19 AM (18 years ago)
Author:
ole
Message:

Better docstring in file_function

File:
1 edited

Legend:

Unmodified
Added
Removed
  • inundation/pyvolution/util.py

    r1903 r1905  
    140140    a callable object.
    141141
    142     If the file has extension 'sww' then it is assumed to be spatio-temporal
    143     or temporal and the callable object will have the form f(t,x,y) or f(t)
    144     depending on whether the file contains spatial data
    145 
    146     If the file has extension 'tms' then it is assumed to be temporal only
    147     and the callable object will have the form f(t)
    148 
    149     Either form will return interpolated values based on the input file
    150     using the underlying interpolation_function.
    151 
    152     If domain is specified, model time (domain.starttime)
    153     will be checked and possibly modified.
    154    
    155     All times are assumed to be in UTC
    156 
    157     All spatial information is assumed to be in absolute UTM coordinates.
    158 
     142    Input variables:
     143   
     144    filename - Name of sww or tms file
     145       
     146       If the file has extension 'sww' then it is assumed to be spatio-temporal
     147       or temporal and the callable object will have the form f(t,x,y) or f(t)
     148       depending on whether the file contains spatial data
     149
     150       If the file has extension 'tms' then it is assumed to be temporal only
     151       and the callable object will have the form f(t)
     152
     153       Either form will return interpolated values based on the input file
     154       using the underlying interpolation_function.
     155
     156    domain - Associated domain object   
     157       If domain is specified, model time (domain.starttime)
     158       will be checked and possibly modified.
     159   
     160       All times are assumed to be in UTC
     161       
     162       All spatial information is assumed to be in absolute UTM coordinates.
     163
     164    quantities - the name of the quantity to be interpolated or a
     165                 list of quantity names. The resulting function will return
     166                 a tuple of values - one for each quantity 
     167
     168    interpolation_points - list of absolute UTM coordinates for points at
     169    which values are sought
     170   
     171
     172   
    159173    See Interpolation function for further documentation
    160174    """
Note: See TracChangeset for help on using the changeset viewer.