|
1 ====================================================================== |
|
2 R E A D M E . O U T P U T |
|
3 doc: Tue May 15 19:17:50 2012 |
|
4 dlm: Fri Jun 15 07:39:19 2012 |
|
5 (c) 2012 A.M. Thurnherr |
|
6 uE-Info: 44 0 NIL 0 0 72 3 2 8 NIL ofnI |
|
7 ====================================================================== |
|
8 |
|
9 This README describes the output produced by [LADCPproc] and |
|
10 [LADCPintsh]. |
|
11 |
|
12 |
|
13 =File Format and Interface with Matlab= |
|
14 |
|
15 All output files produced by [LADCPproc] and [LADCPintsh] are in a |
|
16 proprietary undocumented ASCII format, called ANTS. To important and |
|
17 export ANTS files into and from Matlab, the Matlab_tools are required |
|
18 (see [README.Install]). |
|
19 |
|
20 To import the ANTS file <013DL.sh> into Matlab, use |
|
21 |
|
22 sh = loadANTS('013DL.sh'); |
|
23 |
|
24 The resulting structure will contain Metadata as scalars and the data |
|
25 from each field in a suitably named vector. |
|
26 |
|
27 To export the suitable Matlab structure <binned_sh> as the ANTS file |
|
28 <013DL.shprof>, use |
|
29 |
|
30 struct2ANTS(binned_sh,'013DL.sh','013DL.shprof'); |
|
31 |
|
32 The second argument defines a dependency (the file <013DL.shprof> should |
|
33 be re-made when <013DL.sh> changes). |
|
34 |
|
35 |
|
36 =[LADCPproc] Output= |
|
37 |
|
38 The STDOUT of [LADCPproc] consists of a list of all shear samples --- |
|
39 essentially a time-depth-series (.tds) of shear values. If this output |
|
40 is not required, STDOUT can be redirected to /dev/null. |
|
41 |
|
42 The STDERR of [LADCPproc] consists of the diagnostic output. This output |
|
43 should be captured into a log file. This is much easier with standard |
|
44 (bash, Korn, Bourne) shells than with csh derivates. |
|
45 |
|
46 Additional output is produced with the following options: |
|
47 |
|
48 -p write a binned shear profile file that can be fed |
|
49 directly to [LADCPintsh] to create a relative |
|
50 (baroclinic) velocity profile |
|
51 |
|
52 -b write a bottom-track file that can be fed directly to |
|
53 [LADCPintsh] (-r option) to reference the baroclinic |
|
54 velocity profile |
|
55 |
|
56 -t write a time-series file, which is useful primarily for |
|
57 diagnosing problems with the time-lagging of CTD and |
|
58 LADCP data |
|
59 |
|
60 -f write a file with all the velocity editing flags |
|
61 |
|
62 -a write a .dts file of the acoustic backscatter |
|
63 |
|
64 -k write bottom track profiles (as a single file) |
|
65 |
|
66 |
|
67 =[LADCPintsh] Output= |
|
68 |
|
69 The STDOUT of [LADCPintsh] consists of a velocity profile created from |
|
70 the vertically integrated shear and possibly referenced by an external |
|
71 velocity profile. |
|
72 |
|
73 The STDERR of [LADCPintsh] consists of minimal diagnostic output. |
|
74 |
|
75 On -s, additionally the shear profile is written to a file just before |
|
76 integration. This is primarily useful for combining shear data from |
|
77 down- and uplooking ADCPs. |