Changeset 5484 for anuga_core

Timestamp:

Jul 10, 2008, 11:57:22 AM (17 years ago)

Author:

sexton

Message:

update plot_polygons in user manual

File:

• anuga_core/documentation/user_manual/anuga_user_manual.tex (modified) (1 diff)

anuga_core/documentation/user_manual/anuga_user_manual.tex

@@ -3598 +3598 @@
   \end{funcdesc}
 
-  \begin{funcdesc}{plot\_polygons}{polygons, figname, verbose = False}
-  Module: \code{utilities.polygon}
-
-  Plots each polygon contained in input polygon list, e.g.
- \code{polygons = [poly1, poly2, poly3]} where \code{poly1 = [[x11,y11],[x12,y12],[x13,y13]]}
- etc.  Each polygon is closed for plotting purposes and subsequent plot saved to \code{figname}.
-  Returns list containing the minimum and maximum of \code{x} and \code{y},
-  i.e. \code{[x_{min}, x_{max}, y_{min}, y_{max}]}.
+  \begin{funcdesc}{plot\_polygons}{polygons, style, figname, verbose = False}
+    Module: \code{utilities.polygon}
+  
+    Plots each polygon contained in input polygon list, e.g.
+   \code{polygons = [poly1, poly2, poly3]} where \code{poly1 = [[x11,y11],[x12,y12],[x13,y13]]}
+   etc.  Each polygon can be closed for plotting purposes by assigning the style type to each
+   polygon in the list, e.g. \code{style = ['line','line','line']}. The default will be a line
+   type when \code{style = None}.
+   The subsequent plot will be saved to \code{figname} or defaulted to \code{test_image.png}.
+    The function returns a list containing the minimum and maximum of \code{x} and \code{y},
+    i.e. \code{[x_{min}, x_{max}, y_{min}, y_{max}]}.
   \end{funcdesc}