We're ready to ship our Alpha release.
Here's where it is located: https://github.com/ccipd/collageradiomics
This is the Git repository that houses our code and issue tracker. Within the root of the repo are instructions to follow in order to install our Python module and instructions to explore the examples within our Docker container. Our module is packaged in a standard format and is simple to use for those familiar with the ecosystem, but please feel free to email if you have any questions about Python or pip.
As per the instructions, our examples are housed here: https://github.com/ccipd/collageradiomics/tree/master/jupyter/examples
The instructions mention this, but I'd like to note that the examples require Docker to be installed before running. This ensures that the development experience is standardized and prevents errors related to individual environment setup.
We have two examples:
1. Demonstration of running CoLlage on rectangular mask defined in code.
2. Demonstration of running CoLlage on a non-rectangular mask passed in as an image.
The output of the code is primarily an image with the CoLlage algorithm ran on the passed in mask. There are secondary outputs of the raw Haralick features, and the features overlayed onto the image in code.
Both examples provide a demonstration of how you can take this output and display it in an easy to read way:
Here is a full preview in PDF format of what the examples look like after they execute:
[non-rectangular-mask-example.pdf](https://github.com/ccipd/collageradiomics/files/4796115/non-rectangular-mask-example.pdf)
Should anyone have feedback or encounter bugs, please have them file an issue in our issue tracker and we will respond quickly: https://github.com/ccipd/collageradiomics/issues
As you can see in the issue tracker, there are some things we'd like to add (hosted docs, unit test suite, multiple modules, and more!) as we go further in the project, but the core is solidified and is ready for students to use. We welcome any suggestions.
It's been fun getting to this point-- we're excited to move forward into the Slicer integration, and we look forward to seeing what students and researchers develop with this groundbreaking work, now made more accessible by Toth Technology.