Changeset 8143


Ignore:
Timestamp:
Mar 10, 2011, 9:10:48 PM (13 years ago)
Author:
wilsonr
Message:

Removed '@brief' comments.

Location:
trunk/anuga_core/source/anuga/file
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/anuga_core/source/anuga/file/csv_file.py

    r8125 r8143  
    140140
    141141
    142 ##
    143 # @brief Store keyword params into a CSV file.
    144 # @param verbose True if this function is to be verbose.
    145 # @param kwargs Dictionary of keyword args to store.
    146 # @note If kwargs dict contains 'file_name' key, that has the output filename.
    147 #       If not, make up a filename in the output directory.
    148142def store_parameters(verbose=False, **kwargs):
    149143    """
  • trunk/anuga_core/source/anuga/file/sts.py

    r7859 r8143  
    1717    EXTREMA = ':extrema'
    1818
    19     ##
    20     # @brief Instantiate this STS writer class.
    2119    def __init__(self):
    2220        pass
    2321
    24     ##
    25     # @brief Write a header to the underlying data file.
    26     # @param outfile Handle to open file to write.
    27     # @param times A list of the time slice times *or* a start time.
    28     # @param number_of_points The number of URS gauge sites.
    29     # @param description Description string to write into the STS file.
    30     # @param sts_precision Format of data to write (netcdf constant ONLY).
    31     # @param verbose True if this function is to be verbose.
    32     # @note If 'times' is a list, the info will be made relative.
    3322    def store_header(self,
    3423                     outfile,
     
    3827                     sts_precision=netcdf_float32,
    3928                     verbose=False):
    40         """
    41         outfile - the name of the file that will be written
    42         times - A list of the time slice times OR a start time
    43         Note, if a list is given the info will be made relative.
    44         number_of_points - the number of urs gauges sites
     29        """Write a header to the underlying data file.
     30
     31        outfile          handle to open file to write
     32        times            list of the time slice times *or* a start time
     33        number_of_points the number of URS gauge sites
     34        description      description string to write into the STS file
     35        sts_precision    format of data to write (netcdf constant ONLY)
     36        verbose          True if this function is to be verbose
     37
     38        If 'times' is a list, the info will be made relative.
    4539        """
    4640
     
    9690        self.write_dynamic_quantities(outfile, Write_sts.sts_quantities, times)
    9791
    98     ##
    99     # @brief
    100     # @param outfile
    101     # @param points_utm
    102     # @param elevation
    103     # @param zone
    104     # @param new_origin
    105     # @param points_georeference
    106     # @param verbose True if this function is to be verbose.
    10792    def store_points(self,
    10893                     outfile,
     
    188173        outfile.variables[q + Write_sts.RANGE][1] = max(elevation)
    189174
    190     ##
    191     # @brief Store quantity data in the underlying file.
    192     # @param outfile
    193     # @param sts_precision
    194     # @param slice_index
    195     # @param time
    196     # @param verboseTrue if this function is to be verbose.
    197     # @param **quant Extra keyword args.
    198175    def store_quantities(self, outfile, sts_precision=num.float32,
    199176                         slice_index=None, time=None,
     
    275252
    276253
    277 ##
    278 # @brief Create a list of points defining a boundary from an STS file.
    279 # @param stsname Stem of path to the STS file to read.
    280 # @return A list of boundary points.
    281254def create_sts_boundary(sts_filename):
    282255    """Create a list of points defining a boundary from an STS file.
  • trunk/anuga_core/source/anuga/file/urs.py

    r8124 r8143  
    2222    """
    2323
    24     ##
    25     # @brief Initialize this instance of Urs_points.
    26     # @param urs_file Path to the underlying data file.
    2724    def __init__(self, urs_file):
    2825        self.iterated = False
     
    5956        # check this array
    6057
    61     ##
    62     # @brief Allow iteration over quantity data wrt time.
    6358    def __iter__(self):
    6459        """
     
    7873        return self
    7974
    80     ##
    81     # @brief
    8275    def next(self):
    8376        if self.time_step_count == self.iter_time_step:
     
    9386        return hz_p
    9487
    95     ##
    96     # @brief Close the mux file.
    9788    def close(self):
    9889        self.mux_file.close()
     
    110101#LONG_AMOUNT = 3600
    111102
    112 
    113 ##
    114 # @brief
    115 # @param file_name
    116 # @param boundary_polygon
    117 # @param zone
    118 # @param ll_lat
    119 # @param ll_long
    120 # @param grid_spacing
    121 # @param lat_amount
    122 # @param long_amount
    123 # @param isSouthernHemisphere
    124 # @param export_csv
    125 # @param use_cache
    126 # @param verbose True if this function is to be verbose.
    127 # @return
    128103
    129104def save_boundary_as_urs(file_name, boundary_polygon, zone,
     
    181156
    182157
    183 ##
    184 # @brief
    185 # @param boundary_polygon
    186 # @param zone
    187 # @param ll_lat
    188 # @param ll_long
    189 # @param grid_spacing
    190 # @param lat_amount
    191 # @param long_amount
    192 # @param isSouthHemisphere
    193 # @param use_cache
    194 # @param verbose
    195158def calculate_boundary_points(boundary_polygon, zone, ll_lat,
    196159                      ll_long, grid_spacing,
     
    221184
    222185
    223 ##
    224 # @brief
    225 # @param boundary_polygon An iterable of points that describe a polygon.
    226 # @param zone
    227 # @param ll_lat Lower left latitude, in decimal degrees
    228 # @param ll_long Lower left longitude, in decimal degrees
    229 # @param grid_spacing Grid spacing in decimal degrees.
    230 # @param lat_amount
    231 # @param long_amount
    232 # @param isSouthHemisphere
    233186def _calculate_boundary_points(boundary_polygon,
    234187                       zone, ll_lat,
     
    277230
    278231
    279 ##
    280 # @brief Get the points that are needed to interpolate any point a a segment.
    281 # @param seg Two points in the UTM.
    282 # @param ll_lat Lower left latitude, in decimal degrees
    283 # @param ll_long Lower left longitude, in decimal degrees
    284 # @param grid_spacing
    285 # @param lat_amount
    286 # @param long_amount
    287 # @param zone
    288 # @param isSouthHemisphere
    289 # @return A list of points.
    290232def points_needed(seg, ll_lat, ll_long, grid_spacing,
    291233                  lat_amount, long_amount, zone,
     
    346288
    347289
    348 ##
    349 # @brief
    350 # @param lat
    351 # @param long
    352 # @param seg Two points in UTM.
    353 # @param max_distance
    354290def keep_point(lat, long, seg, max_distance):
    355291    """
Note: See TracChangeset for help on using the changeset viewer.