Skip to main content

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.

Metadata

Release files for strainmap 1.2.9

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

Source distribution (sdist)

Source distribution for strainmap 1.2.9
File Size Uploaded
strainmap-1.2.9.tar.gz 90.5 kB Details

Built distribution (wheel)

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

Total release size: 191.0 kB

Release files / strainmap-1.2.9.tar.gz

Download URL strainmap-1.2.9.tar.gz
Size 90.5 kB
Tags Source
SHA-256 checksum
How to use checksums
628c40db2015ae6575c0f242172f181b298ea9c6a67b477e801b158f533459bf
BLAKE2b-256 checksum
How to use checksums
f80f63967bca3dc50f32d421186729f147621e51f5dc7e6539160a44c444cd53
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.1 CPython/3.11.2 Darwin/22.3.0

Release files / strainmap-1.2.9-py3-none-any.whl

Download URL strainmap-1.2.9-py3-none-any.whl
Size 100.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e45deb029c4da5d81cabe460e931355ac7149dde1e7c36a9a13d7bf8a3066502
BLAKE2b-256 checksum
How to use checksums
fad4c09d54649d6811753d90e3c06c952757d68d8257ae3ae5d28315c32030bb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.1 CPython/3.11.2 Darwin/22.3.0

Release history Release notifications | RSS feed

This release

1.2.9 This release

2 release files

1.2.8

2 release files

1.2.7

2 release files

1.2.6

2 release files

1.2.5

2 release files

1.2.4

2 release files

1.2.3

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.1

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