porespy.metrics.is_percolating#
- porespy.metrics.is_percolating(im, axis=None, inlets=None, outlets=None, conn='min')#
Determines if a percolating path exists across the domain (in the specified direction) or between given inlets and outlets.
- Parameters:
im (ndarray) – Image of the void space with True indicating void space.
axis (int) – The axis along which percolation is checked. If None (default) then percolation is checked in all dimensions.
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.
- Returns:
percolating – A boolean value indicating if the domain percolates in the given direction. If axis=None then all directions are checked and the result is returned as a list like [True, False, True] indicating that the domain percolates in the x and z directions, but not y.
- Return type:
bool or list of bools
Examples
Click here to view online example.