Skip to content

Ambisonics

Functions

acn 

acn(
    order: int = 1,
) -> Generator[Tuple[int, int], None, None]

Spherical harmonic degree n and order m for ambisonics order order.

Follows ACN.

ACN n m letter
0 0 0 W
1 1 -1 Y
2 1 0 Z
3 1 +1 X
PARAMETER DESCRIPTION
order

Ambisonics order.

TYPE: int DEFAULT: 1

YIELDS DESCRIPTION
Tuple[int, int]

Tuple[int, int]: Degree n and order m.
Source code in acoustic_toolbox/ambisonics.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
def acn(order: int = 1) -> Generator[Tuple[int, int], None, None]:
    """Spherical harmonic degree `n` and order `m` for ambisonics order `order`.

    Follows ACN.

    | ACN | n | m  | letter |
    |-----|---|----|--------|
    | 0   | 0 | 0  | W      |
    | 1   | 1 | -1 | Y      |
    | 2   | 1 | 0  | Z      |
    | 3   | 1 | +1 | X      |

    Args:
        order: Ambisonics order.

    Yields:
        Tuple[int, int]: Degree `n` and order `m`.
    """
    for n in range(order + 1):
        for m in range(-n, n + 1):
            yield (n, m)

sn3d 

sn3d(
    m: int | NDArray[int_], n: int | NDArray[int_]
) -> NDArray[float64]

SN3D or Schmidt semi-normalisation.

See http://en.wikipedia.org/wiki/Ambisonic_data_exchange_formats#SN3D

PARAMETER DESCRIPTION
m

Order n

TYPE: int | NDArray[int_]

n

Degree m

TYPE: int | NDArray[int_]

RETURNS DESCRIPTION
NDArray[float64]

NDArray[np.float64]: The SN3D normalization coefficients.
Source code in acoustic_toolbox/ambisonics.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
def sn3d(m: int | NDArray[np.int_], n: int | NDArray[np.int_]) -> NDArray[np.float64]:
    """SN3D or Schmidt semi-normalisation.

    See [http://en.wikipedia.org/wiki/Ambisonic_data_exchange_formats#SN3D](http://en.wikipedia.org/wiki/Ambisonic_data_exchange_formats#SN3D)

    Args:
        m: Order `n`
        n: Degree `m`

    Returns:
        NDArray[np.float64]: The SN3D normalization coefficients.
    """
    m = np.atleast_1d(m)
    n = np.atleast_1d(n)

    d = np.logical_not(m.astype(bool))
    out = np.sqrt(
        (2.0 - d)
        / (4.0 * np.pi)
        * scipy.special.factorial(n - np.abs(m))
        / scipy.special.factorial.factorial(n + np.abs(m))
    )
    return out

n3d 

n3d(
    m: int | NDArray[int_], n: int | NDArray[int_]
) -> NDArray[float64]

N3D or full three-D normalisation.

See http://en.wikipedia.org/wiki/Ambisonic_data_exchange_formats#N3D

PARAMETER DESCRIPTION
m

Order n

TYPE: int | NDArray[int_]

n

Degree m

TYPE: int | NDArray[int_]

RETURNS DESCRIPTION
NDArray[float64]

NDArray[np.float64]: The N3D normalization coefficients.
Source code in acoustic_toolbox/ambisonics.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
def n3d(m: int | NDArray[np.int_], n: int | NDArray[np.int_]) -> NDArray[np.float64]:
    """N3D or full three-D normalisation.

    See [http://en.wikipedia.org/wiki/Ambisonic_data_exchange_formats#N3D](http://en.wikipedia.org/wiki/Ambisonic_data_exchange_formats#N3D)

    Args:
        m: Order `n`
        n: Degree `m`

    Returns:
        NDArray[np.float64]: The N3D normalization coefficients.
    """
    n = np.atleast_1d(n)
    return sn3d(m, n) * np.sqrt(2 * n + 1)

:::