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!

SPIEPy (Scanning Probe Image Enchanter using Python) is a Python library to improve automatic processing of SPM images.

Project Description

Python is a great language to use for automatic processing of scientific data. Scanning probe microscopes (SPM) produce scientific data in the form of images, images of surfaces that can have atomic or molecular resolutions. The microscope produces surfaces that are not level. Before you can analyse the surface, the surface must first be levelled (flattened). This Python library provides routines to flatten the surface and to generate statistical data on surface structures. Surfaces with contaminations, step edges and atomic or molecular resolution can be handled.

SPIEPy and SPIW - MATLAB Toolbox [source] are related projects. SPIEPy uses many algorithms originally designed by the SPIW project. The performance of these algorithms is discussed in REVIEW OF SCIENTIFIC INSTRUMENTS 84, 113701 (2013) [DOI].

The library SPIEPy has the packages spiepy with the modules for the tasks described above and spiepy.demo to generate sample data. With this sample data, you can familiarize yourself with SPIEPy.


SPIEPy requires the NumPy library (, SciPy library ( and the Matplotlib library (


Using pip:

> pip install SPIEPy


SPIEPy_image_structure, set attribute data with a 2D ndarray of image data, set all other attributes with the metadata of the image.


Flattening functions:

  • flatten_by_iterate_mask
  • flatten_by_peaks
  • flatten_poly_xy
  • flatten_xy

Locating functions:

  • locate_masked_points_and_remove
  • locate_regions
  • locate_steps
  • locate_troughs_and_peaks

Masking functions:

  • mask_by_mean
  • mask_by_troughs_and_peaks
  • mask_tidy

Measuring functions:

  • measure_feature_properties

Demo functions:

  • list_demo_files
  • load_demo_file


Colormap which is the standard orange colormap used my most SPM software.


On the interpreter console use the built-in help function to get the help page of the module, function, …

>>> import spiepy, spiepy.demo
>>> help(spiepy)
>>> help(spiepy.demo)
>>> help(spiepy.flatten_by_iterate_mask)


Example usage

# -*- coding: utf-8 -*-
#   Copyright © 2014 - 2017 Stephan Zevenhuizen
#   Flattening terrace image, (09-10-2017).

import spiepy, spiepy.demo
import matplotlib.pyplot as plt
import numpy as np

im = spiepy.Im()
demos = spiepy.demo.list_demo_files()
print(demos) = spiepy.demo.load_demo_file(demos[1])

plt.imshow(, cmap = spiepy.NANOMAP, origin = 'lower')
print('Original image.')

im_out, _ = spiepy.flatten_xy(im)
plt.imshow(, cmap = spiepy.NANOMAP, origin = 'lower')
print('Preflattened image.')

mask = spiepy.locate_steps(im_out, 4)
plot_image =, mask = mask)
palette = spiepy.NANOMAP
palette.set_bad('#00ff00', 1.0)
plt.imshow(plot_image, cmap = palette, origin = 'lower')
print('Preflattened image, mask.')

im_final, _ = spiepy.flatten_xy(im, mask)
plt.imshow(, cmap = spiepy.NANOMAP, origin = 'lower')
print('Flattened image.')

y, x = np.histogram(, bins = 200)
ys, xs = np.histogram(, bins = 200)
fig, ax = plt.subplots()
ax.plot(x[:-1], y, '-b', label = 'Standard plane flattening')
ax.plot(xs[:-1], ys, '-r', label = 'SPIEPy stepped plane flattening')
ax.legend(loc = 2, fancybox = True, framealpha = 0.2)
ax.set_xlabel('z (nm)')

Authors & affiliations

Stephan J. M. Zevenhuizen [1]

[1]Condensed Matter and Interfaces, Debye Institute for Nanomaterials Science, Utrecht University, Utrecht, The Netherlands.
Release History

Release History

This version
History Node


History Node


History Node


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
SPIEPy-0.2.0-py2.py3-none-any.whl (4.4 MB) Copy SHA256 Checksum SHA256 py2.py3 Wheel Oct 9, 2017

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