Changeset 5143

Timestamp:

Mar 8, 2008, 11:54:28 AM (16 years ago)

Author:

nick

Message:

add split and find_optimal_smoothing_parameter to user_manual/anuga_user_manual.tex

File:

• anuga_core/documentation/user_manual/anuga_user_manual.tex (modified) (2 diffs)

anuga_core/documentation/user_manual/anuga_user_manual.tex

@@ -3687 +3687 @@
 \end{methoddesc}
 
+\begin{methoddesc}{split}{factor=0.5, seed_num=None, verbose=False}
+Returns two geospatial_data object, first is the size of the 'factor'
+smaller the original and the second is the remainder. The two
+new object are disjoin set of each other.
+        
+Points of the two new object have selected RANDOMLY. 
+        
+Input - the factor which to split the object, if 0.1 then 10% of the
+together object will be returned
+        
+Output - two geospatial_data objects that are disjoint sets of the original
+\end{methoddesc}
+
+\begin{methoddesc}{find_optimal_smoothing_parameter}{data_file, alpha_list=None, mesh_file=None, boundary_poly=None, mesh_resolution=100000,
+north_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}
+
+Returns two geospatial_data object, first is the size of the 'factor'
+smaller the original and the second is the remainder. The two
+new object are disjoin set of each other.
+        
+Points of the two new object have selected RANDOMLY. 
+        
+Input - the factor which to split the object, if 0.1 then 10% of the
+together object will be returned
+        
+Output - two geospatial_data objects that are disjoint sets of the original
+\end{methoddesc}
+
+
 
 \section{Graphical Mesh Generator GUI}
@@ -3832 +3861 @@
 or is constant, one bin will be created. If \code{number\_of\_bins}
 is omitted, 10 bins will be created.\\  \hline
+
+\section{Finding the Optimal Alpha Value}
+
+The function ????
+more to come very soon
 
 \end{tabular}