-
Notifications
You must be signed in to change notification settings - Fork 106
/
pybatohilmrhohdh.1
160 lines (160 loc) · 5.79 KB
/
pybatohilmrhohdh.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
.\" Automatically generated by Pandoc 1.17.2
.\"
.TH "pybatohilmrhohdh" "1" "2016\-07\-27" "Python" "SHTOOLS 3.3"
.hy
.SH BAtoHilmRhoHDH
.PP
Calculate iteratively the relief along an interface with lateral density
variations that corresponds to a given Bouguer anomaly using the
algorithm of Wieczorek and Phillips (1998).
.SH Usage
.PP
\f[C]cilm\f[] = pyshtools.BAtoHilmRhoHDH (\f[C]ba\f[], \f[C]grid\f[],
\f[C]rho\f[], \f[C]nmax\f[], \f[C]mass\f[], \f[C]r0\f[],
[\f[C]filtertype\f[], \f[C]filterdeg\f[], \f[C]lmax\f[],
\f[C]lmaxcalc\f[], \f[C]sampling\f[])
.SH Returns
.TP
.B \f[C]cilm\f[] : float, dimension (2, \f[C]lmaxcalc\f[]+1, \f[C]lmaxcalc\f[]+1)
An estimate of the real spherical harmonic coefficients (geodesy
normalized) of relief along an interface with lateraly varying density
contrast \f[C]rho\f[] that satisfies the Bouguer anomaly \f[C]ba\f[].
The degree\-zero term corresponds to the mean radius of the relief.
.RS
.RE
.SH Parameters
.TP
.B \f[C]ba\f[] : float, dimension (2, \f[C]lmaxcalc\f[]+1, \f[C]lmaxcalc\f[]+1)
The real spherical harmonic coefficients of the Bouguer anomaly
referenced to a spherical interface \f[C]r0\f[].
.RS
.RE
.TP
.B \f[C]grid\f[] : float, dimension (2*\f[C]lmaxin\f[]+2, \f[C]sampling\f[]*(2*\f[C]lmaxin\f[]+2))
The initial estimate for the radii of the interface evaluated on a grid
corresponding to a function of maximum spherical harmonic degree
\f[C]lmaxin\f[].
This is calculated by a call to \f[C]MakeGridDH\f[] and must contain the
degree\-0 average radius of the interface.
.RS
.RE
.TP
.B \f[C]nmax\f[] : integer
The maximum order used in the Taylor\-series expansion used in
calculating the potential coefficients.
.RS
.RE
.TP
.B \f[C]mass\f[] : float
The mass of the planet in kg.
.RS
.RE
.TP
.B \f[C]r0\f[] : float
The reference radius of the Bouguer anomaly \f[C]ba\f[].
.RS
.RE
.TP
.B \f[C]rho\f[] : float, dimension (2*\f[C]lmaxin\f[]+2, \f[C]sampling\f[]*(2*\f[C]lmaxin\f[]+2))
The density contrast of the relief in kg/m^3, with the same dimensions
as \f[C]grid\f[].
.RS
.RE
.TP
.B \f[C]filtertype\f[] : optional, integer, default = 0
Apply a filter when calculating the relief in order to minimize the
destabilizing effects of downward continuation which amplify
uncertainties in the Bouguer anomaly.
If 0, no filtering is applied.
If 1, use the minimum amplitude filter \f[C]DownContFilterMA\f[].
If 2, use the minimum curvature filter \f[C]DownContFilterMC\f[].
.RS
.RE
.TP
.B \f[C]filterdeg\f[] : optional, integer, default = 0
The spherical harmonic degree for which the filter is 0.5.
.RS
.RE
.TP
.B \f[C]lmax\f[] : optional, integer, default = \f[C]lmaxin\f[]
The spherical harmonic bandwidth of the input relief \f[C]grid\f[],
which determines the dimensions of \f[C]grid\f[].
If \f[C]lmaxcalc\f[] is not set, this determines also the maximum
spherical harmonic degree of the output spherical harmonic coefficients
of the relief and the input spherical harmonics of the Bouguer anomaly.
.RS
.RE
.TP
.B \f[C]lmaxcalc\f[] : optional, integer, default = \f[C]lmax\f[]
The maximum degree that will be calculated in the spherical harmonic
expansions.
.RS
.RE
.TP
.B \f[C]sampling\f[] : optional, integer, default set by dimensions of \f[C]grid\f[]
If 1 the output grids are equally sampled (\f[C]n\f[] by \f[C]n\f[]).
If 2, the grids are equally spaced (\f[C]n\f[] by 2\f[C]n\f[]).
.RS
.RE
.SH Description
.PP
\f[C]BAtoHilmRhoHDH\f[] is used to solve iteratively for the relief
along an interface with lateral variations in density that corresponds
to a given Bouguer anomaly.
This is equation 18 of Wieczorek and Phillips (1998), modified to
account for density variations as in equation 30 of Wieczorek 2007,
which implicitly takes into consideration the finite\-amplitude
correction.
Each iteration takes as input a guess for the relief and outputs the
iteratively improved spherical harmonic coefficients of this relief.
These coefficients can then be re\-expanded and re\-input into this
routine as the next guess.
For the initial guess, it is often sufficient to use the relief
predicted using the first\-order "mass sheet" approximation.
The input relief \f[C]grid\f[] can be of one of three type specified by
\f[C]gridtype\f[]: 1 for Gauss\-Legendre grids, 2 for equally sampled
Driscoll\-Healy grids (\f[C]n\f[] by \f[C]n\f[]), and 3 for equally
spaced Driscoll\-Healy grids (\f[C]n\f[] by 2\f[C]n\f[]).
.PP
If the algorithm does not converge, one might want to try damping the
initial estimate.
Alternatively, iterations of the following form have proven successfulin
in damping oscilations between successive iterations:
.PP
\f[C]h3\ =\ (h2+h1)/2\f[]
.PD 0
.P
.PD
\f[C]h4\ =\ f(h3)\f[]
.PP
It is important to understand that as an intermediate step, this routine
calculates the spherical harmonic coefficients of the density multiplied
by the relief raised to the nth power.
As such, if the input function is bandlimited to degree \f[C]L\f[], the
resulting function will thus be bandlimited to degree \f[C]L*nmax\f[].
This subroutine implicitly assumes that \f[C]lmax\f[] is greater than or
equal to \f[C]L*nmax\f[].
If this is not the case, then aliasing will occur.
In practice, for accurate results, it is found that \f[C]lmax\f[] needs
only to be about twice the size of \f[C]L\f[], though this should be
verified for each application.
Thus, if the input function is considered to be bandlimited to degree
\f[C]L\f[], the function should be evaluated on a grid corresponding to
a maximum degree of about \f[C]2L\f[].
.PP
This routine uses geodesy 4\-pi normalized spherical harmonics that
exclude the Condon\-Shortley phase; This can not be modified.
.SH References
.PP
Wieczorek, M.
A.
and R.
J.
Phillips, Potential anomalies on a sphere: applications to the thickness
of the lunar crust, J.
Geophys.
Res., 103, 1715\-1724, 1998.
.SH See also
.PP
batohilm, cilmplusdh, cilmplusrhohdh, shexpanddh, makegriddh,
downcontfilterma, downcontfiltermc