Skip to main content

Welcome to radioSphere

license pipeline status pypi

Join the chat room for support here.

This project contains a series of tools for the analysis of divergent radiographs containing spherical particles, in particular to measure 3D positions from a single radiograph like this one:

Sample Radiograph

The reconstruction technique proposed is a two-step approach:

  • Step 1: is a technique called tomopack which is an FFT-based pattern matching approach. It uses a template image, or "structuring element" that we call ψ to pick out spheres. Since the size of ψ needs to be very close to the correct size, this allows us to distinguish different sized projections of spheres.

  • Step 2: Position optimisation: Starting from a guess of particle positions, the projection is computed and compared to the measured projection. Particle positions are modified iteratively in order to minimise the difference between computed projection and measured one.

Geometry in radioSphere is everything: the coordinate systems defined are as follows:

Geometry

See the online documentation to learn about the functions.

Contributors

The technique has been developed by Edward Andò (EPFL), Benjy Marks, and Stéphane Roux (CNRS) and published in Measurement Science and Technology.

The technique has been developed thanks to UGA Tec21 funding further by Olga Stamati (ESRF), resulting in a publication in The Journal of Multiphase Flow, and by Leonard Turpin (Diamond).

The numba projector was contributed by Youssef Haouchat (EPFL),which is faster than the original C code and allows us to distribute the package on pypi, thanks!

Notes on the repository

  • src/radioSphere: this folder contains the core functions of radioSphere:

    • detectSpheres: functions related to tomopack (Step 1)

    • optimisePositions: functions related to the optimiser (Step 2)

    • projectSphere: The tools to create projections (units mm)

  • tests: contains tests to test the functionality of what is in tools

  • examples and paper/figureScripts: examples of the use of radioSphere on both synthetic and experimental data

  • data: where the presented experimental and synthetic data is stored to run the examples

  • figures: figures for paper and this website

  • paper: will contain final sources to the paper

  • presentations: sources for presentations given about this topic

Installing radioSphere

For users:

pip install radioSphere

For developers:

Please clone this repository once checked out, activate your virtual environment, and then: pip install -e ".[dev]"

run the tests to make sure everything is OK: pytest

Metadata

Release files for radioSphere 2.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for radioSphere 2.0.1
File Size Uploaded
radioSphere-2.0.1.tar.gz 629.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for radioSphere 2.0.1
File Interpreter ABI Platform
radioSphere-2.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 694.3 kB

Release files / radioSphere-2.0.1.tar.gz

Download URL radioSphere-2.0.1.tar.gz
Size 629.2 kB
Tags Source
SHA-256 checksum
How to use checksums
e4f8a600dcbed4a401f61b86f3cdfe66fd8fda98fdbf4d6eafdaf9016f59135f
BLAKE2b-256 checksum
How to use checksums
8a006cd1512a952d5e0b71929b3691feddd75cd1cd315c0c81fe7ac7eb04ad6d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.6

Release files / radioSphere-2.0.1-py3-none-any.whl

Download URL radioSphere-2.0.1-py3-none-any.whl
Size 65.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3f714014eb024dd3af44b1acbf6a4097ad517ad27cac0d4bad1e713f4dbc5261
BLAKE2b-256 checksum
How to use checksums
f641c84ae5f81b911f3fe33816d41ef34af099c55d29d18f7a7bb3ebbccf86a7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.6

Release history Release notifications | RSS feed

This release

2.0.1 This release

2 release files

2.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page