Skip to main content

A program for detecting chimpanzee drumming in long-term rainforest recordings

Project description

Chimpanzee Drumming Detector

This is a python program for detecting chimpanzee drumming in long-term rainforest recordings.

The associated publication can be read at:

This program only contains the test pipeline, not the training pipeline.

Installation

Either install the latest stable release from PyPI

pip install ChimpDrummingDetector

Alternatively, you can install this package through to code on this repository. Simply download this repository as a zip, and then do:

cd path/to/downloaded/zip
unzip ChimpDrummingDetector.zip
cd ChimpDrummingDetector
pip install ChimpDrummingDetector

Usage

In your python code, do

import chimp_detector

path_to_wave_to_analyze = path/to/wave.wav 
detection_result = chimp_detector.detect_drumming(path_to_wave_to_analyze)
  • Input: A wave file. Might be mono or stereo
  • Output: A pandas dataframe with following columns
    • timepoints_in_seconds [float]: The analyzed timepoints
    • drumming_probability [float]: Probability of chimpanzee drumming in range [0,1] for the respective timepoint
    • drumming_binarized [boolean]: Binarization of probability with threshold 0.5, where TRUE means "there is drumming in this frame".

Dependencies

This Packages requires:

  • Python version 3.8
  • librosa==0.8.0
  • tensorflow==2.3.1
  • pandas==1.1.2
  • numpy==1.18.5

Citation

Please cite this paper in your publication if you use this program for your research.

@article{anders2021compensating,
  title={Compensating class imbalance for acoustic chimpanzee detection with convolutional recurrent neural networks},
  author={Anders, Franz and Kalan, Ammie K and K{\"u}hl, Hjalmar S and Fuchs, Mirco},
  journal={Ecological Informatics},
  volume={65},
  pages={101423},
  year={2021},
  publisher={Elsevier}
  }

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ChimpDrummingDetector-0.0.3.tar.gz (3.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ChimpDrummingDetector-0.0.3-py3-none-any.whl (3.3 MB view details)

Uploaded Python 3

File details

Details for the file ChimpDrummingDetector-0.0.3.tar.gz.

File metadata

  • Download URL: ChimpDrummingDetector-0.0.3.tar.gz
  • Upload date:
  • Size: 3.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.10

File hashes

Hashes for ChimpDrummingDetector-0.0.3.tar.gz
Algorithm Hash digest
SHA256 49e9165b7c17680514f438909e99fbc950ffe514b071d79ce8685f23bd941948
MD5 4f4bda4334d795fad54e91f346479125
BLAKE2b-256 8e22294272632b374f8bc03c57029707b776eb093ef89a200f7b058846861121

See more details on using hashes here.

File details

Details for the file ChimpDrummingDetector-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: ChimpDrummingDetector-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 3.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.10

File hashes

Hashes for ChimpDrummingDetector-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 195a1db6633c8e869d8f9825aee4c34bd13525cb321c1392ce955599ed92c73d
MD5 890b48801334d2dadb3cab999191b48d
BLAKE2b-256 b8ad1c59b1b34e1782ce04176fe53deb90bc1cbfe6c5c7712b9df0a0588117d4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page