Skip to content

Adding Imaris File Reading to Brieflow supported filetypes.#193

Open
joandrews33 wants to merge 6 commits intocheeseman-lab:mainfrom
joandrews33:ims-reader
Open

Adding Imaris File Reading to Brieflow supported filetypes.#193
joandrews33 wants to merge 6 commits intocheeseman-lab:mainfrom
joandrews33:ims-reader

Conversation

@joandrews33
Copy link

Description

Adding an Imaris File reader to extend supported file types. Reads in metadata bundled with each Imaris image file, and converts images to tiff files.

I also added support in the workflow/scripts/preprocessing/extract_metadata.py to allow the ability to use both bundled metadata and a separate metadata file together when extracting metadata (because Imaris has per image and additional per job metadata files), but I wasn't able to get this to integrate with snakemake without making deeper structural changes to the code base. I commented out the new code, and reverted the behavior to legacy out of worry for breaking support for workflows that need a separated metadata file, but if it works with those workflows, it may be useful new functionality.

What is the nature of your change?

Enhancement (adds functionality)

Checklist

Please ensure that all boxes are checked before indicating that a pull request is ready for review.

  • My code follows the conventions of this project.
  • [Not updated. I am a few updates behind main.] I have updated the pyproject.toml to reflect the change as designated by semantic versioning.
  • I have checked linting and formatting with ruff check and ruff format.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • [ N/A ?] I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have deleted all non-relevant text in this pull request template.

@joandrews33
Copy link
Author

Ready for review. Changes to scripts/preprocessing/extract_metadata.py can be safely rejected, as my pipeline doesn't need them as is, but they would be necessary if I wanted to incorporate automatic pixel size determination, which requires cross-referencing two different metadata files.

@mat10d mat10d self-requested a review February 17, 2026 13:25
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.

2 participants

Comments