soundscapecode 0.0.1

Python implementation of soundscapecode

SoundScapeCode

Python implementation of the soundscape code [1], ported from a Matlab example [2].

Installation

pip install soundscapecode

Usage

Values can be calculated individually:

import soundscapecode as ssc

fs = 48000
mock_sound = np.random.rand(fs*60, 1)
periodicity = ssc.periodicity(mock_sound, fs)

Or to calculate all values for one recording:

from soundscapecode import SoundscapeCode

fs = 48000
n_mins = 3
mock_sound = np.random.rand(fs*n_mins*60, 1)
soundscape = SoundscapeCode(mock_sound, fs)
for dt in soundscape["dt"]:
    print(dt)

Testing

Testing has been conducted against the values produced in the Matlab version. To run the tests, export the broad, fish, and invertebrate variables to csv and add them to the data folder, as well as the output file.

Limitations

Spectral dissimilarity and, therefore, dissimilarity are not currently implemented.

Contact

Please contact me with any questions

References

[1] Dylan Wilford, Jennifer Miksis-Olds, Bruce Martin, Kim Lowell; Introduction and application of a proposed method for quantitative soundscape analysis: The soundscape code. J. Acoust. Soc. Am. 1 April 2021; 149 (4_Supplement): A72. https://doi.org/10.1121/10.0004555
[2] https://www.mathworks.com/matlabcentral/fileexchange/172434-sscmetrics-a-matlab-tool-to-compute-the-soundscape-code