Skip to content

Commit

Permalink
improve sph_harm docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tomjnixon committed Dec 15, 2022
1 parent aee8888 commit f9960ba
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion ear/core/hoa.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,15 @@ def norm_FuMa(n, abs_m):


def sph_harm(n, m, az, el, norm=norm_SN3D):
"""Spherical harmonic function Y_n^m(az, el)."""
"""Spherical harmonic function Y_n^m(az, el).
azimuth and elevation are the same as used elsewhere in the ADM (azimuth is
measured left from the front; elevation is measured up from centre), except
in radians rather than degrees
this differs slightly from the definitions in BS.2076, where the elevation
is measured down from the top
"""
n, m, az, el = np.broadcast_arrays(n, m, az, el)
scale = np.ones_like(m, dtype=float)
select = m > 0
Expand Down

0 comments on commit f9960ba

Please sign in to comment.