GSTT-CSC / hazen

Quality assurance framework for Magnetic Resonance Imaging
https://github.com/GSTT-CSC/hazen
Apache License 2.0
22 stars 12 forks source link

156 only add "report" section to results when requested #354

Closed sophie22 closed 1 year ago

sophie22 commented 1 year ago

tiny change as discussed in the Hazen meeting to standardise when and how the "reports" section with file path(s) to report images are added to the results dictionary in all tasks. remove the creation of a report folder from the snr_map task as it is being created upfront within __init__.py

github-actions[bot] commented 1 year ago

Coverage

Coverage Report
FileStmtsMissCoverMissing
hazenlib
   HazenTask.py25388%32–34
   __init__.py1514173%141, 145, 155, 160, 197, 204–209, 220, 223–230, 250–252, 270–272, 291–293, 302, 307, 313, 363, 374, 380–386, 400–401, 405
   exceptions.py21481%17–21
   relaxometry.py3119071%248–266, 640, 699–701, 755, 803–825, 843–858, 1186–1189, 1198–1201, 1213–1226, 1229–1234, 1245–1274
   shapes.py20955%13, 16, 24–29, 32
   tools.py84890%43–50, 92, 101, 117
hazenlib/tasks
   acr_geometric_accuracy.py1465662%38–75, 179–195, 209–233
   acr_ghosting.py1174363%33–55, 93–95, 125–127, 163–196
   acr_slice_position.py1555465%53–76, 154, 215–260
   acr_slice_thickness.py1546458%40–62, 188–243
   acr_snr.py1396057%34–75, 100, 169–179, 212–225, 258–271
   acr_spatial_resolution.py2447470%66–90, 169, 212, 225–234, 323–378
   acr_uniformity.py903363%34–56, 123–140
   ghosting.py1525365%18–35, 50, 112–113, 117, 127–128, 154–156, 173–175, 221–259
   relaxometry.py7271%10–11
   slice_position.py1202381%31, 40–41, 52, 106–107, 133, 213, 220–237
   slice_width.py3575385%34–37, 41, 109, 168–188, 453, 458–459, 465, 470, 532–533, 782–823
   snr.py1656759%49, 66–71, 165–183, 198–207, 225–235, 262–272, 277–287, 318–331, 336–344, 373–386
   snr_map.py104199%291
   spatial_resolution.py2474582%36–39, 43, 64, 149, 208, 334–370
   uniformity.py792075%42–45, 51, 93–94, 101, 135–149
TOTAL290480372% 

Tests Skipped Failures Errors Time
219 0 :zzz: 0 :x: 0 :fire: 3m 10s :stopwatch:
sophie22 commented 1 year ago

regarding the snr_map script: I only removed the report folder creation section, as it is being handled centrally in init.py. Further down around line 314 there still is the section for if.report to generate the diagrams/images, intact.