v0.3.0

Release Notes: ASLTK v0.3.0

Overview

Version v0.3.0 introduces several enhancements, bug fixes, and new functionalities to improve the ASLTK library. This release focuses on rigid body registration, head movement correction, and improved support for multi-dimensional ASL data. Additionally, new unit tests, documentation updates, and codebase refinements enhance the library’s reliability and usability.

---

🚀 New Features

Rigid Body Registration & Head Movement Correction

• Implemented rigid body registration and head movement correction for ASL data.
  Commit: 67c4a4f
• Added unit tests for these functions to ensure accuracy and robustness.
  Commit: 24a0d58

Isotropic Gaussian Smoothing

• Implemented an isotropic Gaussian smoothing function for multi-dimensional data.
  Commit: f7719fe
• Added unit tests to validate the function’s behavior.
  Commit: a00685a

Data Handling Enhancements

• Updated set_image method to accept both image paths and numpy arrays, increasing flexibility.
  Commit: 85992f3
• Added collect_data_volumes function to separate 3D volumes from 4D and 5D data.
  Commit: f6aa17c
• Unit tests added for collect_data_volumes to ensure robustness.
  Commit: dd95494

MultiTE ASL Mapping

• Added get_t1blgm_map method to retrieve T1blGM maps from MultiTE_ASLMapping objects.
  Commit: 6613bd0
• Implemented unit tests for get_t1blgm_map to validate its accuracy.
  Commit: 1b8c340

ASL Image Generation

• New script for ASL image generation using the Hadamard MRI imaging acquisition strategy.
  Commit: e6febdd

---

🛠️ Enhancements

• Improved verbosity output for the generate_subtracted_asl_image script.
  Commit: 365033d
• Disabled warnings in pytest for cleaner test output.
  Commit: 73d8cfb
• Reorganized the utils module and introduced a new dynamic_signal module.
  Commit: ebf5728

---

📖 Documentation Updates

• Expanded the documentation with new script sections:
  • generate_subtracted_asl_image script.
    Commit: c2c24b0
  • multi_te ASL script.
    Commit: d189368
  • cbf script.
    Commit: e53a881
• Updated collect_data_volumes documentation to clarify the original shape of the data.
  Commit: 72ee8f8

---

🐛 Bug Fixes

• Fixed import paths for dynamic ASL models in tests and scripts.
  Commits: 5806549, 6a8820b

---

🔧 Codebase Improvements

• Refactored whitespace in test_reconstruction.py for improved readability.
  Commit: 1720b8c
• Updated .gitignore to exclude VSCode configuration files.
  Commit: e5069bc

---

🎉 Special Thanks

A big thank you to our contributors for their valuable work in making ASLTK v0.3.0 a success:

• @acsenrafilho
• @LOAMRI

Your contributions are greatly appreciated! 🚀👏

---

📥 Upgrade Instructions

1. Update ASLTK to v0.3.0:

   pip install asltk --upgrade

2. Check out the updated documentation for guidance on using the new features.

Enjoy the latest version and happy coding! 🎯

v0.2.0

Release Notes: Version v0.2.0

Overview

This release introduces several enhancements, bug fixes, and new features, significantly improving the library's functionality and usability. Key updates include added support for BIDS input format, enhancements to data saving/loading methods, and resolution of critical bugs.

---

🚀 New Features

BIDS Input Support

• Added support for loading BIDS-compliant input folders.
  Commit: d34a2db

  • Introduced methods to parse and process imaging data from BIDS folders.
  • Enhanced library dependency with pybids.

• New sample data and README for BIDS format.
  Commit: 0927300

File Format Enhancements

• Improved dw_asl script to include file format options.
  Commit: 03fcf71

• Image file format patterns added in the asltk module.
  Commit: 1f826eb

• Save and load methods added for the ASLData object.
  Commit: 323abf7

Developer Tools

• .vscode added to .gitignore.
  Commit: 877c3c0

• Updates to the poetry.lock file.
  Commit: b2ac1e2

