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

Add extractor for BioFormats (CXD) #338

Draft
wants to merge 24 commits into
base: main
Choose a base branch
from
Draft

Add extractor for BioFormats (CXD) #338

wants to merge 24 commits into from

Conversation

weiglszonja
Copy link
Contributor

@weiglszonja weiglszonja commented May 30, 2024

Classes added:

  • BioFormatsImagingExtractor: a base imaging extractor for files supported by BioFormats (supported formats)
  • CxdImagingExtractor: a specialised imaging extractor for reading data and metadata from CXD files produced via Hamamatsu Photonics (HCImage Live software: https://hcimage.com)

Note:

To use these extractors bioformats_jar has to be installed with conda as:
conda install -c conda-forge bioformats_jar.
Additionally, the reader requires the java executable to be available on the path (or via the JAVA_HOME environment variable), if not found it has to be set as:

mac and linux:
export JAVA_HOME=$CONDA_PREFIX

windows:
set JAVA_HOME=%CONDA_PREFIX%\\Library

TODO:

  • need an example .cxd data from Howe lab
  • need to add unittests
  • need to add conda install -c conda-forge bioformats_jar dependency for the CI tests

@weiglszonja weiglszonja marked this pull request as draft May 30, 2024 13:40
@pauladkisson
Copy link
Member

FYI, Now that we have working API docs, this PR will need to add the new imaging extractors to list of imaging extractors in the api docs.

@weiglszonja
Copy link
Contributor Author

Created PR for uploading the example file shared by the Howe lab: https://gin.g-node.org/CatalystNeuro/ophys_testing_data/pulls/22

@@ -3,3 +3,4 @@ scanimage-tiff-reader==1.4.1.4
neuroconv[video]>=0.4.6 # Uses the VideoCaptureContext class
natsort>=8.3.1
isx>=1.0.4
aicsimageio>=4.14.0
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

requirements-full.txt Outdated Show resolved Hide resolved
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