PumpIA documentation

Introduction

PumpIA is a python framework designed to allow users to visualise the analysis of images through a user interface. It does not do any image analysis itself, but rather provides a platform for users to write their own analysis code and view the results. This means that the full power of python and its libraries are available to the user.

Please note there isn’t a stable version (v1.0.0) yet, backwards compatibility breaks are instead denoted by the minor version.

Requirements

PumpIA has been designed to use the minimum number of dependencies, so the user interface relies on tkinter. PumpIA has the following dependencies:

• numpy

• scipy

• pillow

• pydicom

• matplotlib

See pydicom: Compression of Pixel Data for information on how to install the required libraries for reading compressed dicom files.

Installation

PumpIA requires python 3.12 or greater. To use PumpIA, install it using pip:

(.venv) $ pip install pumpia

Usage

See the sections usage for creating a module and collection, and user interface for how to use the user interface.

An example is provided, this is shown below.

Contents

• Core Components
  • The Manager
  • Viewers
  • Images
  • Regions of Interest
• Usage
  • Example
  • Modules
  • Module Inputs and Outputs
  • Collections
  • Context
  • The User Interface
• File Handling
  • General Image Handling
  • DICOM File Handling
  • DICOM Tags
• Utilities
  • Array Utilities
  • Feature Utilities
  • String Validators
  • Tkinter Utilities
  • File Utilities
• Widgets
  • Entry Boxes
  • Scrolled Window