NCCOOS Trac Projects: Top | Web | Platforms | Processing | Viz | Sprints | Sandbox | (Wind)

root/gliderproc/trunk/MATLAB/opnml/html/3.FEM/lcontour.html

Revision 495 (checked in by cbc, 11 years ago)

Initial import of Stark code.

Line 
1 <TITLE>/</TITLE>
2 <BODY>
3 <A HREF = "index.html">[Index for ./FEM]</A>
4 <A HREF = "../index.html">[Return to Master Index]</A>
5 <H1>lcontour</H1>
6 <H2>(./FEM/lcontour.m)</H2>
7 <HR><H3>Function Synopsis</H3>
8 <pre>chandle=lcontour(fem_grid_struct,Q,cval,p1,v1,p2,v2,p3,v3,p4,v4,...</pre>
9 <HR><H3>Help text</H3>
10 <pre>
11 LCONTOUR contour a scalar on a FEM grid.
12    LCONTOUR contours a scalar field on the input FEM grid.
13    LCONTOUR accepts a vector of values to be contoured
14    over the provided mesh. 
15
16    INPUT : <A HREF = "../3.FEM/fem_grid_struct.html">fem_grid_struct</A> (from <A HREF = "../3.FEM/loadgrid.html">LOADGRID</A>, see <A HREF = "../3.FEM/fem_grid_struct.html">FEM_GRID_STRUCT</A>)
17            Q    - scalar to be contoured upon; must be a 1-D vector
18                   or the single character 'z', IN SINGLE QUOTES!!
19            cval - vector of values to contour
20
21            In order to contour the FEM domain bathymetry, pass
22            in the string 'z' in place of an actual scalar field Q.
23            You could, of course, pass in the actual bathymetry as
24            the scalar to contour.  Otherwise, Q must be a 1-D vector
25            with length equal to the number of nodes in the FEM mesh.
26
27            The parameter/value pairs currently allowed in the LCONTOUR 
28            function are as follows (default values appear in {}) :
29
30                 Color       {'r' = red}
31                 LineStyle   {'-' = solid}
32                 LineWidth   {0.5 points; 1 point = 1/72 inches}
33                 MarkerSize  {6 points}
34
35            See the Matlab Reference Guide entry on the LINE command for
36            a complete description of parameter/value pair specification.
37
38            The idea and some of the constructs used in pv decoding
39            in this routine come from an unreleased MathWorks function
40            called polar2.m written by John L. Galenski III 
41            and provided by Jeff Faneuff.
42
43   OUTPUT :  h - the handle to the contour line(s) drawn
44
45     CALL : &gt;&gt; h=lcontour(<A HREF = "../3.FEM/fem_grid_struct.html">fem_grid_struct</A>,Q,cval,p1,v1,p2,v2,...)
46      or
47            &gt;&gt; h=lcontour(<A HREF = "../3.FEM/fem_grid_struct.html">fem_grid_struct</A>,'z',cval,p1,v1,p2,v2,...)
48
49  Written by : Brian O. Blanton
50  
51 </pre>
52 <HR><H3>Cross-Reference Information</H3>This function calls
53 <pre><UL>
54 <LI><A HREF = "../3.FEM/is_valid_struct.html">is_valid_struct</A>./FEM/is_valid_struct.m</LI>
55 </UL></pre>
56 <HR>
57 Produced by <A HREF="http://www.nd.edu/Courses/kantor/matlab/mat2html">mat2html</A> on Tue Feb  2 16:15:45 EST 1999
58 <BR>
59 Cross-Directory links are: OFF<BR>
60 </BODY>
Note: See TracBrowser for help on using the browser.