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

root/gliderproc/trunk/MATLAB/opnml/html/6.basics/gen_drog_grid.html

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

Initial import of Stark code.

Line 
1 <TITLE>/</TITLE>
2 <BODY>
3 <A HREF = "index.html">[Index for ./basics]</A>
4 <A HREF = "../index.html">[Return to Master Index]</A>
5 <H1>gen_drog_grid</H1>
6 <H2>(./basics/gen_drog_grid.m)</H2>
7 <HR><H3>Function Synopsis</H3>
8 <pre>outmat=gen_drog_grid(nx,ny,nlev,z,box_coords)</pre>
9 <HR><H3>Help text</H3>
10 <pre>
11 GEN_DROG_GRID Mouse-driven drogue input coordinate generator
12
13  GEN_DROG_GRID - Mouse-driven drogue input coordinate generator prompts
14                  the user to draw a box on the current figure, and returns
15                  an array of coordinates suitable for a drogue
16                  initialization file.
17
18   INPUT:  nx,ny  - number of drogues in the x and y direction (REQUIRED,
19                    INTEGERS).  If nx or ny==1, then the output is a
20                    diagonal line from between starting and ending points.
21           nlev   - number of vertical levels to duplicate the
22                    horizontal positions (OPTIONAL, DEFAULT=1, INTEGER)
23                    If nlev is given, then so must z.
24           z      - the depth to assign to the horizontal drogue
25                    locations.  z must be of length 1:nlev, providing
26                    one depth for each horizontal level.  (OPTIONAL, FLOAT)
27                    In this version, z must be a single
28                    number.  It will be used as the depth for the (nx*ny)
29                    horizontal locations.
30
31           box_coords - optional 4x1 vector defining the sample region. 
32                        The 4 values are [X1 Y1 X2 Y2], and if defined
33                        they take precedence over the mouse-driven facility.
34
35  OUTPUT:  outmat - if z is supplied as input, outmat is a (nx*ny) by 3
36                    array of 3-D starting locations
37                    if z is NOT supplied as input, outmat is a (nx*ny) by 2
38                    array of 2-D starting locations
39
40  Call as: outmat=gen_drog_grid(nx,ny)
41       OR: outmat=gen_drog_grid(nx,ny,z)
42       OR: outmat=gen_drog_grid(nx,ny,nlev,z)
43       OR: outmat=gen_drog_grid(nx,ny,nlev,z,box_coords)
44
45  Written by :Brian O. Blanton
46  Summer 1998
47
48 </pre>
49 <HR><H3>Cross-Reference Information</H3>This function calls
50 <pre><UL>
51 <LI><A HREF = "../6.basics/isint.html">isint</A>          ./basics/isint.m</LI>
52 </UL></pre>
53 This function is called by
54 <pre><UL>
55 <LI><A HREF = "../6.basics/gen_drog_line.html">gen_drog_line</A>  ./basics/gen_drog_line.m</LI>
56 </UL></pre>
57 <HR>
58 Produced by <A HREF="http://www.nd.edu/Courses/kantor/matlab/mat2html">mat2html</A> on Tue Feb  2 16:15:45 EST 1999
59 <BR>
60 Cross-Directory links are: OFF<BR>
61 </BODY>
Note: See TracBrowser for help on using the browser.