API Reference

This section documents the API of crowsetta.

Core

This section documents the core API of crowsetta, including data types, other classes, and modules.

Data types

Annotation

crowsetta.Annotation(annot_path[, ...])

A class to represent annotations for a single file.

Sequence

crowsetta.Sequence(segments, labels[, ...])

A class that represents a sequence of segments, used to annotate animal acoustic communication.

Segment

crowsetta.Segment(label[, onset_s, ...])

A class that represents a segment of a time series, used to annotate animal communication.

BBox

crowsetta.BBox(onset, offset, low_freq, ...)

A class that represents a bounding box on a spectrogram, drawn around animal communication or other sounds.

Classes

Transcriber

crowsetta.Transcriber(format)

The crowsetta.Transcriber class provides a way to work with all annotation formats in crowsetta, without needing to know the names of classes that represent formats (e.g., crowsetta.formats.seq.AudSeq or crowsetta.formats.bbox.Raven.)

Modules

crowsetta.interface

For complete documentation of the interface, please see this page.

crowsetta.interface

This module declares the interface for any class that represents annotations for animal communication sounds loaded from a file in a specific format.

typing

crowsetta.typing

Module for type hinting that is specific to crowsetta

validation

crowsetta.validation

Module with functions for data validation.

Decorators

crowsetta.register_format

crowsetta.register_format(format_class)

Decorator to register annotation formats.

Example data

crowsetta.example(name[, return_path])	Get an example annotation file.
crowsetta.examples.show()	Print the names and descriptions of all example annotation files built into crowsetta

Formats

This section documents the API of the :mod:crowsetta.formats module. It is generated automatically. If you are a crowsetta user looking for more detail about the built-in formats, please see: Formats.

crowsetta.formats
crowsetta.formats.bbox
crowsetta.formats.seq

Interface

The section documents the API of the :mod:crowsetta.interface module.

crowsetta.interface

This module declares the interface for any class that represents annotations for animal communication sounds loaded from a file in a specific format.

Base

crowsetta.interface.base.BaseFormat()

An abstract base class that declares the interface for any sub-class that represents annotations loaded from a file in a specific format for annotating vocalizations.

Sequence-Like

crowsetta.interface.seq.SeqLike()

An abstract base class defining the interface for any annotation format that can be represented as a sequence of segments, with each segment having an onset time, offset time, and a label.

Bounding Box-Like

crowsetta.interface.bbox.BBoxLike()

An abstract base class defining the interface for any annotation format that can be represented as a set of labeled bounding boxes.