Wiki

Clone wiki

spekpy_release / Home

Home, Further information, Function glossary, Release history, Publications using SpekPy

Welcome to the SpekPy homepage

What SpekPy is

What SpekPy is not

Try before you install

How to install SpekPy

How to use SpekPy

The software license

About us

Contacts

How to reference SpekPy

What SpekPy is

SpekPy is a powerful and free software toolkit for calculating and manipulating x-ray tube spectra. The code is written in the Python programming language. It can be used in a Python interpreter or from a Python script. For more information on SpekPy, please see Further information.

What SpekPy is not

SpekPy is a toolkit, not a command-line program or a piece of software with a fancy Graphical User Interface (i.e. a GUI). If you want to use it you will have to write a Python script or type commands yourself. Fortunately, SpekPy is easy to use and both it and Python are free.

SpekPy also isn't a "medical device" (or "software as a medical device"). This means that it shouldn't be used in any way that influences diagnosis, prevention, monitoring, prediction, prognosis, or treatment of human beings.

Try before you install

The following button launches a Jupyter notebook running SpekPy:

Binder

It can be slow to load, but gives you a chance to try before installing.

Tips:

  • Click on a code-block and press Run to run the code snippet

  • If the plot doesn't show after running the code-block, try pressing Run again

How to install SpekPy

General instructions

You can download it from here. Click on Source on the menu to the left to go to the source code. Then you can clone the git repository (click on the Clone button on that page for more info). Alternatively, you can download the software as a zip file by clicking on Downloads.

SpekPy is designed to be compatible with both Python2 (2.6 or higher) and Python3 (3.6 or higher). Note, however, that Python2 is officially depreciated by the Python Software Foundation as of 1st January 2020.

We typically install and uninstall SpekPy using the standard Python pip utility. You can do this by navigating to the SpekPy directory in a command window and typing:

pip install .

The package needs the standard NumPy and SciPy libraries. If these are not installed already, the SpekPy installation process will try to install them for you.

To be able to save spectrum states and create new filter materials, you need write permission for where you install. If you don't have admin rights on the account you want to use for SpekPy, you can try:

pip install . --user

This should install SpekPy to you local user space. You can probably successfully install SpekPy via running the setup.py script or easy_install. The latter is depreciated, however, and the former is less convenient if you want to uninstall/reinstall.

Advice for Anaconda Python

If you use Anaconda Python, it is good to be aware that in some cases pip and conda installations of packages can cause conflicts. We recommend creating a clean conda environment:

conda create -n spekpy-env python=3.7 numpy scipy matplotlib
before proceeding with:
conda activate spekpy-env
pip install .
Installing NumPy and SciPy first, using the conda installer, should ensure that you have no conflicts.

How to use SpekPy

Here's an example of some Python code:

#!python

import spekpy as sp

s = sp.Spek(kvp=80,th=12) # Generate a spectrum (80 kV, 12 degree tube angle)
s.filter('Al', 4.0) # Filter by 4 mm of Al

hvl = s.get_hvl1() # Get the 1st HVL in mm Al

print(hvl) # Print out the HVL value (Python3 syntax)

To see a complete list of SpekPy tools (methods and functions), please take a look at the Function glossary.

The software license

The software toolkit is available under the permissive MIT License. Yes, you could put it in your software application and make millions of dollars and not have to pay us a dime! Please do credit and reference us though.

About us

SpekPy was developed by Gavin Poludniowski and Robert Bujila with help from Artur Omar. The work was initiated (by GP) at the University of Surrey in the UK and continued in Sweden, at the Karolinska University Hospital (with RB and AO). Our academic associations are with Karolinska Universitet [KI] (both GP and AO) and the Royal Technical University [KTH] (RB). Robert Bujila has now moved to GE Healthcare (Waukesha, WI, USA).

Contacts

Drop me an email if you have a query, suggestion or have found a bug:

Email: gpoludniowski@gmail.com

Please do let us know about any bugs. You can either email or raise an issue using the Issues option in the left-hand panel.

How to reference SpekPy

Primary references

G Poludniowski, A Omar, R Bujila and P Andreo, Technical Note: SpekPy v2.0—a software toolkit for modeling x-ray tube spectra. Med Phys. 2021; https://doi.org/10.1002/mp.14945

R Bujila, A Omar and G Poludniowski, A validation of SpekPy: a software toolkit for modelling x-ray tube spectra. Phys Med. 2020; 75:44-54.

Secondary references

A Omar, P Andreo and G Poludniowski, A model for the energy and angular distribution of x rays emitted from an x-ray tube. Part I. Bremsstrahlung production. Med Phys. 2020; 47(10):4763-4774

A Omar, P Andreo and G Poludniowski, A model for the energy and angular distribution of x rays emitted from an x-ray tube. Part II. Validation of x-ray spectra from 20 to 300 kV. Med Phys. 2020; 47(9):4005-4019

A Omar, P Andreo and G Poludniowski, A model for the emission of K and L x rays from an x-ray tube. NIM B 2018; 437:36-47.

G Poludniowski, Calculation of x-ray spectra emerging from an x-ray tube. Part II. X-ray production and filtration in x-ray targets. Med Phys. 2007; 34(6):2175-86.

G Poludniowski and PM Evans, Calculation of x-ray spectra emerging from an x-ray tube. Part I. electron penetration characteristics in x-ray targets. Med Phys. 2007; 34(6):2164-74.

G Poludniowski, et al., SpekCalc: a program to calculate photon spectra from tungsten anode x-ray tubes. Phys Med Biol. 2009; 54(19):N433-8.

A Omar, P Andreo and G Poludniowski, Performance of different theories for the angular distribution of bremsstrahlung produced by keV electrons incident upon a target. Radiat. Phys. and Chem. 2018; 148:73-85.

Updated