Skip to main content

A Python tool to work with any format for annotating animal vocalizations and bioacoustics data

Project description



A Python tool to work with any format for annotating animal vocalizations and bioacoustics data

Build Status Documentation Status DOI PyPI version codecov

crowsetta provides a Pythonic way to work with annotation formats for animal vocalizations and bioacoustics data. These formats are used, for example, by applications that enable users to annotate audio and/or spectrograms. Such annotations typically include the times when sound events start and stop, and labels that assign each sound to some set of classes chosen by the annotator. crowsetta has built-in support for many widely used formats, such as Audacity label tracks, Praat .TextGrid files, and Raven .txt files.


example spectrogram showing Bengalese finch song with Praat TextGrid annotations indicated as segments underneath

Spectrogram of the song of a Bengalese finch with syllables annotated as segments underneath. Annotations parsed by crowsetta from a file in the Praat .TextGrid format. Example song from Bengalese finch song dataset, Tachibana and Morita 2021, adapted under CC-By-4.0 License.




example spectrogram from field recording with Raven annotations of birdsong indicated as rectangular bounding boxes

Spectrogram of a field recording with annotations of songs of different bird species indicated as bounding boxes. Annotations parsed by crowsetta from a file in the Raven Selection Table format. Example song from "An annotated set of audio recordings of Eastern North American birds containing frequency, time, and species information", Chronister et al., 2021, adapted under CC0 1.0 License.


Who would want to use crowsetta? Anyone that works with animal vocalizations or other bioacoustics data that is annotated in some way. Maybe you are a neuroscientist trying to figure out how songbirds learn their song, or why mice emit ultrasonic calls. Or maybe you're an ecologist studying dialects of finches distributed across Asia, or maybe you are a linguist studying accents in the Caribbean, or a speech pathologist looking for phonetic changes that indicate early onset Alzheimer's disease. crowsetta makes it easier for you to work with your annotations in Python, regardless of the format.

Features

  • take advantage of built-in support for many widely used formats, such as Audacity label tracks, Praat .TextGrid files, and Raven .txt files.
  • work with any format by remembering just one class:
    annot = crowsetta.Transcriber(format='format').from_file('annotations.ext')
    • no need to remember different functions for different formats
  • when needed, use classes that represent the formats to write readable scripts and libraries
  • convert annotations to common file formats like .csv that anyone can work with
  • work with custom formats that are not built in to crowsetta by writing simple classes, leveraging abstractions that can represent a wide array of annotation formats

For examples of these features, please see: https://crowsetta.readthedocs.io/en/latest/index.html#features

Getting Started

Installation

with pip

$ pip install crowsetta

with conda

$ conda install crowsetta -c conda-forge

Usage

If you are new to crowsetta, start with tutorial.

For vignettes showing how to use crowsetta for various tasks, such as working with your own annotation format, please see the how-to section.

Project Information

Background

crowsetta was developed for two libraries:

Support

To report a bug or request a feature (such as a new annotation format), please use the issue tracker on GitHub:
https://github.com/vocalpy/crowsetta/issues

To ask a question about crowsetta, discuss its development, or share how you are using it, please start a new topic on the VocalPy forum with the crowsetta tag:
https://forum.vocalpy.org/

Contribute

CHANGELOG

You can see project history and work in progress in the CHANGELOG

License

The project is licensed under the BSD license.

Citation

If you use crowsetta, please cite the DOI: DOI

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

crowsetta-4.0.0.post2.tar.gz (3.5 MB view details)

Uploaded Source

Built Distribution

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

crowsetta-4.0.0.post2-py3-none-any.whl (125.8 kB view details)

Uploaded Python 3

File details

Details for the file crowsetta-4.0.0.post2.tar.gz.

File metadata

  • Download URL: crowsetta-4.0.0.post2.tar.gz
  • Upload date:
  • Size: 3.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.27.1

File hashes

Hashes for crowsetta-4.0.0.post2.tar.gz
Algorithm Hash digest
SHA256 c2795ff339d662bc8d07873199f902210ff980b29a4db04672433867cf3e1df6
MD5 f865492a8e175b1c609aa57979d51bd1
BLAKE2b-256 1effa8de97763fd6c14b041f0246bf13bb0b2cf8210b405976cb77cdd2cb3f8b

See more details on using hashes here.

File details

Details for the file crowsetta-4.0.0.post2-py3-none-any.whl.

File metadata

File hashes

Hashes for crowsetta-4.0.0.post2-py3-none-any.whl
Algorithm Hash digest
SHA256 255cfb972ab1749f81424fcdffc314e52f17e887a2f616ef0b0174c7a0bf1f54
MD5 3d22d55c4bbe1236792224d5f7664be9
BLAKE2b-256 8ab9b2628aad531b8412f06682aa94f422a42c55ecbff0b0007d3a21aeca14c8

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