Context Navigation

file_conversion

Timestamp:

Mar 11, 2011, 7:23:24 PM (14 years ago)

Author:

wilsonr

Message:

Removed '@brief' comments.

Location:

trunk/anuga_core/source/anuga/file_conversion

Files:

-                      r7814
+                      r8150
-##
-# @brief Convert an ASC file to a DEM file.
-# @param basename_in Stem of input filename.
-# @param basename_out Stem of output filename.
-# @param verbose True if this function is to be verbose.
 def _convert_dem_from_ascii2netcdf(name_in, name_out = None,
                                    verbose = False):

-                      r7841
+                      r8150
-##
-# @brief
-# @param basename_in
-# @param basename_out
-# @param verbose
-# @param easting_min
-# @param easting_max
-# @param northing_min
-# @param northing_max
 def _dem2pts(name_in, name_out=None, verbose=False,
             easting_min=None, easting_max=None,

-                      r7866
+                      r8150
         write_obj(FN, xx, yy, zz)
-##
-# @brief Convert time-series text file to TMS file.
-# @param filename
-# @param quantity_names
-# @param time_as_seconds
 def timefile2netcdf(file_text, file_out = None, quantity_names=None, \
                                 time_as_seconds=False):
 …
-##
-# @brief
-# @param filename
-# @param verbose
 def tsh2sww(filename, verbose=False):
     """
 …
-##
-# @brief Return max&min indexes (for slicing) of area specified.
-# @param latitudes_ref ??
-# @param longitudes_ref ??
-# @param minlat Minimum latitude of specified area.
-# @param maxlat Maximum latitude of specified area.
-# @param minlon Minimum longitude of specified area.
-# @param maxlon Maximum longitude of specified area.
-# @return Tuple (lat_min_index, lat_max_index, lon_min_index, lon_max_index)
 def get_min_max_indices(latitudes_ref, longitudes_ref,
                          minlat=None, maxlat=None,
 …
-##
-# @brief
-# @param filename
-# @param x
-# @param y
-# @param z
 def write_obj(filename, x, y, z):
     """Store x,y,z vectors into filename (obj format).

-                      r7814
+                      r8150
 from anuga.geospatial_data.geospatial_data import Geospatial_data
-##
-# @brief  Return block of surface lines for each cross section
-# @param lines Iterble  of text lines to process.
-# @note BROKEN?  UNUSED?
 def _read_hecras_cross_sections(lines):
     """Return block of surface lines for each cross section
 …
     """Read HEC-RAS Elevation datal from the following ASCII format (.sdf)
+# @brief Convert HECRAS (.sdf) file to PTS file.
+# @param basename_in Sterm of input filename.
+# @param basename_out Sterm of output filename.
+# @param verbose True if this function is to be verbose.
+    basename_in Sterm of input filename.
+    basename_out Sterm of output filename.
+    verbose True if this function is to be verbose.
     Example:

-                      r7800
+                      r8150
-##
-# @brief Convert a quantity URS file to a NetCDF file.
-# @param file_in Path to input URS file.
-# @param file_out Path to the output file.
-# @param quantity Name of the quantity to be written to the output file.
-# @return A tuple (lonlatdep, lon, lat, depth).
 def _binary_c2nc(file_in, file_out, quantity):
     """Reads in a quantity urs file and writes a quantity nc file.
 …
-##
-# @brief
-# @param long_lat_dep
-# @return A tuple (long, lat, quantity).
-# @note The latitude is the fastest varying dimension - in mux files.
 def lon_lat2grid(long_lat_dep):
     """

Note: See TracChangeset for help on using the changeset viewer.