Skip to main content

Quantitative MRI processing

Project description

South Edinburgh Perfusion+ Analysis Library (SEPAL)

Please note: This library is also hosted in the OSIPI DCE-DSC-MRI_CodeCollection repository, where unit tests and perfusion code by other authors can also be found.

Python library for simulating and fitting DCE- and other quantitative MRI data. It permits arbitrary combinations of pulse sequence, pharmacokinetic model, water exchange model, etc. The code is a work-in-progress, has not been extensively tested and is not recommended or approved for clinical use.

Created 28 September 2020
@authors: Michael Thrippleton
@email: m.j.thrippleton@ed.ac.uk
@institution: University of Edinburgh, UK

Installation:

pip install sepal

Use:

Most functionality is demonstrated in Jupyter notebook format in ./demo

Functionality:

  • Enhancement-to-concentration conversion (assuming fast water exchange)
  • Fit tissue concentration using pharmacokinetic model
  • Fit signal enhancement using pharmacokinetic model
  • Pharmacokinetic models: steady-state, Patlak, extended Tofts, Tofts, 2CXM, 2CUM
  • Patlak fitting with multiple linear regression
  • AIFs: including patient-specific (measured), Parker, bi-exponential Parker, Georgiou
  • Fitting free AIF time delay parameter
  • Relaxivity models: linear
  • Signal models: spoiled gradient echo, inversion-recovery spin-echo
  • Water exchange models: FXL, NXL, NXL_be
  • T1 fitting using variable flip angle method, IR-SPGR, DESPOT1-HIFI and inversion recovery
  • T2(*) fitting for multi-TE acquisitions
  • MTR and MTSat calculation

Not yet implemented/limitations:

  • Additional pharmacokinetic models (add by inheriting from PkModel class)
  • Additional relaxivity models (add by inheriting from CRModel class)
  • Additional water exchange models, e.g. 3S2X, 2S1X (add by inheriting from WaterExModel class)
  • Additional signal models (add by inheriting from SignalModel class)
  • R2/R2* effects not included in fitting of enhancement curves (but is included for enhancement-to-concentration conversion)
  • Compartment-specific relaxivity parameters/models
  • Fitting water exchange parameters

Updates

Release 1.3.2 - further comments added to dce_fit demo notebook
Release 1.3.1 - Checking ve+vp<=1 can now be disabled
Release 1.2.1 - "Georgiou" AIF added to aifs module
Release 1.1.1 - roi_measure exclude NaNs when calculating percentiles
Release 1.1.0 - roi_measure modified to generate more ROI statistics
Release 1.0.3 - Add exception handling for some zero/negative inputs.
Release 1.0.2 - Changed AIF interpolation method to linear to further reduce oscillations.
Release 1.0.1 - Changed AIF interpolation method to avoid oscillations. Added demo notebook on interpolation.

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

sepal-1.3.2.tar.gz (43.5 MB view details)

Uploaded Source

Built Distribution

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

sepal-1.3.2-py3-none-any.whl (39.4 kB view details)

Uploaded Python 3

File details

Details for the file sepal-1.3.2.tar.gz.

File metadata

  • Download URL: sepal-1.3.2.tar.gz
  • Upload date:
  • Size: 43.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sepal-1.3.2.tar.gz
Algorithm Hash digest
SHA256 8a1957cd6baa7bb1550e4a662731ed6fe327ef27d7110cd1a03d18c1d3ca4126
MD5 5bcefc3a63ab97cf158eb01c61617e06
BLAKE2b-256 cb67e3dc0dc778636e3a1885d76726bffd7c328596d96cc28f6ad066a0acd7f3

See more details on using hashes here.

Provenance

The following attestation bundles were made for sepal-1.3.2.tar.gz:

Publisher: publish.yml on mjt320/SEPAL

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sepal-1.3.2-py3-none-any.whl.

File metadata

  • Download URL: sepal-1.3.2-py3-none-any.whl
  • Upload date:
  • Size: 39.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sepal-1.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 08588e82b7a7cb670cd69097ee4daaaf8fe3a72d5d5b2a6be472090c15a3884e
MD5 92e9b4eaa7a605bd1eff6f78a11f75a3
BLAKE2b-256 39a129cf72f4ba7504928270c504c1679afa08c86cbded7deb99ab9ad979182a

See more details on using hashes here.

Provenance

The following attestation bundles were made for sepal-1.3.2-py3-none-any.whl:

Publisher: publish.yml on mjt320/SEPAL

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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