Changeset 3710

Timestamp:

Oct 9, 2006, 3:26:13 PM (17 years ago)

Author:

ole

Message:

Documentation of geospatial_data.clip()

File:

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

anuga_core/documentation/user_manual/anuga_user_manual.tex

@@ -2550 +2550 @@
 
 
+\begin{methoddesc}{clip}{}
+Clip geospatial data by a polygon
+
+Inputs are \code{polygon} which is either a list of points, an Nx2 array or
+a Geospatial data object and \code{closed}(optional) which determines 
+whether points on boundary should be regarded as belonging to the polygon 
+(\code{closed=True}) or not (\code{closed=False}). 
+Default is \code{closed=True}.
+          
+Returns new Geospatial data object representing points 
+inside specified polygon.
+\end{methoddesc}
+
+
 \section{pmesh GUI}
  \emph{Pmesh}