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

root/gliderproc/trunk/MATLAB/opnml/html/4.IO_Functions/read_pth.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 ./IO_Functions]</A>
4 <A HREF = "../index.html">[Return to Master Index]</A>
5 <H1>read_pth</H1>
6 <H2>(./IO_Functions/read_pth.m)</H2>
7 <HR><H3>Function Synopsis</H3>
8 <pre>[gridname,ndrog,nts,tsec,pth]=read_pth(fname,ncol,fmtstr)</pre>
9 <HR><H3>Help text</H3>
10 <pre>
11 READ_PTH read drogue .pth file output from DROG3D or DROG3DDT.
12
13  [gridname,ndrog,ndts,tsec,pth]=read_pth(fname,ncol,fmtstr);
14
15            Input:
16                   fname  - path/name of .pth file
17                   ncol   - number of columns in output matrix
18                   fmtstr - format string for PLOTDROG to use in
19                            reading the .pth file (optional)
20           Output:
21                  gridname - domain name of computation
22                  ndrog    - number of drogues at start of run
23                  ndts     - number of time steps in run
24                  tsec     - length of run in seconds
25                  pth      - path data part of the .pth file.
26
27           READ_PTH takes as required arguments the path/filename of the
28            .pth file generated by DROG3D(DT), and the number of columns
29           the subroutine OUTPUT (from DROG3D(DT)) used to write the .pth
30           file.  The filename specified must NOT include the .pth suffix. 
31           This allows READ_PTH to verify that the filetype is correct.
32            Ex.: if the path/filename is 'results/case1.pth', the name given
33            to READ_PTH should be 'results/case1'.
34
35           Optional argument comments:
36
37           If fmtstr is NOT specified, READ_PTH makes assumes the following
38           as to the format of the path matrix:
39  
40            If ncol = 3  --&gt;  real   real   real
41            If ncol = 4  --&gt;  real   real   real   real
42            If ncol = 5  --&gt;  real   real   real   real  integer
43            If ncol = 6  --&gt;  real   real   real   real  real  integer
44
45           If the above assumption about the format of the output matrix
46           is NOT correct, you must specify, in the C fashion, the correct
47           format for READ_PTH to use in the C fashion.  See the MATLAB
48           Reference Guide under FSCANF for more on format specification. 
49
50  Call as: [gridname,ndrog,ndts,tsec,pth]=read_pth(fname,ncol,fmtstr);
51
52  Written by: Brian O. Blanton
53
54 </pre>
55 <HR>
56 Produced by <A HREF="http://www.nd.edu/Courses/kantor/matlab/mat2html">mat2html</A> on Tue Feb  2 16:15:45 EST 1999
57 <BR>
58 Cross-Directory links are: OFF<BR>
59 </BODY>
Note: See TracBrowser for help on using the browser.