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 License DOI 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

Cardiotensor is published as a Python package and can be installed with pip, ideally by using a virtual environment. Open up a terminal and install cardiotensor with:

pip install cardiotensor

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

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

If you use Cardiotensor in your research, please cite:

Primary Reference

Brunet, J., Chestnutt, L., Chourrout, M., Dejea, H., Sabarigirivasan, V., Lee, P. D., & Cook, A. C. "Cardiotensor: A Python Library for Orientation Analysis and Tractography in 3D Cardiac Imaging." Journal of Open Source Software 11(121) (2026): 9720. 🗎

@article{Brunet2026,
  doi={10.21105/joss.09720},
  url={https://doi.org/10.21105/joss.09720},
  year={2026},
  publisher={The Open Journal},
  volume={11},
  number={121},
  pages={9720},
  author={Brunet, Joseph and Chestnutt, Lisa and Chourrout, Matthieu and Dejea, Hector and Sabarigirivasan, Vaishnavi and Lee, Peter D. and Cook, Andrew C.},
  title={Cardiotensor: A Python Library for Orientation Analysis and Tractography in 3D Cardiac Imaging},
  journal={Journal of Open Source Software}
}

Other Papers

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. "Multidimensional analysis of the adult human heart in health and disease using hierarchical phase-contrast tomography." Radiology 312(1) (2024): e232731. 🗎

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.9.tar.gz (39.0 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.9-py3-none-any.whl (100.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cardiotensor-1.1.9.tar.gz
  • Upload date:
  • Size: 39.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for cardiotensor-1.1.9.tar.gz
Algorithm Hash digest
SHA256 b30a2b6453310e1510a6ac7db1b80e892befc28c32174eb173ba98585387b78b
MD5 c8afad8e40d50ddf33ceedd14e472ff6
BLAKE2b-256 d914f0ec715e73bc0a094b1e8174419d6c90a5b50371fec9d96777f5910264d9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cardiotensor-1.1.9-py3-none-any.whl
  • Upload date:
  • Size: 100.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for cardiotensor-1.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 712b4537d630a540e00af1ac9fccca25be20c6b1e13485f4c8c05a0841b30a9f
MD5 ab69e08d6f57fc96afd51a7fd6508aec
BLAKE2b-256 b9b829b95ea45fab070abd84d2962f3172065381b5edfc35c6ad8eac6252fdff

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