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

Save conversion options in output file #17

Open
balbasty opened this issue Nov 12, 2024 · 2 comments
Open

Save conversion options in output file #17

balbasty opened this issue Nov 12, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@balbasty
Copy link
Collaborator

Should we save the options passed to the converter? I guess some of them are intrinsically stored in the zarr (all the chunking options and stuff), but maybe the full command should be also stored nonethless?

@balbasty balbasty added the enhancement New feature or request label Nov 12, 2024
@calvinchai
Copy link
Contributor

How about store the whole log including the full command aside the output zarr file?

@balbasty
Copy link
Collaborator Author

balbasty commented Nov 13, 2024

dcm2niix (a widely used software to convert DICOM data to BIDS) saves itself in the sidecar json file of the converted file, using keys "ConversionSoftware" and "ConversionSoftwareVersion". We should do the same. We could also add "ConversionSoftwareOptions" and save the arguments as a JSON.

See: https://github.com/rordenlab/dcm2niix/tree/master/BIDS

This makes me think that we should write BIDS-compatible sidecar JSON's for most of these files. But we need data-generating sites to provide us with proper metadata. I'll open another issue for this.

See: https://bids-specification.readthedocs.io/en/stable/modality-specific-files/microscopy.html#microscopy-metadata-sidecar-json

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants