Skip to main content

AcoustoOpticTomography (AOT_biomaps)

Python 3.8+ License: MIT Status: Active Development

AOT_biomaps is an advanced Python library for Acousto-Optic Tomography (AOT). It provides comprehensive tools for image reconstruction, acoustic simulation, optical modeling, and 2D/3D data processing.

📌 About the Project

This library was developed to meet the needs of the biomedical imaging research community, particularly for Acousto-Optic Tomography applications. It combines advanced reconstruction algorithms with optimized CPU and GPU implementations.

Key Features

  • ✅ Tomographic Reconstruction: MLEM, PDHG, LS, DEPIERRO, MAPEM, LBFGS
  • ✅ Multi-Device Support: CPU (NumPy) and GPU (CuPy) with automatic fallback
  • ✅ Sparse Matrices: Optimized CSR and SELL-C-sigma implementations
  • ✅ Acoustic Simulation: Plane, focused, irregular waves
  • ✅ Optical Modeling: Lasers, absorbers, heterogeneous media
  • ✅ Signal Processing: Filtering, backprojection, Radon transform
  • ✅ Visualization: 2D/3D visualization tools (optional with matplotlib)

Modular Architecture

AOT_biomaps/
├── AOT_Acoustic/     # Acoustic simulation
├── AOT_Experiment/    # Experiment management
├── AOT_Medium/       # Medium modeling
├── AOT_Optic/        # Optical modeling
├── AOT_Recon/        # Reconstruction algorithms
│   ├── AOT_Optimizers/   # MLEM, PDHG, LS, etc.
│   ├── AOT_PotentialFunctions/ # Potential functions
│   └── AOT_SparseSMatrix/    # Sparse matrices (CSR, SELL)
└── Config.py         # Global configuration

🚀 Installation

See INSTALLATION.md for detailed instructions.

Quick Installation

# Clone the repository
git clone https://github.com/LucasDuclos/AcoustoOpticTomography.git
cd AcoustoOpticTomography

# Install in development mode
pip install -e .

### GPU Support (Included by Default)

By default, **CuPy** is automatically included if CUDA is detected on your system. The installer will detect your CUDA version and install the appropriate CuPy package.

To manually specify your CUDA version:

```bash
# For CUDA 11.x
pip install cupy-cuda11x

# For CUDA 12.x
pip install cupy-cuda12x

# For CUDA 13.x
pip install cupy-cuda13x

# For CUDA 14.x
pip install cupy-cuda14x

CPU-only installation:

pip install aot-biomaps --cpu
# or
AOT_BIOMAPS_CPU_ONLY=true pip install aot-biomaps

📖 Documentation

🎯 Quick Start Example

import numpy as np
from AOT_biomaps import Tomography, AlgebraicRecon
from AOT_biomaps.AOT_Recon.ReconEnums import ReconType

# Create a tomography experiment
experiment = Tomography(
    optic_image_path="path/to/optic_image.npy",
    acoustic_fields_path="path/to/acoustic_fields.npy"
)

# Setup reconstruction
recon = AlgebraicRecon(
    experiment=experiment,
    reconType=ReconType.Algebraic,
    optimizerType="MLEM",
    numIterations=100
)

# Run reconstruction
recon.run(withTumor=True)

# Save results
recon.save(withTumor=True, saveDir="results/")

🔧 Dependencies

Core Dependencies (Required)

  • Python ≥ 3.8
  • NumPy ≥ 1.20

Optional Dependencies

  • CuPy ≥ 10.0 - For GPU acceleration
  • Matplotlib ≥ 3.0 - For visualization
  • tqdm ≥ 4.0 - For progress bars
  • SciPy ≥ 1.7 - For signal processing
  • kWave - For acoustic simulation (optional)

Compatibility Matrix

Feature CPU (NumPy) GPU (CuPy)
MLEM Reconstruction ✅ ✅
PDHG Reconstruction ✅ ✅
CSR Matrices ✅ ✅
SELL Matrices ✅ ✅
Visualization ✅ ✅
Acoustic Simulation ✅ ⚠️ (kWave required)

📊 Performance

Benchmark (on standard dataset)

Algorithm CPU (s) GPU (s) Speedup
MLEM 45.2 2.1 21.5x
PDHG 38.7 1.8 21.5x
LS 22.4 1.2 18.7x

Memory Usage

Matrix Format Size (GB)
100x100x100x50 Dense 19.1
100x100x100x50 CSR 0.8
100x100x100x50 SELL 0.6

🤝 Contributing

Contributions are welcome! See CONTRIBUTING.md for guidelines.

How to Contribute

  1. Fork the project
  2. Create a branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📜 License

Distributed under the MIT License. See LICENSE for more information.

🙏 Acknowledgments

  • Biomedical Imaging Laboratory
  • All contributors who participated in this project

Contact: For any questions or suggestions, feel free to open an issue or contact me directly.

🐙 GitHub | 📧 Email

Metadata

Release files for aot-biomaps 2.9.1060

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

Source distribution (sdist)

Source distribution for aot-biomaps 2.9.1060
File Size Uploaded Provenance Actions
aot_biomaps-2.9.1060.tar.gz 193.2 kB Without provenance Details for aot_biomaps-2.9.1060.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for aot-biomaps 2.9.1060
File Interpreter ABI Platform Actions
aot_biomaps-2.9.1060-py3-none-any.whl Python 3 none any Details for aot_biomaps-2.9.1060-py3-none-any.whl

Total release size: 428.2 kB

Release files / aot_biomaps-2.9.1060.tar.gz

Download URL aot_biomaps-2.9.1060.tar.gz
Size 193.2 kB
Tags Source
SHA-256 checksum
How to use checksums
8719bfac011d50e955a0b67424be9f3794c4523851edbec53ca0a476fd121e51
BLAKE2b-256 checksum
How to use checksums
d9754282a17f3270a1e61423d32d05d1b8fb78cdb82791d86bc1660197f41e6a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.13

Release files / aot_biomaps-2.9.1060-py3-none-any.whl

Download URL aot_biomaps-2.9.1060-py3-none-any.whl
Size 235.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
80c0e3d1d4de83d21983ed6ebfad31c9556561c7da29d0ee1ff2d8ddddbaaca3
BLAKE2b-256 checksum
How to use checksums
5dfdc469899ce21d4d685ab2ca720c1e313944217c688ba16c213a0001983fa3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.13

Security for aot-biomaps 2.9.1060

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.9.1060 This release

2 release files No provenance

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