porespy.metrics.percolating_porosity#

porespy.metrics.percolating_porosity(im, axis=0, inlets=None, outlets=None, conn='min')#

Finds volume fraction of void space which belongs to percolating paths across the domain in the direction specified.

Parameters:

  • im (ndarray) – Image of the void space with True indicating void space

  • axis (int) – The axis along which percolation is checked

  • conn (str) – Can be either ‘min’ or ‘max’ and controls the shape of the structuring element used to determine voxel connectivity. The default if ‘min’ which imposes the strictest criteria, so that voxels must share a face to be considered connected.

  • inlets (ndarray) – Boolean arrays indicating the locations of the inlets and outlets. These are useful if the domain is not cubic or if special inlet and outlet locations are desired.

  • outlets (ndarray) – Boolean arrays indicating the locations of the inlets and outlets. These are useful if the domain is not cubic or if special inlet and outlet locations are desired.

Examples

Click here to view online example.

On this page