Skip to content

Commit

Permalink
Clarified porespace docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
Federico Semeraro committed Aug 23, 2021
1 parent 8609233 commit a8f0c83
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions python/pumapy/segmentation/porespace.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ def identify_porespace(workspace, solid_cutoff):
:type workspace: Workspace
:param solid_cutoff: specify the solid range to discard from pores identification
:type solid_cutoff: tuple(int, int)
:return: porespace marked as: 0 solid, 1 largest pore (likely open porosity), > 1 other pores
:return: porespace marked as: 0 solid, 1 largest pore (likely open porosity), >1 other pores
:rtype: ndarray
"""

Expand Down Expand Up @@ -43,9 +43,9 @@ def fill_closed_pores(workspace, solid_cutoff, fill_value, return_pores=False):
:type fill_value: int
:param return_pores: specifies whether to return identified pores
:type return_pores: bool, optional
:return: new workspace with filled closed porosity
(if return_pores==True, then it also returns the porespace marked as:
0 solid, 1 largest pore (likely open porosity), > 1 other pores)
:return: filled workspace with IDs set as: 0 for void, 1 for solid, fill_value for
added filler material. In addition, if return_pores==True, then it also returns
the porespace marked as: 0 solid, 1 largest pore (likely open porosity), >1 other pores
:rtype: Workspace
"""

Expand Down

0 comments on commit a8f0c83

Please sign in to comment.