CamiTK File Format - metadata, scenes, processing scenarios...
As a | CamiTK developer |
I would like to | define a file format for CamiTK I/O |
So that | CamiTK can load and save scenes, metadata associated with files, user preferences, scenarios for the state machine... |
Epic/Topics |
Description / Overview
CamiTK needs to store multiple types of data. An extensible file format should be designed for the following use cases:
- Metadata files: storing LUT settings/color settings and geometrical transformations associated with a file, as well as CamiTK properties.
- Storing scenes (objects loaded, geometrical transformations, actions settings)
- Storing processing scenario such as used by the state machine to allow batch processing of data
- Storing user preferences
Hints
- A human-readable format would be better (e.g. JSON)
- For scenes, CardioModel CEP and Meniscare CEP have scene formats to load multiple registered images together. but they should be made more generic
- The CamiTK state machine already has a XML-based format to define processing steps
Acceptance tests
-
Load a volume, register it to another image, set its LUT. Close CamiTK. When opening the image again, it should still be registered and keep its LUT settings. -
Any action should have its settings saved in the metadata of the file it was used on, and the settings should be loaded when opening the file again -
Loading a scene file reopens the scene as it was before closing it (all images, actions, viewers...) -
Opening a file, using multiple actions to get an output and saving it could be saved as a processing scenario, and applied to another input.
Track
Misc
- Automatic subscription of issue creator:
If appropriate, do not forget to mark this issue as "confidential" by checking the corresponding tick box below