v1.3.3

What's Changed

Small update to allow compatibility with Python version 3.11 and require at least Python 3.9 to install this version of hazen.
Additional update to allow running hazen with an input folder that might have other subfolders or additional file types that are ignored, rather than causing an error. Only DICOM files with a pixel data (image) are being used by hazen for calculations.

• Address python version compatibility by @sophie22 in #422
• Ignore files in the input folder that have no pixel data by @sophie22 in #423

Full Changelog: v1.3.2...v1.3.3

v1.3.2

What's Changed

Standardised docstrings in code and improved auto generated documentation on ReadTheDocs.
Improved task descriptions for ACR tasks on ReadTheDocs.
MagNet SNR task now has optional CLI argument to specify head or body coil.

ACR Task Updates

Updates to ACR object class methods: phantom orientation, slice ordering and locating phantom centre.
ACR geometric accuracy is now measuring from the correct slices.
Improvement to ACR slice thickness task: limit what values are included in the interpolation.

• Coil options by @mollybuckley in #388
• Apply Python script formatting by @sophie22 in #401
• 397 standardise docstrings by @sophie22 in #398
• 378 geom accuracy wrong slices by @mollybuckley in #399
• Generate documentation from docstrings by @sophie22 in #403
• ACR slice ordering by @sophie22 in #409
• Updated tasks.rst and references.bib by @RebeccaThornley in #415
• ACR Object orientation - bugfix by @sophie22 in #416
• ACR slice thickness improvement by @sophie22 in #417
• improve circle detection in ACR Object by @sophie22 in #418
• release 1.3.2 by @mollybuckley in #419

New Contributors

• @mollybuckley made their first contribution in #388
• @RebeccaThornley made their first contribution in #415

Full Changelog: v1.3.1...v1.3.2

v1.3.1

What's Changed

The result dictionary now has a standardised structure, consisting of the following elements:

results_dict = {
    "task": "task_name",
    "file": "DCM description or list of descriptions",
    "measurement": {dict of key value pairs},
    "report_image": [OPTIONAL list of paths to report images]
}

Furthermore, the values displayed in the result dictionary are being rounded to the appropriate precision and units are displayed in the key.

!!!CHANGE to OUTPUT!!!
The slice_position task now returns only the maximum and average of slice positions by default, while the list of 40 values is available with the --verbose option.

Behind the scene changes for processing the ACR images and slight improvements to the slice_width and snr_map task scripts.
Improved unit tests for ACR phantom Tasks.

• 374 standardise task input and output by @sophie22 in #375
• 381 Simplify unit tests for ACR tasks by @sophie22 in #381
• 386 Verbose option for slice position by @sophie22 in #387

Full Changelog: 1.3.0...v1.3.1

1.3.0

What's Changed

General updates

• Add Apache 2.0 licence to hazen by @tomaroberts in #372
• Add print statements to test results by @Lucrezia-Cester in #335
• Only add "report" section to results when requested by @sophie22 in #354
• Improve displaying results on terminal by @sophie22 in #363
• Collate utility functions by @sophie22 in #351
• Separate instructions for users and developers by @sophie22 in #349
• Improve docopt description by @sophie22 in #359 and #364
• Remove references to sites where data originated from by @pcw24601 in #229
• Change SNR kernel size to 9x9 by @sophie22 in #371

ACR phantom related updates

• ACR v1.1 - Refactor and Improved Masking by @YassineAzma in #343
• ACR - Slice Ordering and Orientation Checks by @YassineAzma in #353

Relaxometry task updates

• T2 Rician noise by @pcw24601 in #204
• Standardise relaxometry task report by @sophie22 in #361
• Refactor relaxometry Task to inherit from HazenTask by @sophie22 in #362 and #365

New Contributors

• @sophie22 made their first contribution in #354

Full Changelog: 1.2.0...1.3.0

Release 1.2.0

What's Changed

