0
|
1 |
#======================================================================
|
|
2 |
# L I B L A D C P . P L
|
|
3 |
# doc: Wed Jun 1 20:38:19 2011
|
3
|
4 |
# dlm: Thu Oct 25 21:24:59 2012
|
0
|
5 |
# (c) 2011 A.M. Thurnherr
|
3
|
6 |
# uE-Info: 22 41 NIL 0 0 70 2 2 4 NIL ofnI
|
0
|
7 |
#======================================================================
|
|
8 |
|
|
9 |
# HISTORY:
|
|
10 |
# Jun 1, 2011: - created
|
|
11 |
# Jul 29, 2011: - improved
|
|
12 |
# Aug 10, 2011: - made correct
|
|
13 |
# Aug 11, 2011: - added "convenient combinations"
|
|
14 |
# Aug 18, 2011: - made buoyancy frequency non-constant in S()
|
|
15 |
# Jan 4, 2012: - improved T_VI to allow correcting even without superensembles
|
|
16 |
# Jan 5, 2012: - removed S(), which is just pwrdens/N^2 (rather than
|
|
17 |
# pwrdens/N^2/(2pi) as I erroneously thought)
|
|
18 |
# Jan 18, 2012: - added T_VI_alt() to allow assessment of tilt correction extrema
|
3
|
19 |
# Aug 22, 2012: - added documentation
|
|
20 |
# - added T_w()
|
|
21 |
# Sep 24, 2012: - made "k" argument default in T_w()
|
|
22 |
# Oct 25, 2012: - renamed T_SM to T_ASM
|
0
|
23 |
|
|
24 |
require "$ANTS/libvec.pl";
|
|
25 |
require "$ANTS/libfuns.pl";
|
|
26 |
|
3
|
27 |
#------------------------------------------------------------------------------
|
|
28 |
# Spectral corrections for LADCP data
|
|
29 |
#
|
|
30 |
# NOTES:
|
|
31 |
# - see Polzin et al. (JAOT 2002), Thurnherr (JAOT 2012)
|
|
32 |
# - to correct, multiply power densities (or power, I think) with corrections
|
|
33 |
# - apply to down-/up-cast data only
|
|
34 |
#------------------------------------------------------------------------------
|
|
35 |
|
0
|
36 |
#----------------------------------------------------------------------
|
3
|
37 |
# 1. Corrections for individual data acquisition and processing steps
|
0
|
38 |
#----------------------------------------------------------------------
|
|
39 |
|
3
|
40 |
#------------------------------------------------------------------------------
|
|
41 |
# T_ravg(k,blen)
|
|
42 |
# - correct for range averaging due to finite pulse and finite receive window
|
|
43 |
# - this version assumes bin-length == pulse-length
|
|
44 |
#------------------------------------------------------------------------------
|
0
|
45 |
|
|
46 |
sub T_ravg($$)
|
|
47 |
{
|
3
|
48 |
my($k,$blen) =
|
0
|
49 |
&antsFunUsage(2,'ff','<vertical wavenumber[rad/s]> <pulse/bin-length[m]>',@_);
|
3
|
50 |
return 1 / sinc($k*$blen/2/$PI)**4;
|
0
|
51 |
}
|
|
52 |
|
3
|
53 |
#-------------------------------------------------------------
|
|
54 |
# T_fdiff(k,dz)
|
|
55 |
# - correct for first differencing on a grid with dz spacing
|
|
56 |
#-------------------------------------------------------------
|
0
|
57 |
|
|
58 |
sub T_fdiff($$)
|
|
59 |
{
|
3
|
60 |
my($k,$dz) =
|
0
|
61 |
&antsFunUsage(2,'ff','<vertical wavenumber[rad/s]> <differencing interval[m]>',@_);
|
3
|
62 |
return 1 / sinc($k*$dz/2/$PI)**2;
|
0
|
63 |
}
|
|
64 |
|
3
|
65 |
#------------------------------------------------------------
|
|
66 |
# T_interp(k,blen,dz)
|
|
67 |
# - correct for CODAS gridding-with-interpolation algorithm
|
|
68 |
# - ONLY USED IN UH SOFTWARE
|
|
69 |
#------------------------------------------------------------
|
0
|
70 |
|
|
71 |
sub T_interp($$$)
|
|
72 |
{
|
3
|
73 |
my($k,$blen,$dz) =
|
0
|
74 |
&antsFunUsage(3,'fff','<vertical wavenumber[rad/s]> <bin length[m]> <grid resolution[m]>',@_);
|
3
|
75 |
return 1 / sinc($k*$blen/2/$PI)**4 / sinc($k*$dz/2/$PI)**2;
|
0
|
76 |
}
|
|
77 |
|
3
|
78 |
#-------------------------------------------------------------------------
|
|
79 |
# T_binavg(k,dz)
|
|
80 |
# - correct for simple bin averaging
|
|
81 |
# - Polzin et al. suggest to use blen instead of dz; this must be a typo
|
|
82 |
#-------------------------------------------------------------------------
|
0
|
83 |
|
|
84 |
sub T_binavg($$)
|
|
85 |
{
|
3
|
86 |
my($k,$dz) =
|
0
|
87 |
&antsFunUsage(2,'ff','<vertical wavenumber[rad/s]> <grid resolution[m]>',@_);
|
3
|
88 |
return 1 / sinc($k*$dz/2/$PI)**2;
|
0
|
89 |
}
|
|
90 |
|
3
|
91 |
#--------------------------------------------------------------------------------
|
|
92 |
# T_tilt(k,d')
|
|
93 |
# - d' is a length scale that depends on tilt stats and range max
|
|
94 |
# - on d' == 0, T_tilt() == 1, i.e. the correction is disabled
|
|
95 |
# - d' = dprime(range_max)
|
|
96 |
# - is from a quadratic fit to three data points given by Polzin et al.
|
|
97 |
# - see Thurnherr (J. Tech. 2012) for notes
|
|
98 |
# - on range_max == 0, d' == 0, i.e. the correction is disabled
|
|
99 |
#--------------------------------------------------------------------------------
|
0
|
100 |
|
|
101 |
sub T_tilt($$)
|
|
102 |
{
|
3
|
103 |
my($k,$dprime) =
|
0
|
104 |
&antsFunUsage(2,'ff','<vertical wavenumber[rad/s]> <d-prime[m]>',@_);
|
3
|
105 |
return $dprime ? 1 / sinc($k*$dprime/2/$PI)**2 : 1;
|
|
106 |
}
|
|
107 |
|
|
108 |
sub dprime($)
|
|
109 |
{
|
|
110 |
return $_[0] ? -1.2 + 0.0857 * $_[0] - 0.000136 * $_[0]**2 : 0;
|
|
111 |
}
|
|
112 |
|
|
113 |
#======================================================================
|
|
114 |
# 2. Processing-Specific Corrections
|
|
115 |
#======================================================================
|
|
116 |
|
|
117 |
#----------------------------------------------------------------------
|
|
118 |
# T_UH(k,blen,dz,range_max)
|
|
119 |
# - UH implementation of the shear method (WOCE standard)
|
|
120 |
# - range_max == 0 disables tilt correction
|
|
121 |
#----------------------------------------------------------------------
|
|
122 |
|
|
123 |
sub T_UH($$$$)
|
|
124 |
{
|
|
125 |
my($k,$blen,$dz,$range_max) =
|
|
126 |
&antsFunUsage(4,'ffff','<vertical wavenumber[rad/s]> <ADCP bin size[m]> <shear grid resolution[m]> <range max[m]>',@_);
|
|
127 |
return T_ravg($k,$blen) * T_fdiff($k,$blen) * T_interp($k,$blen,$dz) * T_tilt($k,dprime($range_max));
|
0
|
128 |
}
|
|
129 |
|
|
130 |
#----------------------------------------------------------------------
|
3
|
131 |
# T_ASM(k,blen,dz,range_max)
|
|
132 |
# - re-implemented shear method with simple depth binning
|
|
133 |
# - range_max == 0 disables tilt correction
|
0
|
134 |
#----------------------------------------------------------------------
|
|
135 |
|
3
|
136 |
sub T_ASM($$$$)
|
0
|
137 |
{
|
3
|
138 |
my($k,$blen,$dz,$range_max) =
|
|
139 |
&antsFunUsage(4,'ffff','<vertical wavenumber[rad/s]> <ADCP bin size[m]> <shear grid resolution[m]> <range max[m]>',@_);
|
|
140 |
return T_ravg($k,$blen) * T_fdiff($k,$blen) * T_binavg($k,$dz) * T_tilt($k,dprime($range_max));
|
0
|
141 |
}
|
|
142 |
|
3
|
143 |
#------------------------------------------------------------
|
|
144 |
# T_VI(k,blen,preavg_dz,grid_dz,range_max)
|
|
145 |
# T_VI_alt(k,blen,preavg_dz,grid_dz,dprime)
|
|
146 |
# - velocity inversion method of Visbeck (J. Tech., 2002)
|
|
147 |
# - only valid if pre-averaging into superensembles is used
|
|
148 |
# - range_max == 0 disables tilt correction
|
|
149 |
#------------------------------------------------------------
|
0
|
150 |
|
|
151 |
sub T_VI($$$$$)
|
|
152 |
{
|
3
|
153 |
my($k,$blen,$sel,$dz,$range_max) =
|
|
154 |
&antsFunUsage(5,'ff.ff','<vertical wavenumber[rad/s]> <ADCP bin size[m]> <superensemble size[m]|nan> <shear grid resolution[m]> <range max[m]>',@_);
|
|
155 |
return T_VI_alt($k,$blen,$sel,$dz,dprime($range_max));
|
0
|
156 |
}
|
|
157 |
|
|
158 |
sub T_VI_alt($$$$$)
|
|
159 |
{
|
3
|
160 |
my($k,$blen,$sel,$dz,$dprime) =
|
0
|
161 |
&antsFunUsage(5,'ff.ff','<vertical wavenumber[rad/s]> <ADCP bin size[m]> <superensemble size[m]|nan> <shear grid resolution[m]> <tilt d-prime[m]>',@_);
|
|
162 |
croak("$0: tilt-dprime outside range [0..$blen]\n")
|
|
163 |
unless ($dprime>=0 && $dprime<=$blen);
|
3
|
164 |
return ($sel>0) ? T_ravg($k,$blen) * T_binavg($k,$sel) * T_binavg($k,$dz) * T_tilt($k,$dprime)
|
|
165 |
: T_ravg($k,$blen) * T_binavg($k,$dz) * T_tilt($k,$dprime);
|
|
166 |
}
|
|
167 |
|
|
168 |
#----------------------------------------------------------------------
|
|
169 |
# T_w(k,blen,dz,range_max)
|
|
170 |
# - vertical-velocity method of Thurnherr (IEEE 2011)
|
|
171 |
# - range_max == 0 disables tilt correction
|
|
172 |
#----------------------------------------------------------------------
|
|
173 |
|
|
174 |
{ my(@fc);
|
|
175 |
sub T_w(@)
|
|
176 |
{
|
|
177 |
my($k,$blen,$dz,$range_max) =
|
|
178 |
&antsFunUsage(4,'ffff',
|
|
179 |
'[vertical wavenumber[rad/s]] <ADCP bin size[m]> <output grid resolution[m]> <range max[m]>',
|
|
180 |
\@fc,'k',undef,undef,undef,@_);
|
|
181 |
return T_ravg($k,$blen) * T_binavg($k,$dz) * T_tilt($k,dprime($range_max));
|
|
182 |
}
|
0
|
183 |
}
|
|
184 |
|
|
185 |
1;
|