Module and Function Reference#

PoreSpy#

PoreSpy is a package for performing image analysis on volumetric images of porous materials.

PoreSpy consists of several key modules. Each module is consisted of several functions. Here, you’ll find a comprehensive documentation of the modules, occasionally with basic embedded examples on how to use them.

porespy.generators

Collection of functions for generating synthetic images

porespy.filters

Collection of functions for altering images based on structural properties

porespy.metrics

Collection of functions for extracting quantitative information from images

porespy.networks

Collection of functions for obtaining network representations of images

porespy.simulations

Collection of functions for performing numerical simulations on images

porespy.tools

Collection of helper functions for manipulating images

porespy.visualization

Collection of functions for basic visualization of images

porespy.io

Collection of functions for importing and exporting images