Changeset 5484


Ignore:
Timestamp:
Jul 10, 2008, 11:57:22 AM (11 years ago)
Author:
sexton
Message:

update plot_polygons in user manual

File:
1 edited

Legend:

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

    r5475 r5484  
    35983598  \end{funcdesc}
    35993599
    3600   \begin{funcdesc}{plot\_polygons}{polygons, figname, verbose = False}
    3601   Module: \code{utilities.polygon}
    3602 
    3603   Plots each polygon contained in input polygon list, e.g.
    3604  \code{polygons = [poly1, poly2, poly3]} where \code{poly1 = [[x11,y11],[x12,y12],[x13,y13]]}
    3605  etc.  Each polygon is closed for plotting purposes and subsequent plot saved to \code{figname}.
    3606   Returns list containing the minimum and maximum of \code{x} and \code{y},
    3607   i.e. \code{[x_{min}, x_{max}, y_{min}, y_{max}]}.
     3600  \begin{funcdesc}{plot\_polygons}{polygons, style, figname, verbose = False}
     3601    Module: \code{utilities.polygon}
     3602 
     3603    Plots each polygon contained in input polygon list, e.g.
     3604   \code{polygons = [poly1, poly2, poly3]} where \code{poly1 = [[x11,y11],[x12,y12],[x13,y13]]}
     3605   etc.  Each polygon can be closed for plotting purposes by assigning the style type to each
     3606   polygon in the list, e.g. \code{style = ['line','line','line']}. The default will be a line
     3607   type when \code{style = None}.
     3608   The subsequent plot will be saved to \code{figname} or defaulted to \code{test_image.png}.
     3609    The function returns a list containing the minimum and maximum of \code{x} and \code{y},
     3610    i.e. \code{[x_{min}, x_{max}, y_{min}, y_{max}]}.
    36083611  \end{funcdesc}
    36093612
Note: See TracChangeset for help on using the changeset viewer.