diff options
| author | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2018-08-17 13:45:08 +0000 |
|---|---|---|
| committer | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2018-08-17 13:45:08 +0000 |
| commit | 24c661e98b8f8e0f2c492fcf63e68615dbd9ae84 (patch) | |
| tree | 58dca1508fc9be9f547c86d81bce790e1089728a | |
| parent | a5464d68d2848d21fc777809ab686b1bbf4e0139 (diff) | |
Doc review : inf_delta explanation improvement
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/plot_persistence_density_vincent@3800 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 01fff74d79228431d77a46b713ac656ab7e84dc0
| -rwxr-xr-x | src/cython/cython/persistence_graphical_tools.py | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/src/cython/cython/persistence_graphical_tools.py b/src/cython/cython/persistence_graphical_tools.py index 026e365d..4c8467bd 100755 --- a/src/cython/cython/persistence_graphical_tools.py +++ b/src/cython/cython/persistence_graphical_tools.py @@ -71,14 +71,16 @@ try: :param persistence_file: A :doc:`persistence file <fileformats>` style name (reset persistence if both are set). :type persistence_file: string - :param alpha: barcode transparency value (0.0 transparent through 1.0 opaque - default is 0.6). + :param alpha: barcode transparency value (0.0 transparent through 1.0 + opaque - default is 0.6). :type alpha: float. :param max_barcodes: number of maximal barcodes to be displayed. Set it to 0 to see all, Default value is 1000. (persistence will be sorted by life time if max_barcodes is set) :type max_barcodes: int. - :param inf_delta: Infinity is placed at ((max_death - min_birth) x inf_delta). - A reasonable value is between 0.05 and 0.5 - default is 0.1. + :param inf_delta: Infinity is placed at ((max_death - min_birth) x + inf_delta) above the highest point. A reasonable value is between + 0.05 and 0.5 - default is 0.1. :type inf_delta: float. :param legend: Display the dimension color legend (default is False). :type legend: boolean. @@ -155,8 +157,9 @@ try: are those with the longest life time. Set it to 0 to see all, default value is 1000. :type max_plots: int. - :param inf_delta: Infinity is placed at ((max_death - min_birth) x inf_delta). - A reasonable value is between 0.05 and 0.5 - default is 0.1. + :param inf_delta: Infinity is placed at ((max_death - min_birth) x + inf_delta) above the highest point. A reasonable value is between + 0.05 and 0.5 - default is 0.1. :type inf_delta: float. :param legend: Display the dimension color legend (default is False). :type legend: boolean. |