Context Navigation

← Previous Changeset
Next Changeset →

Changeset 8147

Timestamp:

Mar 11, 2011, 4:02:47 PM (14 years ago)

Author:

wilsonr

Message:

Removed '@brief' comments.

Location:

trunk/anuga_core/source/anuga

Files:

: 3 edited

abstract_2d_finite_volumes/util.py (modified) (15 diffs)
geospatial_data/geospatial_data.py (modified) (35 diffs)
utilities/test_numerical_tools.py (modified) (1 diff)

Legend:

: Unmodified
: Added
: Removed

trunk/anuga_core/source/anuga/abstract_2d_finite_volumes/util.py

-                      r8124
+                      r8147
                       boundary_polygon, output_centroids)
-##
-# @brief Replace multiple substrings in a string.
-# @param text The string to operate on.
-# @param dictionary A dict containing replacements, key->value.
-# @return The new string.
 def multiple_replace(text, dictionary):
     """Multiple replace of words in text
 …
-##
-# @brief Apply arbitrary expressions to the values of a dict.
-# @param expression A string expression to apply.
-# @param dictionary The dictionary to apply the expression to.
 def apply_expression_to_dictionary(expression, dictionary):
     """Apply arbitrary expression to values of dictionary
 …
-##
-# @brief Format a float into a string.
-# @param value Float value to format.
-# @param format The format to use (%.2f is default).
-# @return The formatted float as a string.
 def get_textual_float(value, format = '%.2f'):
     """Get textual representation of floating point numbers
 …
             return format % float(value)
-##
-# @brief Read gauge info from a file.
-# @param filename The name of the file to read.
-# @return A (gauges, gaugelocation, elev) tuple.
 def get_gauges_from_file(filename):
     return gauge_get_from_file(filename)
-##
-# @brief Check that input quantities in quantity list are legal.
-# @param quantity Quantity list to check.
-# @note Raises an exception of list is not legal.
 def check_list(quantity):
     """ Check that input quantities in quantity list are possible
 …
-##
-# @brief Calculate velocity bearing from North.
-# @param uh ??
-# @param vh ??
-# @return The calculated bearing.
 def calc_bearing(uh, vh):
     """ Calculate velocity bearing from North
 …
-##
-# @brief Create a nested sub-directory path.
-# @param root_directory The base diretory path.
-# @param directories An iterable of sub-directory names.
-# @return The final joined directory path.
-# @note If each sub-directory doesn't exist, it will be created.
 def add_directories(root_directory, directories):
     """
 …
-##
-# @brief
-# @param verbose
-# @param kwargs
-# @return
-# @note TEMP
 def store_parameters(verbose=False,**kwargs):
     """Temporary Interface to new location"""
 …
-##
-# @brief Remove vertices that are not associated with any triangle.
-# @param verts An iterable (or array) of points.
-# @param triangles An iterable of 3 element tuples.
-# @param number_of_full_nodes ??
-# @return (verts, triangles) where 'verts' has been updated.
 def remove_lone_verts(verts, triangles, number_of_full_nodes=None):
     """Removes vertices that are not associated with any triangles.
 …
-##
-# @brief Compute centroid values from vertex values
-# @param x Values at vertices of triangular mesh.
-# @param triangles Nx3 integer array pointing to vertex information.
-# @return [N] array of centroid values.
 def get_centroid_values(x, triangles):
     """Compute centroid values from vertex values
 …
