Requirement
We would like to have a python interface that can be used like this:
from scitiff.data import hyperstack_example_with_variances_and_mask
import scitiff as stf
import scipp as sc
sample_img = hyperstack_example_with_variances_and_mask(concatenated_channel=True)
display(sample_img)
stf.values(sample_img)
Expected Output
Scitiff image (as scipp.DataArray or scipp.DataGroup) that does not have extra channel other than values(intentisites).
And channel dimension should be squeezed.
If other channels are already assembled as variances,
it should still drop the variances.
It that case, mask may not be dropped (we can maybe add a keyword argument to explicitly drop mask as well).
About the Project
Scitiff stands for scientific tiff.
It aims to encode scientific metadata as a plain text along with the image data in tiff.
See our scitiff documentation for more details.
Development Environment
See Developer Guide to set up the local environment.
Setting up a remote repository
Go to the base branch, channel-slicer, and fork the repo.
TODO list of this issue
Related Information for Implementation
Scipp User Guide for Slicing
https://scipp.github.io/user-guide/slicing.html
We are going to learn more about scipp on Wednesday, so no need to dig in too deep 😁
IO module documentation
IO Helper Tutorial
Good starting point to see what scitiff do and to see what helper functions there are for development.
Meaning of Channel in Scitiff
This section of IO tutorial explains what channels mean in scitiff.
Requirement
We would like to have a python interface that can be used like this:
Expected Output
Scitiff image (as scipp.DataArray or scipp.DataGroup) that does not have extra channel other than values(intentisites).
And channel dimension should be squeezed.
If other channels are already assembled as variances,
it should still drop the variances.
It that case,
maskmay not be dropped (we can maybe add a keyword argument to explicitly drop mask as well).About the Project
Scitiff stands for scientific tiff.
It aims to encode scientific metadata as a plain text along with the image data in tiff.
See our scitiff documentation for more details.
Development Environment
See Developer Guide to set up the local environment.
Setting up a remote repository
Go to the base branch, channel-slicer, and fork the repo.
TODO list of this issue
Complete the implementation of the
valuesAPI.scitiff/src/scitiff/_img_processors.py
Lines 9 to 11 in bea3125
Write documentation page. Under user-guide, Could be a separate sub-issue
Write unit tests. Could be a separate sub-issue
scitiff/tests/scitiff_values_test.py
Lines 1 to 3 in f765344
Test with ImageJ (Optional)
Open a PR (Pull Request)
Set the base branch to
channel-slicer.Related Information for Implementation
Scipp User Guide for Slicing
https://scipp.github.io/user-guide/slicing.html
IO module documentation
IO Helper Tutorial
Good starting point to see what
scitiffdo and to see what helper functions there are for development.Meaning of Channel in Scitiff
This section of
IOtutorial explains what channels mean inscitiff.