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

root/gliderproc/trunk/MATLAB/opnml/html/7.mat4/tellipse.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 ./mat4]</A>
4 <A HREF = "../index.html">[Return to Master Index]</A>
5 <H1>tellipse</H1>
6 <H2>(./mat4/tellipse.m)</H2>
7 <HR><H3>Function Synopsis</H3>
8 <pre>[htel,umi,ori]=tellipse(xc,yc,u,phi_u,v,phi_v,per,skip,sc,part_flag)</pre>
9 <HR><H3>Help text</H3>
10 <pre>
11 TELLIPSE plot ellipses from amp/phase specification of a vel field
12  htel=tellipse(xc,yc,ua,up,va,vp,per,skip,sc,flag)
13
14   TELLIPSE requires the following arguments:
15       x    - ellipse x-coordinate centers, usually node x's;
16       y    - ellipse y-coordinate centers, usually node y's;
17       ua   - east (u) component amplitudes       
18       up   - east (u) component phases (degrees)       
19       va   - north (v) component amplitudes         
20       vp   - north (v) component phases (degrees)       
21       per  - period of field in hours
22
23   TELLIPSE allows the following optional arguments:
24       skip - number of nodes to skip in subsampling field
25       sc   - scaling factor to use if per is 0.
26       flag - flag for particle-excursion interpretation (0|1)
27  
28       NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE
29       IF THE SCALING FACTOR NEEDS TO BE SPECIFIED, SKIP
30       MUST ALSO BE SPECIFIED.  IF FLAG IS SPECIFIED,
31       SC AND SKIP MUST BE SPECIFIED, BOTH OF WHICH CAN BE SET
32       TO 1.
33
34   TELLIPSE scales the ellipses to 10% of the x-axis length
35   if sc=1; this is the default.  If sc=.5, the ellipse
36   magnitudes are scaled to 5% of the x-axis length,
37   in the same manner as VECPLOT. 
38
39   TELLIPSE expects the input phases to be in degrees and
40   attemps to determine the units of the phaselag by computing
41   the range of the phaselag columns in the input matrix.
42   If this range is within [0,2*pi], TELLIPSE reports this as
43   a potential problem.  It does NOT abort due to the possibility
44   of the phaselags correctly being in degrees and still having
45   a range within [0,2*pi].
46
47   NOTES: 1) TELLIPSE plots CCW ellipses in blue and CW ellipses
48             in red.
49          2) TELLIPSE requires atleast 2 points and vectors.
50
51  Call as: htel=tellipse(x,y,ua,up,va,vp,per,skip,sc,flag);
52
53  Written by : Brian O. Blanton
54
55 </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.