-##
-# @brief Plot time series from CSV files.
-# @param directories_dic
-# @param output_dir
-# @param base_name
-# @param plot_numbers
-# @param quantities
-# @param extra_plot_name
-# @param assess_all_csv_files
-# @param create_latex
-# @param verbose
-# @note Assumes that 'elevation' is in the CSV file(s).
 def csv2timeseries_graphs(directories_dic={},
                           output_dir='',
 …
     if verbose: log.critical('Finished closing plots')
-##
-# @brief Return min and max of an iterable.
-# @param list The iterable to return min & max of.
-# @return (min, max) of 'list'.
 def get_min_max_values(list=None):
     """
 …
-##
-# @brief Get runup around a point in a CSV file.
-# @param gauge_filename gauge file name.
-# @param sww_filename SWW file name.
-# @param runup_filename Name of file to report into.
-# @param size ??
-# @param verbose ??
 def get_runup_data_for_locations_from_file(gauge_filename,
                                            sww_filename,
 …
         file.close()
-##
-# @brief ??
-# @param  ??
-# @param gauge_file ??
-# @param out_name ??
-# @param quantities ??
-# @param verbose ??
-# @param use_cache ??
 def sww2csv_gauges(sww_file,
                    gauge_file,
 …
                    output_centroids)
-##
-# @brief Get a wave height at a certain depth given wave height at another depth.
-# @param d1 The first depth.
-# @param d2 The second depth.
-# @param h1 Wave ampitude at d1
-# @param verbose True if this function is to be verbose.
-# @return The wave height at d2.
 def greens_law(d1, d2, h1, verbose=False):
     """Green's Law
 …
-##
-# @brief Get the square-root of a value.
-# @param s The value to get the square-root of.
-# @return The square-root of 's'.
 def square_root(s):
     return sqrt(s)

trunk/anuga_core/source/anuga/geospatial_data/geospatial_data.py

-                      r8124
+                      r8147
-##
-# @brief ??
 class Geospatial_data:
-    ##
-    # @brief
-    # @param data_points Mx2 iterable of tuples or array of x,y coordinates.
-    # @param attributes Associated values for each data point.
-    # @param geo_reference ??
-    # @param default_attribute_name ??
-    # @param file_name
-    # @param latitudes ??
-    # @param longitudes ??
-    # @param points_are_lats_longs True if points are lat/long, not UTM.
-    # @param max_read_lines Size of block to read, if blocking.
-    # @param load_file_now True if blocking but we eant to read file now.
-    # @param verbose True if this class instance is verbose.
     def __init__(self,
                  data_points=None, # this can also be a points file name
 …
                         # print 'data as a pts NetCDF format'
-    ##
-    # @brief Return length of the points set.
     def __len__(self):
         return len(self.data_points)
-    ##
-    # @brief Return a string representation of the points set.
     def __repr__(self):
         return str(self.get_data_points(absolute=True))
-    ##
-    # @brief Check data points.
-    # @param data_points Points data to check and store in instance.
-    # @note Throws ValueError exception if no data.
     def check_data_points(self, data_points):
         """Checks data points"""
 …
                 assert self.data_points.shape[1] == 2
-    ##
-    # @brief Check and assign attributes data.
-    # @param attributes Dictionary or scalar to save as .attributes.
-    # @note Throws exception if unable to convert dict keys to numeric.
     def set_attributes(self, attributes):
         """Check and assign attributes dictionary"""
 …
         self.attributes = attributes
-    ##
-    # @brief Set the georeference of geospatial data.
-    # @param geo_reference The georeference data to set.
-    # @note Will raise exception if param not instance of Geo_reference.
     def set_geo_reference(self, geo_reference):
         """Set the georeference of geospatial data.
 …
         self.geo_reference = geo_reference
-    ##
-    # @brief Set default attribute name.
-    # @param default_attribute_name The default to save.
     def set_default_attribute_name(self, default_attribute_name):
         self.default_attribute_name = default_attribute_name
-    ##
-    # @brief Set the instance verbose flag.
-    # @param verbose The value to save.
-    # @note Will raise exception if param is not True or False.
     def set_verbose(self, verbose=False):
         if verbose in [False, True]:
 …
             raise Exception(msg)
-    ##
-    # @brief Clip geospatial data by a given polygon.
-    # @param polygon The polygon to clip with.
-    # @param closed True if points on clip boundary are not included in result.
-    # @param verbose True if this function is verbose.
     def clip(self, polygon, closed=True, verbose=False):
         """Clip geospatial data by a polygon
 …
         return clipped_G
-    ##
-    # @brief Clip points data by polygon, return points outside polygon.
-    # @param polygon The polygon to clip with.
-    # @param closed True if points on clip boundary are not included in result.
-    # @param verbose True if this function is verbose.
     def clip_outside(self, polygon, closed=True, verbose=False):
         """Clip geospatial date by a polygon, keeping data OUTSIDE of polygon
 …
         return clipped_G
-    ##
-    # @brief Get instance geo_reference data.
     def get_geo_reference(self):
         return self.geo_reference
-    ##
-    # @brief Get coordinates for all data points as an Nx2 array.
-    # @param absolute If True, return UTM, else relative to xll/yll corners.
-    # @param geo_reference If supplied, points are relative to it.
-    # @param as_lat_long If True, return points as lat/lon.
-    # @param isSouthHemisphere If True, return lat/lon points in S.Hemi.
-    # @return A set of data points, in appropriate form.
     def get_data_points(self,
                         absolute=True,
 …
             return self.data_points
-    ##
-    # @brief Get value for attribute name.
-    # @param attribute_name Name to get value for.
-    # @note If name passed is None, return default attribute value.
     def get_attributes(self, attribute_name=None):
         """Return values for one named attribute.
 …
         return self.attributes[attribute_name]
-    ##
-    # @brief Get all instance attributes.
-    # @return The instance attribute dictionary, or None if no attributes.
     def get_all_attributes(self):
         """Return values for all attributes.
 …
         return self.attributes
-    ##
-    # @brief Override __add__() to allow addition of geospatial objects.
-    # @param self This object.
-    # @param other The second object.
-    # @return The new geospatial object.
     def __add__(self, other):
         """Returns the addition of 2 geospatial objects,
 …
         return Geospatial_data(new_points, new_attributes, new_geo_ref)
-    ##
-    # @brief Override the addition case where LHS isn't geospatial object.
-    # @param self This object.
-    # @param other The second object.
-    # @return The new geospatial object.
     def __radd__(self, other):
         """Handle cases like None + Geospatial_data(...)"""
 …
 ################################################################################
-    ##
-    # @brief Import a .txt, .csv or .pts points data file.
-    # @param file_name
-    # @param delimiter
-    # @param verbose True if this function is to be verbose.
-    # @note Will throw IOError or SyntaxError if there is a problem.
     def import_points_file(self, file_name, delimiter=None, verbose=False):
         """ load an .txt, .csv or .pts file
 …
         self.geo_reference = geo_reference
-    ##
-    # @brief Write points data to a file (.csv or .pts).
-    # @param file_name Path to file to write.
-    # @param absolute ??
-    # @param as_lat_long ??
-    # @param isSouthHemisphere ??
     def export_points_file(self, file_name, absolute=True,
                            as_lat_long=False, isSouthHemisphere=True):
 …
             raise IOError(msg)
-    ##
-    # @brief Get a subset of data that is referred to by 'indices'.
-    # @param indices A list of indices to select data subset with.
-    # @return A geospatial object containing data subset.
     def get_sample(self, indices):
         """ Returns a object which is a subset of the original
 …
         return Geospatial_data(sampled_points, sampled_attributes)
-    ##
-    # @brief Split one geospatial object into two.
-    # @param factor Relative size to make first result object.
-    # @param seed_num Random 'seed' - used only for unit test.
-    # @param verbose True if this function is to be verbose.
-    # @note Points in each result object are selected randomly.
     def split(self, factor=0.5, seed_num=None, verbose=False):
         """Returns two geospatial_data object, first is the size of the 'factor'
 …
         return G1, G2
-    ##
-    # @brief Allow iteration over this object.
     def __iter__(self):
         """Read in the header, number_of_points and save the
 …
         return self
-    ##
-    # @brief Read another block into the instance.
     def next(self):
         """read a block, instanciate a new geospatial and return it"""
 …
                  'The attribute values must be numeric.\n')
-##
-# @brief ??
-# @param latitudes ??
-# @param longitudes ??
-# @param geo_reference ??
-# @param data_points ??
-# @param points_are_lats_longs ??
-# @note IS THIS USED???
 def _set_using_lat_long(latitudes,
                         longitudes,
 …
-##
-# @brief Read a .pts data file.
-# @param file_name Path to file to read.
-# @param verbose True if this function is to be verbose.
-# @return (pointlist, attributes, geo_reference)
 def _read_pts_file(file_name, verbose=False):
     """Read .pts NetCDF file
 …
-##
-# @brief Read a .csv data file.
-# @param file_name Path to the .csv file to read.
-# @param verbose True if this function is to be verbose.
 def _read_csv_file(file_name, verbose=False):
     """Read .csv file
 …
-##
-# @brief Read a .csv file header.
-# @param file_pointer Open descriptor of the file to read.
-# @param delimiter Header line delimiter string, split on this string.
-# @param verbose True if this function is to be verbose.
-# @return A tuple of (<cleaned header string>, <input file_pointer>)
 CSV_DELIMITER = ','
 …
     return header, file_pointer
-##
-# @brief Read a .csv file, with blocking.
-# @param file_pointer Open descriptor of the file to read.
-# @param header List of already read .csv header fields.
-# @param delimiter Delimiter string header was split on.
-# @param max_read_lines The max number of lines to read before blocking.
-# @param verbose True if this function is to be verbose.
-# @note Will throw IndexError, SyntaxError exceptions.
 def _read_csv_file_blocking(file_pointer,
                             header,
 …
-##
-# @brief Read a .pts file header.
-# @param fid Handle to the open .pts file.
-# @param verbose True if the function is to be verbose.
-# @return (geo_reference, keys, fid.dimensions['number_of_points'])
-# @note Will throw IOError and AttributeError exceptions.
 def _read_pts_file_header(fid, verbose=False):
     '''Read the geo_reference and number_of_points from a .pts file'''
 …
-##
-# @brief Read the body of a .pts file, with blocking.
-# @param fid Handle to already open file.
-# @param start_row Start row index of points to return.
-# @param fin_row End row index of points to return.
-# @param keys Iterable of keys to return.
-# @return Tuple of (pointlist, attributes).
 def _read_pts_file_blocking(fid, start_row, fin_row, keys):
     '''Read the body of a .pts file.'''
 …
-##
-# @brief Write a .pts data file.
-# @param file_name Path to the file to write.
-# @param write_data_points Data points to write.
-# @param write_attributes Attributes to write.
-# @param write_geo_reference Georef to write.
 def _write_pts_file(file_name,
                     write_data_points,
 …
-##
-# @brief Write a .csv data file.
-# @param file_name Path to the file to write.
-# @param write_data_points Data points to write.
-# @param write_attributes Attributes to write.
-# @param as_lat_long True if points are lat/lon, else x/y.
-# @param delimiter The CSV delimiter to use.
 def _write_csv_file(file_name,
                     write_data_points,
 …
-##
-# @brief Write a URS file.
-# @param file_name The path of the file to write.
-# @param points
-# @param delimiter
 def _write_urs_file(file_name, points, delimiter=' '):
     """Write a URS format file.
 …
-##
-# @brief ??
-# @param point_atts ??
-# @return ??
 def _point_atts2array(point_atts):
     point_atts['pointlist'] = num.array(point_atts['pointlist'], num.float)
 …
-##
-# @brief Convert geospatial object to a points dictionary.
-# @param geospatial_data The geospatial object to convert.
-# @return A points dictionary.
 def geospatial_data2points_dictionary(geospatial_data):
     """Convert geospatial data to points_dictionary"""
 …
-##
-# @brief Convert a points dictionary to a geospatial object.
-# @param points_dictionary A points dictionary to convert.
 def points_dictionary2geospatial_data(points_dictionary):
     """Convert points_dictionary to geospatial data object"""
 …
-##
-# @brief Ensure that points are in absolute coordinates.
-# @param points A list or array of points to check, or geospatial object.
-# @param geo_reference If supplied,
-# @return ??
 def ensure_absolute(points, geo_reference=None):
     """Ensure that points are in absolute coordinates.
 …
-##
-# @brief
-# @param points
-# @param geo_reference
-# @return A geospatial object.
 def ensure_geospatial(points, geo_reference=None):
     """Convert various data formats to a geospatial_data instance.
 …
-##
-# @brief
-# @param data_file
-# @param alpha_list
-# @param mesh_file
-# @param boundary_poly
-# @param mesh_resolution
-# @param north_boundary
-# @param south_boundary
-# @param east_boundary
-# @param west_boundary
-# @param plot_name
-# @param split_factor
-# @param seed_num
-# @param cache
-# @param verbose
 def find_optimal_smoothing_parameter(data_file,
                                      alpha_list=None,
 …
-##
-# @brief
-# @param data_file
-# @param alpha_list
-# @param mesh_file
-# @param boundary_poly
-# @param mesh_resolution
-# @param north_boundary
-# @param south_boundary
-# @param east_boundary
-# @param west_boundary
-# @param plot_name
-# @param split_factor
-# @param seed_num
-# @param cache
-# @param verbose
 def old_find_optimal_smoothing_parameter(data_file,
                                          alpha_list=None,

trunk/anuga_core/source/anuga/utilities/test_numerical_tools.py

-                      r8124
+                      r8147
 #        t(num.array('abc', num.float), False)
-    ##
-    # @brief Test to see if ensure_numeric() behaves as we expect.
-    # @note Under Numeric ensure_numeric() *always* returned a copy (bug).
-    #       Under numpy it copies only when it has to.
     def test_ensure_numeric_copy(self):
+        """Test to see if ensure_numeric() behaves as we expect.
+        Under Numeric ensure_numeric() *always* returned a copy (bug).
+        Under numpy it copies only when it has to.
+        """
         #####
         # Make 'points' a _list_ of coordinates.

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

Download in other formats: