neuroinformatics-unit/movement: v0.1.0

The graphical user interface (GUI) is here!

This is the first release including our napari plugin, which we'll gradually develop into a fully fledged GUI for movement. We have been working on a minimal version of this plugin for a while and are happy to share it with the world with this release.

Read this guide on how to use it.

• Minimal viable version of the movement plugin for napari. by @niksirbi in https://github.com/neuroinformatics-unit/movement/pull/450
• Fix: remove NaN points before passing to points layer by @sfmig in https://github.com/neuroinformatics-unit/movement/pull/465

Regions of interest and spatial navigation

This chunk of work was spearheaded by @willGraham01 and includes many goodies for analysing tracking data in relation to user-defined regions of interest. Stay tuned for more to come in the next releases.

• Introduce decorator for broadcasting 1D methods by @willGraham01 in https://github.com/neuroinformatics-unit/movement/pull/397
• add point_is_inside to BaseRegionOfInterest by @stellaprins in https://github.com/neuroinformatics-unit/movement/pull/413
• Fix compute_signed_angle_2d using 2D boolean indexing by @willGraham01 in https://github.com/neuroinformatics-unit/movement/pull/432
• Add functionality for computing ego- and allocentric angles to RoIs by @willGraham01 in https://github.com/neuroinformatics-unit/movement/pull/416
• Remove toggles for signed angle computations by @willGraham01 in https://github.com/neuroinformatics-unit/movement/pull/445

Quick plots

Mostly thanks to @stellaprins, movement now includes a plots submodule, currently offering two functions for quickly visualising trajectories and occupancy heatmaps.

• Plotting wrappers: Head Trajectory by @stellaprins in https://github.com/neuroinformatics-unit/movement/pull/394
• Plotting Wrappers: Occupancy Histogram by @willGraham01 in https://github.com/neuroinformatics-unit/movement/pull/403
• Use plot_trajectory in broadcasting example by @willGraham01 in https://github.com/neuroinformatics-unit/movement/pull/414
• Sp/417 bug fix plot trajectory by @stellaprins in https://github.com/neuroinformatics-unit/movement/pull/425
• Rename plot_trajectory --> plot_centroid_trajectory by @sfmig in https://github.com/neuroinformatics-unit/movement/pull/474

New and overhauled examples

Many of our examples were updated in this release, but we'd like to draw special attention to the ones on pupil tracking and head direction. Our more advanced users may appreciate the new example on broadcasting functions along data dimensions.

• Eye movement example by @stellaprins in https://github.com/neuroinformatics-unit/movement/pull/429
• Reframe polar coordinates example around head direction by @niksirbi in https://github.com/neuroinformatics-unit/movement/pull/426
• Introduce decorator for broadcasting 1D methods by @willGraham01 in https://github.com/neuroinformatics-unit/movement/pull/397

Housekeeping

As usual, it takes lots of work to keep the lights on. We'd like to draw particular attention to two changes that may impact users:

1. We've updated the supported Python versions to 3.11 - 3.13
2. The print_report parameter now defaults to False for all functions in the movement.filtering module.

• Tiny fix in docstrings for configure_logging by @sfmig in https://github.com/neuroinformatics-unit/movement/pull/411
• replace xarray median and mean with numpy by @Kasra-Shirvanian in https://github.com/neuroinformatics-unit/movement/pull/419
• Clarify error raised by ValidHDF5 by @niksirbi in https://github.com/neuroinformatics-unit/movement/pull/424
• Update Python versions to adhere to SPEC 0 by @adamltyson in https://github.com/neuroinformatics-unit/movement/pull/442
• Remove Intel Macs from CI workflow by @niksirbi in https://github.com/neuroinformatics-unit/movement/pull/449
• Add make docs note for PowerShell users by @lochhh in https://github.com/neuroinformatics-unit/movement/pull/430
• Use raw string for regex by @lochhh in https://github.com/neuroinformatics-unit/movement/pull/452
• Set print_report to False by default in filtering functions by @Ishaan0132 in https://github.com/neuroinformatics-unit/movement/pull/456
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/neuroinformatics-unit/movement/pull/460
• Update test_and_deploy.yml to remove nodefaults conda channel by @sfmig in https://github.com/neuroinformatics-unit/movement/pull/462

New Contributors

• @Kasra-Shirvanian made their first contribution in https://github.com/neuroinformatics-unit/movement/pull/419
• @Ishaan0132 made their first contribution in https://github.com/neuroinformatics-unit/movement/pull/456

Full Changelog: https://github.com/neuroinformatics-unit/movement/compare/v0.0.23...v0.1.0