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:
- Clone the repository
- Use an environment manager to install the requirements from
requirements.txtor install the requirements using the commandpip install -r requirements.txtwhen in the repository directory - Run the
run_uniform_rpt_collection.pyscript
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:
- Load the folder with the relevant images
- Drag and drop the series containing the relevant images into the viewer of the
Maintab - Generate the ROIs and run analysis
- Correct the context if required (see below)
- Re-run generating ROIs
- Move any ROIs as required, this should be done through their relevant modules.
- Re-run analysis
- 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d36c01bf1e3a3bdc5fa9d0375110b7d7a664d473ec12a77e532aaa7dc1589d21
|
|
| MD5 |
62c0186eeddeb75903f1c970a9e258d6
|
|
| BLAKE2b-256 |
1071cd185ca08ca4d76dac7eb7b9aca31175ec0b641a451359b68737228a88e4
|
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
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pumpia_uniform_phantom-0.0.2.tar.gz -
Subject digest:
d36c01bf1e3a3bdc5fa9d0375110b7d7a664d473ec12a77e532aaa7dc1589d21 - Sigstore transparency entry: 1817045993
- Sigstore integration time:
-
Permalink:
Principle-Five/pumpia-uniform-phantom@aeb50fc15a62237fdc385ac4beb13952953e50b7 -
Branch / Tag:
refs/tags/v0.0.2 - Owner: https://github.com/Principle-Five
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@aeb50fc15a62237fdc385ac4beb13952953e50b7 -
Trigger Event:
release
-
Statement type:
File details
Details for the file pumpia_uniform_phantom-0.0.2-py3-none-any.whl.
File metadata
- Download URL: pumpia_uniform_phantom-0.0.2-py3-none-any.whl
- Upload date:
- Size: 9.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b217a3a2518776f8938423a815bd9802174a4f06e288ad308ec0989c12cd4ff6
|
|
| MD5 |
67b177d608513aabb0fb1ed66ce5dfe0
|
|
| BLAKE2b-256 |
0de5a8772e02dd90afa6b3a9b63b495dbb13561ca5078ad516734806e72358f9
|
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
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pumpia_uniform_phantom-0.0.2-py3-none-any.whl -
Subject digest:
b217a3a2518776f8938423a815bd9802174a4f06e288ad308ec0989c12cd4ff6 - Sigstore transparency entry: 1817046152
- Sigstore integration time:
-
Permalink:
Principle-Five/pumpia-uniform-phantom@aeb50fc15a62237fdc385ac4beb13952953e50b7 -
Branch / Tag:
refs/tags/v0.0.2 - Owner: https://github.com/Principle-Five
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@aeb50fc15a62237fdc385ac4beb13952953e50b7 -
Trigger Event:
release
-
Statement type: