Skip to content

utils

Utility functions.

Attributes

SOUNDSPEED module-attribute 

SOUNDSPEED = 343.0

Speed of sound in air.

Functions

mean_tl 

mean_tl(tl, surfaces)

Mean tl.

Source code in acoustic_toolbox/utils.py 
12
13
14
15
16
17
18
19
def mean_tl(tl, surfaces):
    """Mean tl."""
    try:
        tau_axis = tl.ndim - 1
    except AttributeError:
        tau_axis = 0
    tau = 1.0 / (10.0 ** (tl / 10.0))
    return 10.0 * np.log10(1.0 / np.average(tau, tau_axis, surfaces))

wavelength 

wavelength(freq: ndarray, c: float = SOUNDSPEED) -> ndarray

Wavelength for one or more frequencies.

Source code in acoustic_toolbox/utils.py 
22
23
24
def wavelength(freq: np.ndarray, c: float = SOUNDSPEED) -> np.ndarray:
    """Wavelength for one or more frequencies."""
    return c / freq

w 

w(freq: ndarray) -> ndarray

Angular frequency for one o more frequencies.

Source code in acoustic_toolbox/utils.py 
27
28
29
def w(freq: np.ndarray) -> np.ndarray:
    """Angular frequency for one o more frequencies."""
    return 2.0 * np.pi * freq

_is_1d 

_is_1d(given: ndarray)

Check if the given object is a 1D array.

Source code in acoustic_toolbox/utils.py 
32
33
34
35
36
37
38
39
40
41
def _is_1d(given: np.ndarray):
    """Check if the given object is a 1D array."""
    if isinstance(given, (int, float)):
        return given
    elif given.ndim == 1:
        return np.array([given])
    elif given.ndim == 2 and given.shape[0] == 1:
        return given[0]
    else:
        return given