API reference#

Information on specific functions, classes, and methods.

Modules

movement.filtering

Filter and interpolate tracks in movement datasets.

movement.io.load_bboxes

Load bounding boxes tracking data into movement.

movement.io.load_poses

Load pose tracking data from various frameworks into movement.

movement.io.save_poses

Save pose tracking data from movement to various file formats.

movement.kinematics

Compute kinematic variables like velocity and acceleration.

movement.napari.convert

Conversion functions from movement datasets to napari layers.

movement.napari.layer_styles

Dataclasses containing layer styles for napari.

movement.plots.occupancy

Wrappers for plotting occupancy data of select individuals.

movement.plots.trajectory

Wrappers to plot movement data.

movement.roi.base

Class for representing 1- or 2-dimensional regions of interest (RoIs).

movement.roi.conditions

Functions for computing condition arrays involving RoIs.

movement.roi.line

1-dimensional lines of interest.

movement.roi.polygon

2-dimensional regions of interest.

movement.sample_data

Fetch and load sample datasets.

movement.transforms

Transform and add unit attributes to xarray.DataArray datasets.

movement.utils.broadcasting

Broadcasting operations across xarray.DataArray dimensions.

movement.utils.logging

Logging utilities for the movement package.

movement.utils.reports

Utility functions for reporting missing data.

movement.utils.vector

Utility functions for vector operations.

movement.validators.arrays

Validators for data arrays.

movement.validators.datasets

attrs classes for validating data structures.

movement.validators.files

attrs classes for validating file paths.