Skip to content

Commit bff5737

Browse files
authored
Rename "elevation" to "colatitude" (#16)
1 parent 829d265 commit bff5737

File tree

3 files changed

+28
-28
lines changed

3 files changed

+28
-28
lines changed

examples/modal_beamforming_open_spherical_array.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ def dot_product_sph(v, u):
2222

2323

2424
# get quadrature grid (microphone positions) of order N
25-
azi, elev, weights = micarray.modal.angular.grid_gauss(N)
25+
azi, colat, weights = micarray.modal.angular.grid_gauss(N)
2626
# get spherical harmonics matrix for sensors
27-
Y_p = micarray.modal.angular.sht_matrix(N, azi, elev, weights)
27+
Y_p = micarray.modal.angular.sht_matrix(N, azi, colat, weights)
2828
# get spherical harmonics matrix for a source ensemble of azimuthal plane waves
2929
Y_q = micarray.modal.angular.sht_matrix(N, azi_pwd, np.pi/2)
3030
# get radial filters
@@ -33,7 +33,7 @@ def dot_product_sph(v, u):
3333
D = micarray.modal.radial.diagonal_mode_mat(dn)
3434

3535
# compute microphone signals for an incident broad-band plane wave
36-
p = np.exp(1j * k[:, np.newaxis]*r * dot_product_sph((azi, elev), pw_angle))
36+
p = np.exp(1j * k[:, np.newaxis]*r * dot_product_sph((azi, colat), pw_angle))
3737
# compute the plane wave dcomposition
3838
A_pwd = np.matmul(np.matmul(Y_q, D), np.conj(Y_p.T))
3939
q_pwd = np.squeeze(np.matmul(A_pwd, np.expand_dims(p, 2)))

examples/modal_beamforming_rigid_spherical_array.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,18 @@
1515

1616

1717
# get quadrature grid (microphone positions) of order N
18-
azi, elev, weights = micarray.modal.angular.grid_gauss(N)
18+
azi, colat, weights = micarray.modal.angular.grid_gauss(N)
1919

2020
# pressure on the surface of a rigid sphere for an incident plane wave
2121
bn = micarray.modal.radial.spherical_pw(N, k, r, setup='rigid')
2222
D = micarray.modal.radial.diagonal_mode_mat(bn)
23-
Y_p = micarray.modal.angular.sht_matrix(N, azi, elev)
23+
Y_p = micarray.modal.angular.sht_matrix(N, azi, colat)
2424
Y_pw = micarray.modal.angular.sht_matrix(N, azi_pw, np.pi/2)
2525
p = np.matmul(np.matmul(Y_p, D), np.conj(Y_pw.T))
2626
p = np.squeeze(p)
2727

2828
# plane wave decomposition using modal beamforming
29-
Y_p = micarray.modal.angular.sht_matrix(N, azi, elev, weights)
29+
Y_p = micarray.modal.angular.sht_matrix(N, azi, colat, weights)
3030
# get SHT matrix for a source ensemble of azimuthal plane waves
3131
azi_pwd = np.linspace(0, 2*np.pi, 91, endpoint=False)
3232
Y_q = micarray.modal.angular.sht_matrix(N, azi_pwd, np.pi/2)

micarray/modal/angular.py

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
pass
1010

1111

12-
def sht_matrix(N, azi, elev, weights=None):
12+
def sht_matrix(N, azi, colat, weights=None):
1313
r"""Matrix of spherical harmonics up to order N for given angles.
1414
1515
Computes a matrix of spherical harmonics up to order :math:`N`
@@ -40,8 +40,8 @@ def sht_matrix(N, azi, elev, weights=None):
4040
Maximum order.
4141
azi : (Q,) array_like
4242
Azimuth.
43-
elev : (Q,) array_like
44-
Elevation.
43+
colat : (Q,) array_like
44+
Colatitude.
4545
weights : (Q,) array_like, optional
4646
Quadrature weights.
4747
@@ -52,7 +52,7 @@ def sht_matrix(N, azi, elev, weights=None):
5252
5353
"""
5454
azi = util.asarray_1d(azi)
55-
elev = util.asarray_1d(elev)
55+
colat = util.asarray_1d(colat)
5656
if azi.ndim == 0:
5757
Q = 1
5858
else:
@@ -63,7 +63,7 @@ def sht_matrix(N, azi, elev, weights=None):
6363
i = 0
6464
for n in range(N+1):
6565
for m in range(-n, n+1):
66-
Ymn[:, i] = weights * special.sph_harm(m, n, azi, elev)
66+
Ymn[:, i] = weights * special.sph_harm(m, n, azi, colat)
6767
i += 1
6868
return Ymn
6969

@@ -162,25 +162,25 @@ def grid_equal_angle(n):
162162
-------
163163
azi : array_like
164164
Azimuth.
165-
elev : array_like
166-
Elevation.
165+
colat : array_like
166+
Colatitude.
167167
weights : array_like
168168
Quadrature weights.
169169
"""
170170
azi = np.linspace(0, 2*np.pi, 2*n+2, endpoint=False)
171-
elev, d_elev = np.linspace(0, np.pi, 2*n+2, endpoint=False, retstep=True)
172-
elev += d_elev/2
171+
colat, d_colat = np.linspace(0, np.pi, 2*n+2, endpoint=False, retstep=True)
172+
colat += d_colat/2
173173

174-
weights = np.zeros_like(elev)
174+
weights = np.zeros_like(colat)
175175
p = np.arange(1, 2*n+2, 2)
176-
for i, theta in enumerate(elev):
176+
for i, theta in enumerate(colat):
177177
weights[i] = 2*np.pi/(n+1) * np.sin(theta) * np.sum(np.sin(p*theta)/p)
178178

179179
azi = np.tile(azi, 2*n+2)
180-
elev = np.repeat(elev, 2*n+2)
180+
colat = np.repeat(colat, 2*n+2)
181181
weights = np.repeat(weights, 2*n+2)
182182
weights /= n+1 # sum(weights) == 4pi
183-
return azi, elev, weights
183+
return azi, colat, weights
184184

185185

186186
def grid_gauss(n):
@@ -197,19 +197,19 @@ def grid_gauss(n):
197197
-------
198198
azi : array_like
199199
Azimuth.
200-
elev : array_like
201-
Elevation.
200+
colat : array_like
201+
Colatitude.
202202
weights : array_like
203203
Quadrature weights.
204204
"""
205205
azi = np.linspace(0, 2*np.pi, 2*n+2, endpoint=False)
206206
x, weights = np.polynomial.legendre.leggauss(n+1)
207-
elev = np.arccos(x)
207+
colat = np.arccos(x)
208208
azi = np.tile(azi, n+1)
209-
elev = np.repeat(elev, 2*n+2)
209+
colat = np.repeat(colat, 2*n+2)
210210
weights = np.repeat(weights, 2*n+2)
211211
weights *= np.pi / (n+1) # sum(weights) == 4pi
212-
return azi, elev, weights
212+
return azi, colat, weights
213213

214214

215215
def grid_equal_polar_angle(n):
@@ -248,8 +248,8 @@ def grid_lebedev(n):
248248
-------
249249
azi : array_like
250250
Azimuth.
251-
elev : array_like
252-
Elevation.
251+
colat : array_like
252+
Colatitude.
253253
weights : array_like
254254
Quadrature weights.
255255
@@ -273,5 +273,5 @@ def available_quadrature(d):
273273
if np.any(q.weights < 0):
274274
warn("Lebedev grid of order {} has negative weights.".format(n))
275275
azi = q.azimuthal_polar[:, 0]
276-
elev = q.azimuthal_polar[:, 1]
277-
return azi, elev, 4*np.pi*q.weights
276+
colat = q.azimuthal_polar[:, 1]
277+
return azi, colat, 4*np.pi*q.weights

0 commit comments

Comments
 (0)