Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

A collection of image analysis algorithms for X-ray tomographic images

Project Description

What is PoreSpy?

PoreSpy is a collection of algorithms used to extract information from 3D images of porous materials typically obtained from X-ray tomography. The package is still in early alpha stage and is subject to major changes in API.


One typical use of PoreSpy is to product a chord length distribution which gives an indication of the sizes of the void spaces in the materials {ref Torquato’s book}. This can be accomplished failry easily with PoreSpy using:

# Generate a test image of a sphere pack:
import scipy as sp
import scipy.image as spim
im = sp.rand(40, 40, 40) < 0.997
im = spim.distance_transform_bf(im) >= 4

# Import porespy and use it:
import porespy
a = porespy.cld(im)
cx = a.xdir(spacing=5, trim_edges=True)
cim = a.get_chords(direction='x', spacing=5, trim_edges=True)

# Visualize with Matplotlib
import matplotlib as plt
plt.subplot(2, 2, 1)
plt.imshow(im[:, :, 7])
plt.subplot(2, 2, 3)
plt.imshow(im[:, :, 7]*1.0 - cim[:, :, 7]*0.5)
plt.subplot(2, 2, 2)
plt.subplot(2, 2, 4)
Release History

Release History

This version
History Node


Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date (11.8 kB) Copy SHA256 Checksum SHA256 Source Jul 23, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting