https://github.com/jmbhughes/solartom
Python solar tomography package with Rust backend
https://github.com/jmbhughes/solartom
computer-vision solar tomography
Last synced: 5 months ago
JSON representation
Python solar tomography package with Rust backend
- Host: GitHub
- URL: https://github.com/jmbhughes/solartom
- Owner: jmbhughes
- License: mit
- Created: 2023-11-02T20:32:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-06T23:45:44.000Z (over 1 year ago)
- Last Synced: 2024-11-16T16:37:59.162Z (7 months ago)
- Topics: computer-vision, solar, tomography
- Language: Rust
- Homepage: http://jmbhughes.com/solartom/
- Size: 1.61 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# solartom: a solar tomography package
🚧🚧🚧 This package is under heavy development and will likely change dramatically. 🚧🚧🚧
🚧🚧🚧 New features are on the way. 🚧🚧🚧
## What is solartom ?
Tomography is the task of reconstructing a model based on observations. In this case, we use many 2D solar images to construct a 3D model of the solar environment.
This is a parallelized tomography projector and backprojector. It originates from solar tomography applications but could be used for other applications. It uses the [Siddon algorithm](https://aapm.onlinelibrary.wiley.com/doi/abs/10.1118/1.595715) as its core. The parallelization is done with Rust's Rayon library.
A similar package called [TomograPy](https://github.com/nbarbey/TomograPy) was originally authored by [Nicolas Barbey](https://github.com/nbarbey). This is the second generation of that package. It is now updated and maintained by [Marcus Hughes](https://github.com/jmbhughes).
Above you can see an example input with its reconstruction from a solartom derived model cube. It's not perfect but shows the promise of this package.
## Status
This package still needs some features and much documentation to improve ease of use for solar physics settings. If you're interested in using it, please contact Marcus Hughes for more information on a timeline.
## Installation
Until the code is released on PyPI (coming soon!), you have to clone the repo and then install using pip. I always recommend creating a virtual environment for each project.
```bash
[email protected]:jmbhughes/solartom.git
python -m venv venv
source venv/bin/activate
pip install .
```
## Basic Use
Right now a simple toy example is available in `example.py`. More guidance is coming on how to use with STEREO and other data!
## Extended Documentation
Coming soon!
## Collaborations and questions
Please reach out to Marcus Hughes at . I'd love to have your input and use case in mind when developing this software.