soundscapecode.SoundscapeCode

class soundscapecode.SoundscapeCode(sound: ndarray, fs: int, freq_range=None)

Wrapper for segmenting and calculating soundscape code metrics for a sound.

Attributes

sound: np.ndarray

the given sound recording from which the metrics were calculated

fs: int

sampling frequency for the sound

freq_range: tuple

frequency range for spectral dissimilarity, if given

Lppk: list

Peak SPL values at one-minute intervals

Lprms: list

Root mean squared SPL values at one-minute intervals

kurtosis: list

kurtosis values at one-minute intervals

periodicity: list

periodicity values at one-minute intervals

temporal_dissimilarities: list

temporal dissimilarities between consecutive one-minute intervals

spectral_dissimilarities: list

spectral dissimilarities between consecutive one-minute intervals

spectral_dissimilarities: list

spectral dissimilarities between consecutive one-minute intervals

dissimilarities: list

dissimilarity index between consecutive one-minute intervals

Examples

>>> import numpy as np
>>> from soundscapecode import SoundscapeCode
>>> fs = 48000
>>> n_mins = 3
>>> sound = np.random.rand(fs*n_mins*60,1)
>>> soundscape = SoundscapeCode(sound, fs)
>>> for pk_spl in soundscape["max_spl"]:
...    print(pk_spl)
-2.786002960850315e-06
-6.53336810900092e-06
-7.38333472594301e-06