Core

This page 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.data

crowsetta.data.data

Note

Modules in crowsetta.data besides crowsetta.data.data contain example data files and a citation, e.g., crowsetta.data.birdsongrec contains an example file Annotation.xml and citation.txt. For that reason just crowsetta.data.data is shown.

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.