Skip to main content

No project description provided

Project description

Test and build GitHub Pages PyPI version shields.io PyPI status PyPI pyversions PyPI license

StrainMap

Copyright (c) 2022, Imperial College London All rights reserved.

StrainMap provides a user-friendly and efficient way to analyse MRI data acquired with a novel, high temporal and spatial resolution velocity-encoded MRI technique suitable for regional strain analysis in a short breath-hold. These images include magnitude and phase components.

The segmentation stage lets the user select the inner and outer walls of the heart. This needs to be done for all images taken over a heartbeat and for as many slices (cross-sections of the heart) as available. The process can be manual – very long – or assisted by several machine learning technologies such as snakes segmentation or a deep neural network. The segmented heart, together with the phase information can be used in the next stage to extract information of the instantaneous, spatially-resolved velocity of the myocardium during the heartbeat in the form of velocity curves ad heatmaps. All this information can be exported for further analysis elsewhere.

Installation

Recommended way

The recommended way for end users to access and use the tool is via pipx:

  1. Install and configure pipx following the instructions appropriate for your operative system. Make sure it works well before moving on.
  2. Install StrainMap with pipx install strainmap. It might take a while to complete, but afterwards updates should be pretty fast.
  3. To run StrainMap just open a terminal and execute strainmap. You might want to create a shortcut for this command in the desktop, for convenience.

Whenever there is a new version of StrainMap, just run pipx upgrade strainmap and it will be downloaded and installed with no fuss.

Use a StrainMap executable

Alternatively, you can download from the release page the self-contained executable corresponding to the version you are interested in. Bear in mind that these executables contain StrainMap and all its dependencies, meaning that each download can be, potentially, very large.

For developers

This installation instructions assume the following pre-requisites:

  • Python >=3.8
  • Poetry >= 1.11
  • Git

If these are already installed and the path correctly configured, the following should download the last version of StrainMap, create and activate a virtual environment, install all StrainMap dependencies and, finally, install StrainMap itself in development mode.

git clone https://github.com/ImperialCollegeLondon/strainmap.git
cd strainmap
poetry install

To use StrainMap simply run:

poetry run python -m strainmap

Related projects

The following two projects are standalone tools used to collect the data needed to train the AI used by StrainMap and re-train it, when needed. They are separate from StrainMap and are not required for using it.

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

StrainMap-1.2.6.tar.gz (90.9 kB view details)

Uploaded Source

Built Distribution

StrainMap-1.2.6-py3-none-any.whl (100.2 kB view details)

Uploaded Python 3

File details

Details for the file StrainMap-1.2.6.tar.gz.

File metadata

  • Download URL: StrainMap-1.2.6.tar.gz
  • Upload date:
  • Size: 90.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.9.7 Darwin/21.6.0

File hashes

Hashes for StrainMap-1.2.6.tar.gz
Algorithm Hash digest
SHA256 bfcb032dfe0aef83a80e15f98b8c769588a678061ec5b0b2bc906f017f75e768
MD5 3d5de6bc8da1269eebfadd23a3b7e005
BLAKE2b-256 b4358662755af45710a681a4e431843d3ab3f63a779bff86ba2c7503bb4cebcd

See more details on using hashes here.

File details

Details for the file StrainMap-1.2.6-py3-none-any.whl.

File metadata

  • Download URL: StrainMap-1.2.6-py3-none-any.whl
  • Upload date:
  • Size: 100.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.9.7 Darwin/21.6.0

File hashes

Hashes for StrainMap-1.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 e1509c490bdb9d818e0e7138172f0cd8aecbc80593d5fa38128c01796bff43ca
MD5 01c93d113ba8ec38dc3146b1cbfe077f
BLAKE2b-256 a2e3f9bc19a6448ee31823500a9d5f1c850356dc1104cb551192a124b3f78cb5

See more details on using hashes here.

Supported by

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