• ACR Spatial Resolution Functionality by @YassineAzma in #324
• ACR Slice Thickness Functionality by @YassineAzma in #321
• Update README.md by @YassineAzma in #325
• 316 cli parser tests fail in windows path error by @pcw24601 in #317
• Release/1.1.4 by @Lucrezia-Cester in #327
• added new tasks to the CLI by @Lucrezia-Cester in #330
• updated version by @Lucrezia-Cester in #331
• 334 qms conformity by @Lucrezia-Cester in #337
• Update versions for release by @Lucrezia-Cester in #338
• 329 the cli has not been updated for the new tasks by @Lucrezia-Cester in #339
• Release/2.1.0 by @Lucrezia-Cester in #340

Full Changelog: 1.1.4...1.2.0

Hazen Release 1.1.4

What's Changed

• ACR Spatial Resolution Functionality by @YassineAzma in #324
• ACR Slice Thickness Functionality by @YassineAzma in #321
• Update README.md by @YassineAzma in #325
• 316 cli parser tests fail in windows path error by @pcw24601 in #317

Full Changelog: 1.1.3...1.1.4

1.1.3

What's Changed

• Increase starting threshold to 0.5 quantile by @laurencejackson in #323

Full Changelog: 1.1.2...1.1.3

1.1.2

What's Changed

• updated bug report by @Lucrezia-Cester in #223
• Fixes path in CLIparser tests to use TEST_DATA_DIR not relative path by @pcw24601 in #228
• Adds links to hazen documentation by @heyhaleema in #301
• updated a description for the docpot by @Lucrezia-Cester in #281
• Adds SNR test by @heyhaleema in #232
• ACR SNR Functionality by @YassineRMH in #309
• ACR Geometric Accuracy Functionality by @YassineRMH in #312
• ACR Slice Position Functionality by @YassineRMH in #299
• Add relaxometry template files to package by @pcw24601 in #311
• Add images to readme by @Lucrezia-Cester in #304
• Updates SNR image filename reference by @heyhaleema in #315
• Refactor hazen task to snr map by @pcw24601 in #305
• Bump docker/metadata-action from 4.1.1 to 4.3.0 by @dependabot in #319
• Bump docker/build-push-action from 3.2.0 to 4.0.0 by @dependabot in #318

Full Changelog: 1.1.0...1.1.2

1.1.1

What's Changed

• updated bug report by @Lucrezia-Cester in #223
• Fixes path in CLIparser tests to use TEST_DATA_DIR not relative path by @pcw24601 in #228
• Adds links to hazen documentation by @heyhaleema in #301
• updated a description for the docpot by @Lucrezia-Cester in #281
• Adds SNR test by @heyhaleema in #232
• ACR SNR Functionality by @YassineRMH in #309
• ACR Geometric Accuracy Functionality by @YassineRMH in #312
• ACR Slice Position Functionality by @YassineRMH in #299
• Add relaxometry template files to package by @pcw24601 in #311
• Add images to readme by @Lucrezia-Cester in #304
• Updates SNR image filename reference by @heyhaleema in #315
• Refactor hazen task to snr map by @pcw24601 in #305
• Bump docker/metadata-action from 4.1.1 to 4.3.0 by @dependabot in #319
• Bump docker/build-push-action from 3.2.0 to 4.0.0 by @dependabot in #318
• 306 refactor relaxometry to use hazentask by @pcw24601 in #308

Full Changelog: 1.1.0...1.1.1

1.1.0

Release 1.1.0 incorporates all the changes from 1.0.8 and fixes bugs related to the release pipelines.

Updates to release pipeline

• 296 hazen incompatible with python 311 by @laurencejackson in #297
• update numpy and move code coverage badge update to release tests by @laurencejackson in #295

What's Changed in hazen

• ACR Ghosting (and Uniformity) by @YassineRMH in #280
• Fix readthedocs by @hshuaib90 in #262
• Corrects scipy version in requirements.txt by @heyhaleema in #287
• SNR mark 23x25 from 9x9 by @Lucrezia-Cester in #282
• 233 snr putting rois in the wrong location by @laurencejackson in #267
• Add tests for sp res by @Lucrezia-Cester in #285
• Slice pos axis labels by @Lucrezia-Cester in #279
• Adds .readthedocs.yaml to fix RTD build by @heyhaleema in #288
• Pre-release cleanup by @heyhaleema in #292