Changeset 5144


Ignore:
Timestamp:
Mar 10, 2008, 11:53:33 AM (16 years ago)
Author:
nick
Message:

add information about 'find_optimal_smoothing_parameter' to the user_manual/anuga_user_manual.tex. Closing trac ticket 216

File:
1 edited

Legend:

Unmodified
Added
Removed
  • anuga_core/documentation/user_manual/anuga_user_manual.tex

    r5143 r5144  
    36923692new object are disjoin set of each other.
    36933693       
    3694 Points of the two new object have selected RANDOMLY.
     3694Points of the two new geospatial_data object are selected RANDOMLY.
    36953695       
    3696 Input - the factor which to split the object, if 0.1 then 10% of the
     3696Input - the (\code{factor}) which to split the object, if 0.1 then 10% of the
    36973697together object will be returned
    36983698       
     
    37033703north_boundary=None, south_boundary=None, east_boundary=None, west_boundary=None, plot_name='all_alphas', split_factor=0.1, seed_num=None, cache=False, verbose=False}
    37043704
    3705 Returns two geospatial_data object, first is the size of the 'factor'
    3706 smaller the original and the second is the remainder. The two
    3707 new object are disjoin set of each other.
    3708        
    3709 Points of the two new object have selected RANDOMLY.
    3710        
    3711 Input - the factor which to split the object, if 0.1 then 10% of the
    3712 together object will be returned
    3713        
    3714 Output - two geospatial_data objects that are disjoint sets of the original
     3705Removes a small random sample of points from 'data_file'. Creates
     3706models from resulting points in 'data_file' with different alpha values from 'alpha_list' and cross validates
     3707the predicted value to the previously removed point data. Returns the
     3708alpha value which has the smallest covariance.
     3709
     3710data_file: must not contain points outside the boundaries defined
     3711and it either a pts, txt or csv file.
     3712   
     3713alpha_list: the alpha values to test in a single list
     3714   
     3715mesh_file: name of the created mesh file or if passed in will read it.
     3716NOTE, if there is a mesh file mesh_resolution, north_boundary, south... etc will be ignored.
     3717   
     3718mesh_resolution: the maximum area size for a triangle
     3719   
     3720north_boundary... west_boundary: the value of the boundary
     3721   
     3722plot_name: the name for the plot contain the results
     3723   
     3724seed_num: the seed to the random number generator
     3725   
     3726USAGE:
     3727convariance_value, alpha = find_optimal_smoothing_parameter(data_file=fileName,
     3728                                             alpha_list=[0.0001, 0.01, 1],
     3729                                             mesh_file=None,
     3730                                             mesh_resolution=3,
     3731                                             north_boundary=5,
     3732                                             south_boundary=-5,
     3733                                             east_boundary=5,
     3734                                             west_boundary=-5,
     3735                                             plot_name='all_alphas',
     3736                                             seed_num=100000,
     3737                                             verbose=False)
     3738   
     3739OUTPUT: returns the minumum normalised covalance calculate AND the
     3740alpha that created it. PLUS writes a plot of the results
     3741           
     3742NOTE: code will not work if the data_file extent is greater than the
     3743boundary_polygon or any of the boundaries, eg north_boundary...west_boundary
    37153744\end{methoddesc}
    37163745
Note: See TracChangeset for help on using the changeset viewer.