Persistence graphical tools reference manual

gudhi.__min_birth_max_death()

This function returns (min_birth, max_death) from the persistence.

Parameters:
  • persistence (list of tuples(dimension, tuple(birth, death))) – The persistence to plot.
  • band (float.) – band
Returns:

(float, float) – (min_birth, max_death).
gudhi.plot_persistence_barcode()

This function plots the persistence bar code from persistence values list or from a persistence file.

Parameters:
  • persistence (list of tuples(dimension, tuple(birth, death))) – Persistence values list.
  • persistence_file (string) – A persistence file style name (reset persistence if both are set).
  • alpha (float.) – barcode transparency value (0.0 transparent through 1.0 opaque - default is 0.6).
  • max_barcodes (int.) – 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)
  • inf_delta (float.) – 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.
Returns:

A matplotlib object containing horizontal bar plot of persistence (launch show() method on it to display it).
gudhi.plot_persistence_diagram()

This function plots the persistence diagram from persistence values list or from a persistence file.

Parameters:
  • persistence (list of tuples(dimension, tuple(birth, death))) – Persistence values list.
  • persistence_file (string) – A persistence file style name (reset persistence if both are set).
  • alpha (float.) – plot transparency value (0.0 transparent through 1.0 opaque - default is 0.6).
  • band (float.) – band (not displayed if \(\leq\) 0. - default is 0.)
  • max_plots (int.) – number of maximal plots to be displayed Set it to 0 to see all, Default value is 1000. (persistence will be sorted by life time if max_plots is set)
  • inf_delta (float.) – 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.
Returns:

A matplotlib object containing diagram plot of persistence (launch show() method on it to display it).