TTK processing package for the computation of persistence curves. More...

#include <PersistenceCurve.h>

Inheritance diagram for ttk::PersistenceCurve:

Public Types
using	PlotType = std::vector< std::pair< double, SimplexId > >

Public Member Functions
	PersistenceCurve ()

int	execute (std::array< PlotType, 4 > &plots, const DiagramType &diagram) const
	Compute the Persistence Curve from the input Diagram.

Public Member Functions inherited from ttk::Debug
	Debug ()

	~Debug () override

virtual int	setDebugLevel (const int &debugLevel)

int	setWrapper (const Wrapper *wrapper) override

int	printMsg (const std::string &msg, const debug::Priority &priority=debug::Priority::INFO, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const

int	printMsg (const std::vector< std::string > &msgs, const debug::Priority &priority=debug::Priority::INFO, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const

int	printErr (const std::string &msg, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cerr) const

int	printWrn (const std::string &msg, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cerr) const

int	printMsg (const std::string &msg, const double &progress, const double &time, const int &threads, const double &memory, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const

int	printMsg (const std::string &msg, const double &progress, const double &time, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const

int	printMsg (const std::string &msg, const double &progress, const double &time, const int &threads, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const

int	printMsg (const std::string &msg, const double &progress, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const

int	printMsg (const std::string &msg, const double &progress, const debug::Priority &priority, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const

int	printMsg (const std::vector< std::vector< std::string > > &rows, const debug::Priority &priority=debug::Priority::INFO, const bool hasHeader=true, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const

int	printMsg (const debug::Separator &separator, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::INFO, std::ostream &stream=std::cout) const

int	printMsg (const debug::Separator &separator, const debug::Priority &priority, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const

int	printMsg (const std::string &msg, const debug::Separator &separator, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::INFO, std::ostream &stream=std::cout) const

void	setDebugMsgPrefix (const std::string &prefix)

Public Member Functions inherited from ttk::BaseClass
	BaseClass ()

virtual	~BaseClass ()=default

int	getThreadNumber () const

virtual int	setThreadNumber (const int threadNumber)

virtual int	setWrapper (const Wrapper *wrapper)

Additional Inherited Members
Protected Member Functions inherited from ttk::Debug
int	printMsgInternal (const std::string &msg, const std::string &right, const std::string &filler, const debug::Priority &priority=debug::Priority::INFO, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const

int	printMsgInternal (const std::string &msg, const debug::Priority &priority, const debug::LineMode &lineMode, std::ostream &stream=std::cout) const

int	welcomeMsg (std::ostream &stream)

Protected Attributes inherited from ttk::Debug
int	debugLevel_

std::string	debugMsgPrefix_

std::string	debugMsgNamePrefix_

Protected Attributes inherited from ttk::BaseClass
bool	lastObject_

int	threadNumber_

Wrapper *	wrapper_

Static Protected Attributes inherited from ttk::Debug
static COMMON_EXPORTS debug::LineMode	lastLineMode = ttk::debug::LineMode::NEW

Detailed Description

TTK processing package for the computation of persistence curves.

Author: Guillaume Favelier guill.nosp@m.aume.nosp@m..fave.nosp@m.lier.nosp@m.@lip6.nosp@m..fr; Julien Tierny julie.nosp@m.n.ti.nosp@m.erny@.nosp@m.lip6.nosp@m..fr; Pierre Guillou pierr.nosp@m.e.gu.nosp@m.illou.nosp@m.@lip.nosp@m.6.fr

Date: September 2016.

This package takes a ttk::DiagramType as input and computes the number of pairs as a function of persistence (i.e. the number of pairs whose persistence is higher than a threshold).

These curves provide useful visual clues in order to fine-tune persistence simplification thresholds.

See also: ttkPersistenceCurve.cpp for a usage example.

Online examples:

Definition at line 39 of file PersistenceCurve.h.

Member Typedef Documentation

◆ PlotType

using ttk::PersistenceCurve::PlotType = std::vector<std::pair<double, SimplexId> >

Plot of (Persistence, Number of Pairs)

Definition at line 46 of file PersistenceCurve.h.

Constructor & Destructor Documentation

◆ PersistenceCurve()

ttk::PersistenceCurve::PersistenceCurve ( )

Definition at line 4 of file PersistenceCurve.cpp.

Member Function Documentation

◆ execute()

int ttk::PersistenceCurve::execute	(	std::array< PlotType, 4 > &	plots,
		const DiagramType &	diagram
	)		const

Compute the Persistence Curve from the input Diagram.

Parameters

[out]	plots	Array of 4 PlotTypes: minimum-saddle plot, saddle-saddle plot, saddle-maximum plot and all pairs plot
[in]	diagram	Input Persistence Diagram

Returns: 0 in case of success

Definition at line 8 of file PersistenceCurve.cpp.

The documentation for this class was generated from the following files:

/home/julien/Pro/git/github/ttk-tierny/core/base/persistenceCurve/PersistenceCurve.h
/home/julien/Pro/git/github/ttk-tierny/core/base/persistenceCurve/PersistenceCurve.cpp

Public Types

Public Member Functions