Changelog

Unreleased changes (available on the dev branch)

Added

Changed

  • The ninja HD and UHD cap coordinates were changed from a right-handed to a left-handed coordinate system, by Nils Harmening. (#110)

  • Changed the names of several motion correction algorithms from motion_correct.motion_correct_X to motion_correct.X. Argument names were made PEP8 compliant. The example 22_motion_artefacts_and_correction was improved. By Eike Middell.

Deprecated

Removed

Fixed

  • Fixed a bug in motion_correct_wavelet affecting the selection of coefficients for IQR-based thresholding. The issue caused unintended suppression of high-frequency components, particularly near the end of recordings. Changed by Eike Middell.

  • Fixed a bug in the stopping criterion of motion_correct.pca_recurse caused by an inverted boolean mask of motion artifacts, by Eike Middell.

Version 25.1.0 (2025-06-22)

All dependencies have been updated to recent versions. Please rebuild the environment.

New Features:

  • Added Schaefer atlas-based parcel labels for ICBM152 and Colin27 head models via FreeSurfer surface mapping, by Shakiba Moradi.

  • Spatial and measurement noise regularization options in image reconstruction, by David Boas. (#86)

  • Improved import of optode and electrode coordinates, by Nils Harmening. (#95)

  • The interfaces for the fluence and sensitivity computations were changed to allow out-of-core computations, by Eike Middell.

  • Precomputed sensitivities for all example datasets, including the ninjaCap whole head probe, are availabe in cedalion.datasets, by Eike Middell.

  • Make all example notebooks run on Google Colab integration, by Josef Cutler. (#96)

  • Added functionality to add synthetic HRFs to resting state data, by Thomas Fischer. (#77)

  • Added functionality to add synthetic artifacts to fNIRS data , by Josef Cutler.

  • Added AMPD algorithm for heart beat detection from [SBW12], by Isa Musisi.

  • Functionality for global physiology removal, by Alexander von Lühmann. (#106)

  • Multimodal source decomposition methods, including most CCA variants, by Tomas Codina. (#102)

  • The interface to fit GLMs changed. The GLM solver is now based on statsmodels and we integrated the AR-IRLS algorithm, by Ted Huppert and Eike Middell. (#68)

  • Added wavelet motion correction from [], by Josef Cutler. (#72)

  • New multi-view animated image reconstruction plots, by David Boas and Alexander von Lühmann.

  • Thresholding and visualizing probe sensitivity to brain parcels, by Alexander von Lühmann.

  • Improvements to the time-series plots, by David Boas. (#85, #108)

Bugfixes:

Version 25.0.0 (2025-01-21)