minor tweaks to doc strings
@@ -6,7 +6,7 @@ import OpenPNM as op
from numba import jit
-def find_outer_regions(im, r=0):
+def find_outer_region(im, r=0):
r"""
Finds regions of the image that are outside of the solid matrix. This
function uses the rolling ball method to define where the outer region
@@ -22,14 +22,14 @@ def find_outer_regions(im, r=0):
Image of the porous material with 1's for void and 0's for solid
r : scalar
- The radius of the rolling ball to apply. If not specified the a value
+ The radius of the rolling ball to use. If not specified the a value
is calculated as twice maximum of the distance transform. The image
size is padded by this amount in all directions, so the image can
become quite large and unwieldy it too large a value is given.
Returns
-------
- A boolean mask the same shape as ```im```, containing True in all voxels
+ A boolean mask the same shape as ``im``, containing True in all voxels
identified as *outside* the sample.
"""
if r == 0:
@@ -104,7 +104,7 @@ def remove_floating_solid(im):
Parameters
----------
im : ND-array
- The image of the pore space, with zeros (or False) indicating the phase
+ The image of the pore space, with 0's (or False) indicating the phase
to be trimmed
"""
im = sp.array(im, dtype=bool)
