Skip to main content

Toolkit designed for quantifying and visualising 3D cardiomyocytes orientations in heart images

Project description

Cardiotensor

Cardiotensor logo


A Python package to quantify and visualize 3D cardiomyocyte orientation in heart imaging datasets

CI Doc Codacy Badge License Python Version PyPI version

Introduction

Cardiotensor is a user-friendly and memory-efficient toolkit designed for analyzing the orientation of cardiomyocyte fibers in large heart imaging datasets. It uses advanced image processing techniques to help researchers to accurately quantify 3D cardiomyocyte orientations with high efficiency.

Installation

Clone the repository and install the package using pip:

git clone https://github.com/JosephBrunet/cardiotensor.git
cd cardiotensor
pip install .

⚠️ Require python 3.10 or newer

Documentation

cardiotensor's documentation is available at josephbrunet.fr/cardiotensor/

Getting Started

Have a look at our simple example that runs you through all the commands of the package

Cardiotensor pipeline for 3D cardiac orientation analysis
Overview of the cardiotensor pipeline for 3D cardiac orientation analysis and tractography. (a) Input data consist of a whole‑ or partial‑heart volume and, optionally, a binary mask to restrict analysis to myocardial tissue. (b) Local cardiomyocyte orientation is derived by 3D structure tensor computation and eigenvector decomposition. The third eigenvector (smallest eigenvalue) is visualized as arrows, color‑coded by helix angle (HA); inset shows a zoom of the ventricular septum highlighting transmural fiber rotation. (c) After transforming to a cylindrical coordinate system aligned with the left ventricle, voxel‑wise HA, transverse angle (TA), and fractional anisotropy (FA) maps are computed for quantitative analysis. (d) Streamline tractography generated from the eigenvector field reveals continuous cardiomyocyte bundles throughout the heart, color‑coded by HA.

More Information

This package uses the structure-tensor package to calculate the structure tensor, extending its capabilities for cardiac imaging.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributing

Contributions are welcome! If you encounter a bug or have suggestions for new features:

  • Report an Issue: Open an issue in the repository.
  • Submit a Pull Request: Fork the repository, make changes, and submit a pull request.

For major changes, please discuss them in an issue first.

Contact

For questions, feedback, or support, please contact the maintainers at [j.brunet@ucl.ac.uk].

Reference

Brunet, J., Cook, A. C., Walsh, C. L., Cranley, J., Tafforeau, P., Engel, K., Arthurs, O., Berruyer, C., Burke O’Leary, E., Bellier, A., et al. (2024). Multidimensional analysis of the adult human heart in health and disease using hierarchical phase-contrast tomography. Radiology, 312(1), e232731. https://doi.org/10.1148/radiol.232731. [PDF]

@article{brunet2024multidimensional,
  title={Multidimensional analysis of the adult human heart in health and disease using hierarchical phase-contrast tomography},
  author={Brunet, Joseph and Cook, Andrew C and Walsh, Claire L and Cranley, James and Tafforeau, Paul and Engel, Klaus and Arthurs, Owen and Berruyer, Camille and Burke O’Leary, Emer and Bellier, Alexandre and others},
  journal={Radiology},
  volume={312},
  number={1},
  pages={e232731},
  year={2024},
  publisher={Radiological Society of North America}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cardiotensor-1.1.0.tar.gz (65.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cardiotensor-1.1.0-py3-none-any.whl (64.7 kB view details)

Uploaded Python 3

File details

Details for the file cardiotensor-1.1.0.tar.gz.

File metadata

  • Download URL: cardiotensor-1.1.0.tar.gz
  • Upload date:
  • Size: 65.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.5

File hashes

Hashes for cardiotensor-1.1.0.tar.gz
Algorithm Hash digest
SHA256 2743368169a11fd3dda6f68a9039648acc96ac62bbbb7929197b9440daf1abd9
MD5 9fd76c327e040503f67b6e1db66521e7
BLAKE2b-256 16e6b0872fa4576b37813964dcd6c743e0137965b2aec70e5e5e0a3941d92c16

See more details on using hashes here.

File details

Details for the file cardiotensor-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: cardiotensor-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 64.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.5

File hashes

Hashes for cardiotensor-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fa4661df34c9b2e6724449b0ef02719248676ae516bcded3d969d7b0580fefc5
MD5 b12d6793812fa9809e4559d017c0d01a
BLAKE2b-256 770d1ec9965ef72d008859e1ad894455223f6d9bfd5d9185c6c6852c1339c70e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page