Skip to main content

Uniform MRI phantom analysis based using the PumpIA framework.

Project description

Introduction

This repository contains code to analyse a uniform phantom using the PumpIA framework. It uses the subtraction SNR method and therefore expects a repeat image, however the uniformity module will run with a single image.

It is currently not validated and is provided as is, see the license for more information.

The collection contains the following tests:

  • SNR
  • Uniformity

Usage

Users should make themselves familiar with the PumpIA user interface

To run the collection:

  1. Clone the repository
  2. Use an environment manager to install the requirements from requirements.txt or install the requirements using the command pip install -r requirements.txt when in the repository directory
  3. Run the run_uniform_rpt_collection.py script

OR

install from PyPI using pip:

pip install pumpia-uniform-phantom

And run using the commands pumpia-uniform-phantom (making sure you are in the right environment if used for the pip install).

To use the collection:

  1. Load the folder with the relevant images
  2. Drag and drop the series containing the relevant images into the viewer of the Main tab
  3. Generate the ROIs and run analysis
  4. Correct the context if required (see below)
    • Re-run generating ROIs
  5. Move any ROIs as required, this should be done through their relevant modules.
    • Re-run analysis
  6. Copy the results in the relevant format. Horizontal is tab separated, vertical is new line separated.

Correcting Context

The context used for this collection is the Auto Phantom Context Manager provided with PumpIA, see the relevant documentation for this.

Modules

Subtraction SNR

Calculates SNR based on the subtraction method. The ROI size is determined from the size input as a percentage of the phantom height and width. The ROI is always centred on the phantom. The following corrections can be applied:

  • Bandwidth
  • Pixel Size (includes slice width)
  • Number of Averages
  • Number of Phase Encode Steps

A button for showing the subtraction image is included.

Uniformity

This is calculated using the integral uniformity method. The size of the ROI is determined in the same way as the SNR module.

There is the option of applying a low pass kernel convolution to the image prior to calculation, this is defaulted to on. The kernel is defined by

1/16 2/16 1/16
2/16 4/16 2/16
1/16 2/16 1/16

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

pumpia_uniform_phantom-0.0.2.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

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

pumpia_uniform_phantom-0.0.2-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file pumpia_uniform_phantom-0.0.2.tar.gz.

File metadata

  • Download URL: pumpia_uniform_phantom-0.0.2.tar.gz
  • Upload date:
  • Size: 6.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pumpia_uniform_phantom-0.0.2.tar.gz
Algorithm Hash digest
SHA256 d36c01bf1e3a3bdc5fa9d0375110b7d7a664d473ec12a77e532aaa7dc1589d21
MD5 62c0186eeddeb75903f1c970a9e258d6
BLAKE2b-256 1071cd185ca08ca4d76dac7eb7b9aca31175ec0b641a451359b68737228a88e4

See more details on using hashes here.

Provenance

The following attestation bundles were made for pumpia_uniform_phantom-0.0.2.tar.gz:

Publisher: publish.yml on Principle-Five/pumpia-uniform-phantom

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

File details

Details for the file pumpia_uniform_phantom-0.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for pumpia_uniform_phantom-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b217a3a2518776f8938423a815bd9802174a4f06e288ad308ec0989c12cd4ff6
MD5 67b177d608513aabb0fb1ed66ce5dfe0
BLAKE2b-256 0de5a8772e02dd90afa6b3a9b63b495dbb13561ca5078ad516734806e72358f9

See more details on using hashes here.

Provenance

The following attestation bundles were made for pumpia_uniform_phantom-0.0.2-py3-none-any.whl:

Publisher: publish.yml on Principle-Five/pumpia-uniform-phantom

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