Skip to content

Release Notes

0.0.6_5.0.10 [2021-10-18]

Maintenance:

  • No changes in this release

0.0.6 [2021-10-18]

Enhancements:

  • Added support for applying topup correction to second input image (apply_to_b)
  • Enhanced QA report generation to compare original and corrected images

Fixes:

  • Fixed matplotlib backend configuration by switching to agg for headless operation
  • Fixed error message output in exec_command() to include stderr details
  • Fixed handling of default config file when not provided as input
  • Corrected comment about apply_to_b corresponding to row 2 in acquisition parameters

Maintenance:

  • Updated base image from flywheel/fsl-base:5.0.9-trusty to flywheel/fsl-base:5.0_1.0.0-xenial
  • Updated Docker image tags to 0.0.6_5.0.10
  • Migrated from python3 to python3.7 in environment setup
  • Added virtual environment activation in manifest command
  • Updated pip installation to run within virtual environment
  • Reorganized Dockerfile to copy Python modules before setting workdir
  • Added python3-tk system package dependency
  • Removed python3-numpy system package (now installed via pip)
  • Improved code formatting and spacing in mri_qa.py

0.0.3 [2020-08-06]

Fixes:

  • Fixed topup_debug_level config default from string "0" to integer 0

Documentation:

  • Fixed QA example image path from absolute GitHub URL to relative path
  • Improved QA section formatting with proper spacing

0.0.2 [2020-01-17]

Enhancements:

  • Added initial Gear implementation for FSL TOPUP susceptibility distortion correction
  • Added support for 3D and 4D input images with automatic volume extraction
  • Added optional topup correction application to additional image pairs via apply_to_1 and apply_to_2 inputs
  • Added QA report generation comparing distorted and corrected images with brain outline overlays
  • Added support for custom configuration files via config_file input
  • Added optional displacement field output via displacement_field config
  • Added optional Jacobian determinants output via jacobian_determinants config
  • Added optional rigid body transformation matrices output via rigid_body_matrix config
  • Added configurable topup debug levels (0-3) via topup_debug_level config
  • Added topup_only mode to calculate fieldmaps without applying corrections

Maintenance:

  • Added Dockerfile based on flywheel/fsl-base:5.0.9-trusty with python3 and required dependencies
  • Added .dockerignore and .gitignore for repository hygiene
  • Added requirements.txt for Python dependency management

Documentation:

  • Added comprehensive README.md with background, usage instructions, input descriptions, config options, and output file descriptions
  • Added QA example image demonstrating topup correction results