Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DO NOT MERGE: Resolve Type Conversion and Improve Documentation #2194

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

JackEAllen
Copy link
Collaborator

Resolve a type conversion bug preventing individual tiff files from being written correctly. Improve script usage documentation and log output directory location.

Issue

Closes #2193

Description

  • Resolve incorrect values from being written during unpacking
  • Add additional documentation to script file to describe usage
  • Add an additional method to log the date and time and whether or not the script was successful at writing all files along and the output file location files have been written too.

Testing

Tested Image preview
Visually compared against images produced using ImageJ (Load files into ImageJ then save as image sequence)
Tested Loading into Mantid Imaging.

Acceptance Criteria

How should the reviewer test your changes?

  • Images produced by script are identical to images produced by ImageJ
  • Unpacked Images can be opened in Mantid Imaging
  • The Date-time of script execution completion is printed
  • A validation log is printed to the terminal to print if all files were successfully unpacked and written the destination
  • Output directory location is printed to the terminal
  • Script usage documentation improved to include example usage of setting a range and naming convention
  • Documentation explicitly states paths are relative and that if the output directory does not exist, a directory will be created.

Documentation

How have you changed the documentation to reflect your changes? All changes should be noted in the appropriate file in docs/release_notes

N/A

@JackEAllen JackEAllen self-assigned this May 8, 2024
@coveralls
Copy link

coveralls commented May 8, 2024

Coverage Status

coverage: 72.796%. remained the same
when pulling 1446f87 on 2193_tiff_un-pack_utility_fix
into aa73fc2 on main.

Resolve a type conversion bug prevent individual tiff files from being written correctly. Improve script usage documentation and log output directory location.
@JackEAllen JackEAllen force-pushed the 2193_tiff_un-pack_utility_fix branch from 10b0caf to 1446f87 Compare May 8, 2024 10:09
@JackEAllen JackEAllen marked this pull request as ready for review May 8, 2024 10:59
@JackEAllen
Copy link
Collaborator Author

Float32 is the same type ImageJ produced unpacking tiff containers. I'll double check with IMAT if this is what they want as the raw value of images in the container is UINT32

@JackEAllen JackEAllen changed the title Resolve Type Conversion and Improve Documentation DO NOT MERGE: Resolve Type Conversion and Improve Documentation May 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Jack - fix tiff unpacking issue for IMAT
2 participants