author | A.M. Thurnherr <athurnherr@yahoo.com> |
Tue, 27 Nov 2018 12:58:21 -0500 | |
changeset 36 | 04e8cb4f8073 |
parent 20 | 7ea1fd9d64e6 |
child 39 | 56bdfe65a697 |
permissions | -rw-r--r-- |
0 | 1 |
#====================================================================== |
2 |
# L I B L A D C P . P L |
|
3 |
# doc: Wed Jun 1 20:38:19 2011 |
|
36 | 4 |
# dlm: Wed Apr 25 17:41:36 2018 |
0 | 5 |
# (c) 2011 A.M. Thurnherr |
36 | 6 |
# uE-Info: 46 27 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() |
|
4
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
22 |
# Oct 25, 2012: - renamed T_SM() to T_ASM() |
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
23 |
# Jun 26. 2013: - added T_w_z() |
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
24 |
# - added parameter checks to processing-specific corrections |
20 | 25 |
# May 18, 2015: - added pulse length to T_w() and T_w_z() |
36 | 26 |
# Apr 25, 2018: - added eps_VKE() parameterization |
0 | 27 |
|
28 |
require "$ANTS/libvec.pl"; |
|
29 |
require "$ANTS/libfuns.pl"; |
|
30 |
||
3 | 31 |
#------------------------------------------------------------------------------ |
36 | 32 |
# VKE parameterization for epsilon |
33 |
# |
|
34 |
# NOTES: |
|
35 |
# - see Thurnherr et al. (GRL 2015) |
|
36 |
# - calculate eps from p0 |
|
37 |
# - optional second argument allows free choice of parameterization constant |
|
38 |
# - default value is from paper, which is slightly lower than the current value |
|
39 |
# used in [LADCP_VKE], which applies the parameterization only to spectra |
|
40 |
# passing a few tests |
|
41 |
#------------------------------------------------------------------------------ |
|
42 |
||
43 |
sub eps_VKE(@) |
|
44 |
{ |
|
45 |
my($p0,$c) = |
|
46 |
&antsFunUsage(-1,'.','<p0[m^2/s^2/(rad/m)]> [c[0.021 [1/sqrt(s)]]]',@_); |
|
47 |
$c = 0.021 unless defined($c); |
|
48 |
return numberp($p0) ? ($p0 / $c) ** 2 : nan; |
|
49 |
} |
|
50 |
||
51 |
#------------------------------------------------------------------------------ |
|
3 | 52 |
# Spectral corrections for LADCP data |
53 |
# |
|
54 |
# NOTES: |
|
55 |
# - see Polzin et al. (JAOT 2002), Thurnherr (JAOT 2012) |
|
56 |
# - to correct, multiply power densities (or power, I think) with corrections |
|
57 |
# - apply to down-/up-cast data only |
|
58 |
#------------------------------------------------------------------------------ |
|
0 | 59 |
#---------------------------------------------------------------------- |
3 | 60 |
# 1. Corrections for individual data acquisition and processing steps |
0 | 61 |
#---------------------------------------------------------------------- |
62 |
||
3 | 63 |
#------------------------------------------------------------------------------ |
20 | 64 |
# T_ravg(k,blen[,plen]) |
3 | 65 |
# - correct for range averaging due to finite pulse and finite receive window |
20 | 66 |
# - when called with 2 arguments, bin-length == pulse-length assumed |
3 | 67 |
#------------------------------------------------------------------------------ |
0 | 68 |
|
20 | 69 |
sub T_ravg(@) |
0 | 70 |
{ |
20 | 71 |
my($k,$blen,$plen) = |
72 |
&antsFunUsage(-2,'ff','<vertical wavenumber[rad/s]> <bin-length[m]> [pulse-length[m]]',@_); |
|
73 |
$plen = $blen unless defined($plen); |
|
74 |
return 1 / sinc($k*$blen/2/$PI)**2 / sinc($k*$plen/2/$PI)**2; |
|
0 | 75 |
} |
76 |
||
3 | 77 |
#------------------------------------------------------------- |
78 |
# T_fdiff(k,dz) |
|
79 |
# - correct for first differencing on a grid with dz spacing |
|
80 |
#------------------------------------------------------------- |
|
0 | 81 |
|
82 |
sub T_fdiff($$) |
|
83 |
{ |
|
3 | 84 |
my($k,$dz) = |
0 | 85 |
&antsFunUsage(2,'ff','<vertical wavenumber[rad/s]> <differencing interval[m]>',@_); |
3 | 86 |
return 1 / sinc($k*$dz/2/$PI)**2; |
0 | 87 |
} |
88 |
||
3 | 89 |
#------------------------------------------------------------ |
90 |
# T_interp(k,blen,dz) |
|
91 |
# - correct for CODAS gridding-with-interpolation algorithm |
|
92 |
# - ONLY USED IN UH SOFTWARE |
|
93 |
#------------------------------------------------------------ |
|
0 | 94 |
|
95 |
sub T_interp($$$) |
|
96 |
{ |
|
3 | 97 |
my($k,$blen,$dz) = |
0 | 98 |
&antsFunUsage(3,'fff','<vertical wavenumber[rad/s]> <bin length[m]> <grid resolution[m]>',@_); |
3 | 99 |
return 1 / sinc($k*$blen/2/$PI)**4 / sinc($k*$dz/2/$PI)**2; |
0 | 100 |
} |
101 |
||
3 | 102 |
#------------------------------------------------------------------------- |
103 |
# T_binavg(k,dz) |
|
104 |
# - correct for simple bin averaging |
|
105 |
# - Polzin et al. suggest to use blen instead of dz; this must be a typo |
|
106 |
#------------------------------------------------------------------------- |
|
0 | 107 |
|
108 |
sub T_binavg($$) |
|
109 |
{ |
|
3 | 110 |
my($k,$dz) = |
0 | 111 |
&antsFunUsage(2,'ff','<vertical wavenumber[rad/s]> <grid resolution[m]>',@_); |
3 | 112 |
return 1 / sinc($k*$dz/2/$PI)**2; |
0 | 113 |
} |
114 |
||
3 | 115 |
#-------------------------------------------------------------------------------- |
116 |
# T_tilt(k,d') |
|
117 |
# - d' is a length scale that depends on tilt stats and range max |
|
118 |
# - on d' == 0, T_tilt() == 1, i.e. the correction is disabled |
|
119 |
# - d' = dprime(range_max) |
|
120 |
# - is from a quadratic fit to three data points given by Polzin et al. |
|
121 |
# - see Thurnherr (J. Tech. 2012) for notes |
|
122 |
# - on range_max == 0, d' == 0, i.e. the correction is disabled |
|
123 |
#-------------------------------------------------------------------------------- |
|
0 | 124 |
|
125 |
sub T_tilt($$) |
|
126 |
{ |
|
3 | 127 |
my($k,$dprime) = |
0 | 128 |
&antsFunUsage(2,'ff','<vertical wavenumber[rad/s]> <d-prime[m]>',@_); |
3 | 129 |
return $dprime ? 1 / sinc($k*$dprime/2/$PI)**2 : 1; |
130 |
} |
|
131 |
||
132 |
sub dprime($) |
|
133 |
{ |
|
134 |
return $_[0] ? -1.2 + 0.0857 * $_[0] - 0.000136 * $_[0]**2 : 0; |
|
135 |
} |
|
136 |
||
137 |
#====================================================================== |
|
138 |
# 2. Processing-Specific Corrections |
|
139 |
#====================================================================== |
|
140 |
||
141 |
#---------------------------------------------------------------------- |
|
142 |
# T_UH(k,blen,dz,range_max) |
|
143 |
# - UH implementation of the shear method (WOCE standard) |
|
144 |
# - range_max == 0 disables tilt correction |
|
145 |
#---------------------------------------------------------------------- |
|
146 |
||
147 |
sub T_UH($$$$) |
|
148 |
{ |
|
149 |
my($k,$blen,$dz,$range_max) = |
|
150 |
&antsFunUsage(4,'ffff','<vertical wavenumber[rad/s]> <ADCP bin size[m]> <shear grid resolution[m]> <range max[m]>',@_); |
|
4
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
151 |
croak("T_UH($k,$blen,$dz,$range_max): bad parameters\n") |
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
152 |
unless ($k>=0 && $blen>0 && $dz>0 && $range_max>=0); |
3 | 153 |
return T_ravg($k,$blen) * T_fdiff($k,$blen) * T_interp($k,$blen,$dz) * T_tilt($k,dprime($range_max)); |
0 | 154 |
} |
155 |
||
156 |
#---------------------------------------------------------------------- |
|
3 | 157 |
# T_ASM(k,blen,dz,range_max) |
158 |
# - re-implemented shear method with simple depth binning |
|
159 |
# - range_max == 0 disables tilt correction |
|
0 | 160 |
#---------------------------------------------------------------------- |
161 |
||
3 | 162 |
sub T_ASM($$$$) |
0 | 163 |
{ |
3 | 164 |
my($k,$blen,$dz,$range_max) = |
165 |
&antsFunUsage(4,'ffff','<vertical wavenumber[rad/s]> <ADCP bin size[m]> <shear grid resolution[m]> <range max[m]>',@_); |
|
4
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
166 |
croak("T_ASM($k,$blen,$dz,$range_max): bad parameters\n") |
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
167 |
unless ($k>=0 && $blen>0 && $dz>0 && $range_max>=0); |
3 | 168 |
return T_ravg($k,$blen) * T_fdiff($k,$blen) * T_binavg($k,$dz) * T_tilt($k,dprime($range_max)); |
0 | 169 |
} |
170 |
||
3 | 171 |
#------------------------------------------------------------ |
172 |
# T_VI(k,blen,preavg_dz,grid_dz,range_max) |
|
173 |
# T_VI_alt(k,blen,preavg_dz,grid_dz,dprime) |
|
174 |
# - velocity inversion method of Visbeck (J. Tech., 2002) |
|
175 |
# - only valid if pre-averaging into superensembles is used |
|
176 |
# - range_max == 0 disables tilt correction |
|
4
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
177 |
# - sel == nan disables pre-averaging correction |
3 | 178 |
#------------------------------------------------------------ |
0 | 179 |
|
180 |
sub T_VI($$$$$) |
|
181 |
{ |
|
3 | 182 |
my($k,$blen,$sel,$dz,$range_max) = |
183 |
&antsFunUsage(5,'ff.ff','<vertical wavenumber[rad/s]> <ADCP bin size[m]> <superensemble size[m]|nan> <shear grid resolution[m]> <range max[m]>',@_); |
|
184 |
return T_VI_alt($k,$blen,$sel,$dz,dprime($range_max)); |
|
0 | 185 |
} |
186 |
||
187 |
sub T_VI_alt($$$$$) |
|
188 |
{ |
|
3 | 189 |
my($k,$blen,$sel,$dz,$dprime) = |
0 | 190 |
&antsFunUsage(5,'ff.ff','<vertical wavenumber[rad/s]> <ADCP bin size[m]> <superensemble size[m]|nan> <shear grid resolution[m]> <tilt d-prime[m]>',@_); |
4
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
191 |
croak("T_VI_alt($k,$blen,$sel,$dz,$range_max): bad parameters\n") |
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
192 |
unless ($k>=0 && $blen>0 && $sel ne '' && $dz>0 && $range_max>=0); |
0 | 193 |
croak("$0: tilt-dprime outside range [0..$blen]\n") |
194 |
unless ($dprime>=0 && $dprime<=$blen); |
|
3 | 195 |
return ($sel>0) ? T_ravg($k,$blen) * T_binavg($k,$sel) * T_binavg($k,$dz) * T_tilt($k,$dprime) |
196 |
: T_ravg($k,$blen) * T_binavg($k,$dz) * T_tilt($k,$dprime); |
|
197 |
} |
|
198 |
||
199 |
#---------------------------------------------------------------------- |
|
20 | 200 |
# T_w(k,blen,plen,dz,range_max) |
3 | 201 |
# - vertical-velocity method of Thurnherr (IEEE 2011) |
202 |
# - range_max == 0 disables tilt correction |
|
203 |
#---------------------------------------------------------------------- |
|
204 |
||
205 |
{ my(@fc); |
|
206 |
sub T_w(@) |
|
207 |
{ |
|
20 | 208 |
my($k,$blen,$plen,$dz,$range_max) = |
209 |
&antsFunUsage(5,'fffff', |
|
210 |
'[vertical wavenumber[rad/s]] <ADCP bin length[m]> <pulse length[m]> <output grid resolution[m]> <range max[m]>', |
|
211 |
\@fc,'k',undef,undef,undef,undef,@_); |
|
212 |
croak("T_w($k,$blen,$plen,$dz,$range_max): bad parameters\n") |
|
213 |
unless ($k>=0 && $blen>0 && $plen>0 && $dz>0 && $range_max>=0); |
|
214 |
return T_ravg($k,$blen,$plen) * T_binavg($k,$dz) * T_tilt($k,dprime($range_max)); |
|
3 | 215 |
} |
0 | 216 |
} |
217 |
||
4
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
218 |
#---------------------------------------------------------------------- |
20 | 219 |
# T_w_z(k,blen,plen,dz,range_max) |
4
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
220 |
# - vertical-velocity method of Thurnherr (IEEE 2011) |
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
221 |
# - first differencing of gridded shear to calculate dw/dz |
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
222 |
# - NB: grid-scale differentiation assumed |
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
223 |
# - range_max == 0 disables tilt correction |
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
224 |
#---------------------------------------------------------------------- |
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
225 |
|
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
226 |
{ my(@fc); |
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
227 |
sub T_w_z(@) |
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
228 |
{ |
20 | 229 |
my($k,$blen,$plen,$dz,$range_max) = |
230 |
&antsFunUsage(5,'fffff', |
|
231 |
'[vertical wavenumber[rad/s]] <ADCP bin size[m]> <pulse length[m]> <output grid resolution[m]> <range max[m]>', |
|
232 |
\@fc,'k',undef,undef,undef,undef,@_); |
|
233 |
croak("T_w_z($k,$blen,$plen,$dz,$range_max): bad parameters\n") |
|
234 |
unless ($k>=0 && $blen>0 && $plen>0 && $dz>0 && $range_max>=0); |
|
235 |
return T_ravg($k,$blen,$plen) * T_binavg($k,$dz) * T_tilt($k,dprime($range_max)) * T_fdiff($k,$dz); |
|
4
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
236 |
} |
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
237 |
} |
ff72b00b4342
after adding $pi and some other stuff
A.M. Thurnherr <athurnherr@yahoo.com>
parents:
3
diff
changeset
|
238 |
|
0 | 239 |
1; |