---

🐛 Bug Fixes

Critical Fixes

• Fixed errors in saving compressed NIfTI files.
  Commit: c6401bb, cfc544b
  Issue: #16

• Adjusted doctests and docstrings for improved clarity and accuracy.
  Commit: 345d5e3, 1e73ade

• Fixed usage of temporary folders in tests.
  Commit: 97d4579

---

📝 Documentation Updates

• More information about calling asltk scripts on the Getting Started page.
  Commit: 589e1f0

• Encouraged developers with additional guidance in documentation.
  Commit: 2068a20

---

🛠️ Enhancements

• Reorganized the reconstruction module while maintaining API consistency.
  Commit: dc4cddb

• Progress bar improvements for CBF and MultiTE processing.
  Commit: 248866f

• Removed unnecessary imports in the ASLData module.
  Commit: b7bcaf2

---

🔒 Issues Resolved

• #16: Saving compressed NIfTI files throws an error in cbf.py.
• #13: Added support for BIDS input format.
• #11: Save image data for external sharing/loading.

---

Commit Summary

Commit	Type	Description
8f99849	ENH	New release v0.2.0
97d4579	BUG	Fix test using tmp folder
345d5e3	BUG	Fix docstring line 140 in utils.py
1e73ade	BUG	Fix doctest in utils.py module
0927300	ENH	Add new sample data (BIDS README)
2068a20	DOC	More encouragement for developers
1f826eb	ENH	Add image file format patterns
f04b1a5	ENH	Add pybids as dependency
d34a2db	ENH	Load BIDS input folder
6bef204	ENH	Add more test data (BIDS format)
03fcf71	ENH	Improve dw_asl script file format options
b7bcaf2	ENH	Remove unnecessary imports in ASLData
323abf7	ENH	Add load/save methods for ASLData
589e1f0	DOC	Add script info in Getting Started
dc4cddb	ENH	Reorganize reconstruction module
877c3c0	ENH	Add .vscode in .gitignore
b2ac1e2	ENH	Update poetry lock file
248866f	ENH	Improve progress bar for processing
cfc544b	BUG	Fix save error in multiTE script
c6401bb	BUG	Fix save error in CBF script

---

Contributors

Special thanks to all contributors who helped make this release possible! 🎉

---

Upgrade Instructions

1. Update the package using your package manager of choice.

   pip install asltk --upgrade

2. For detailed usage instructions, check the documentation.

Enjoy this release, and feel free to provide feedback or open issues for suggestions!

v0.1.5

528df2d (HEAD -> main, tag: v0.1.5, origin/main) Update version to v0.1.5

ENH

246bd55 Merge pull request #17 from LOAMRI/develop
74f548a ENH: Increase code coverage (utils module)
a5ad9e7 ENH: Add support for multiprocess CPU thread for MultiTEMapping class
dd49e5d ENH: Add limitation to cores values to avoid multithreading overhead
dc8b8f7 ENH: Add test to avoid overhead of multithreading
cd2608d ENH: Add multiprocess (CPU Threading) for the CBFMapping class
8a34905 ENH: Add test for single core execution (CBF Mapping)
097b463 ENH: Apply multiprocessing for CBF/ATT mapping class

DOC

2c4b105 DOC: Improve documentation at Getting Started section
ee13a9c DOC: Removing the automatic assigment to issue templates

STYLE

a84f18a STYLE: Changed output format to NRRD for cbf.py script

v0.1.4

What's Changed

• Develop by @acsenrafilho in #8
• Develop to Main by @acsenrafilho in #9

Full Changelog: v0.1.2...v0.1.4

v0.1.2

What's Changed

• Merge Develop to Main by @acsenrafilho in #2

Full Changelog: v0.1.1...v0.1.2

v0.1.1

What's Changed

• Full dependencies adjusted to PyPi package

Full Changelog: v0.0.1...v0.1.1

v0.0.1

Full Changelog: https://github.com/LOAMRI/asltk/commits/v0.0.1