persistence_graphical_tools Namespace Reference

Functions
def	plot_persistence_barcode (persistence=[], persistence_file='', alpha=0.6, max_barcodes=1000, inf_delta=0.1, legend=False)
def	plot_persistence_diagram (persistence=[], persistence_file='', alpha=0.6, band=0., max_plots=1000, inf_delta=0.1, legend=False)

Detailed Description

This file is part of the Gudhi Library. The Gudhi library
   (Geometric Understanding in Higher Dimensions) is a generic C++
   library for computational topology.

   Author(s):       Vincent Rouvreau, Bertrand Michel

   Copyright (C) 2016 Inria

   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.

Function Documentation

plot_persistence_barcode()

def persistence_graphical_tools.plot_persistence_barcode	(		persistence = [],
			persistence_file = '',
			alpha = 0.6,
			max_barcodes = 1000,
			inf_delta = 0.1,
			legend = False
	)

This function plots the persistence bar code from persistence values list
or from a :doc:`persistence file <fileformats>`.

:param persistence: Persistence values list.
:type persistence: list of tuples(dimension, tuple(birth, death)).
: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).
: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.
:type inf_delta: float.
:returns: A matplotlib object containing horizontal bar plot of persistence
    (launch `show()` method on it to display it).

plot_persistence_diagram()

def persistence_graphical_tools.plot_persistence_diagram	(		persistence = [],
			persistence_file = '',
			alpha = 0.6,
			band = 0.,
			max_plots = 1000,
			inf_delta = 0.1,
			legend = False
	)

This function plots the persistence diagram from persistence values list
or from a :doc:`persistence file <fileformats>`.

:param persistence: Persistence values list.
:type persistence: list of tuples(dimension, tuple(birth, death)).
:param persistence_file: A :doc:`persistence file <fileformats>` style name
    (reset persistence if both are set).
:type persistence_file: string
:param alpha: plot transparency value (0.0 transparent through 1.0 opaque - default is 0.6).
:type alpha: float.
:param band: band (not displayed if :math:`\leq` 0. - default is 0.)
:type band: float.
:param max_plots: 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)
: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.
:type inf_delta: float.
:returns: A matplotlib object containing diagram plot of persistence
    (launch `show()` method on it to display it).