TTK VTK-filter for the computation of an approximation of a persistence diagram. More...

#include <ttkPersistenceDiagramApproximation.h>

Inheritance diagram for ttkPersistenceDiagramApproximation:

Public Types
typedef ttkAlgorithm	Superclass

Public Types inherited from ttkAlgorithm
typedef vtkAlgorithm	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

virtual void	SetForceInputOffsetScalarField (bool)

virtual bool	GetForceInputOffsetScalarField ()

virtual void	SetShowInsideDomain (bool)

virtual bool	GetShowInsideDomain ()

virtual int	GetStartingResolutionLevel ()

virtual void	SetStartingResolutionLevel (int)

virtual int	GetStoppingResolutionLevel ()

virtual void	SetStoppingResolutionLevel (int)

virtual bool	GetIsResumable ()

virtual void	SetIsResumable (bool)

virtual double	GetTimeLimit ()

virtual void	SetTimeLimit (double)

virtual double	GetEpsilon ()

virtual void	SetEpsilon (double)

Public Member Functions inherited from ttkAlgorithm
void	UpdateThreadNumber ()

void	SetThreadNumber (int threadNumber)

void	SetUseAllCores (bool useAllCores)

void	SetDebugLevel (int debugLevel)

void	SetCompactTriangulationCacheSize (float cacheSize)

vtkDataArray *	GetOptionalArray (const bool &enforceArrayIndex, const int &arrayIndex, const std::string &arrayName, vtkDataSet *const inputData, const int &inputPort=0)

vtkDataArray *	GetOrderArray (vtkDataSet const inputData, const int scalarArrayIdx, ttk::Triangulation triangulation, const bool getGlobalOrder=false, const int orderArrayIdx=0, const bool enforceOrderArrayIdx=false)

vtkDataArray *	checkForGlobalAndComputeOrderArray (vtkDataSet const inputData, vtkDataArray scalarArray, const int scalarArrayIdx, const bool getGlobalOrder, vtkDataArray orderArray, ttk::Triangulation triangulation, const bool enforceOrderArrayIdx)

vtkDataArray *	ComputeOrderArray (vtkDataSet const inputData, vtkDataArray scalarArray, const int scalarArrayIdx, const bool getGlobalOrder, vtkDataArray oldOrderArray, ttk::Triangulation triangulation)

ttk::SimplexId *	GetIdentifierArrayPtr (const bool &enforceArrayIndex, const int &arrayIndex, const std::string &arrayName, vtkDataSet *const inputData, std::vector< ttk::SimplexId > &spareStorage, const int inputPort=0, const bool printErr=true)

ttk::Triangulation *	GetTriangulation (vtkDataSet *dataSet)

int	ProcessRequest (vtkInformation request, vtkInformationVector inputVectors, vtkInformationVector outputVector) override

vtkDataSet *	GetOutput ()

vtkDataSet *	GetOutput (int)

void	SetInputData (vtkDataSet *)

void	SetInputData (int, vtkDataSet *)

void	AddInputData (vtkDataSet *)

void	AddInputData (int, vtkDataSet *)

template<typename inputType >
int	checkEmptyMPIInput (inputType *input)
	This method tests whether the input is a nullptr. If the computation is being done on multiple processes, it is possible that the domain of one process or more is empty, but not others, therefore in that particular case the rest of the filter will not be computed but an error message will not be sent.

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)

Static Public Member Functions
static ttkPersistenceDiagramApproximation *	New ()

static int	IsTypeOf (const char *type)

static ttkPersistenceDiagramApproximation *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from ttkAlgorithm
static ttkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static ttkAlgorithm *	SafeDownCast (vtkObject *o)

static std::string	GetOrderArrayName (vtkDataArray *const array)

static vtkInformationIntegerKey *	SAME_DATA_TYPE_AS_INPUT_PORT ()

Protected Member Functions
	ttkPersistenceDiagramApproximation ()

int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override

int	FillInputPortInformation (int port, vtkInformation *info) override

int	FillOutputPortInformation (int port, vtkInformation *info) override

Protected Member Functions inherited from ttkAlgorithm
	ttkAlgorithm ()

	~ttkAlgorithm () override

void	MPIGhostPipelinePreconditioning (vtkDataSet *input)

void	MPIPipelinePreconditioning (vtkDataSet input, std::vector< int > &neighbors, std::map< int, int > &neighToId, ttk::Triangulation triangulation=nullptr)

bool	checkGlobalIdValidity (ttk::LongSimplexId globalIds, ttk::SimplexId simplexNumber, unsigned char ghost, int *rankArray)

int	GenerateGlobalIds (vtkDataSet *input, std::unordered_map< ttk::SimplexId, ttk::SimplexId > &vertGtoL, std::vector< int > &neighborRanks, std::map< int, int > &neighborsToId)

void	MPITriangulationPreconditioning (ttk::Triangulation triangulation, vtkDataSet input)

virtual int	RequestDataObject (vtkInformation request, vtkInformationVector inputVectors, vtkInformationVector outputVector)

virtual int	RequestInformation (vtkInformation ttkNotUsed(request), vtkInformationVector ttkNotUsed(inputVectors), vtkInformationVector ttkNotUsed(outputVector))

virtual int	RequestUpdateTime (vtkInformation ttkNotUsed(request), vtkInformationVector ttkNotUsed(inputVectors), vtkInformationVector ttkNotUsed(outputVector))

virtual int	RequestUpdateTimeDependentInformation (vtkInformation ttkNotUsed(request), vtkInformationVector ttkNotUsed(inputVectors), vtkInformationVector ttkNotUsed(outputVector))

virtual int	RequestUpdateExtent (vtkInformation ttkNotUsed(request), vtkInformationVector ttkNotUsed(inputVectors), vtkInformationVector ttkNotUsed(outputVector))

virtual int	RequestDataNotGenerated (vtkInformation ttkNotUsed(request), vtkInformationVector ttkNotUsed(inputVectors), vtkInformationVector ttkNotUsed(outputVector))

virtual int	RequestData (vtkInformation ttkNotUsed(request), vtkInformationVector ttkNotUsed(inputVectors), vtkInformationVector ttkNotUsed(outputVector))

int	FillInputPortInformation (int ttkNotUsed(port), vtkInformation *ttkNotUsed(info)) override

int	FillOutputPortInformation (int ttkNotUsed(port), vtkInformation *ttkNotUsed(info)) override

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 Member Functions inherited from ttk::PersistenceDiagram
	PersistenceDiagram ()

void	setBackend (const BACKEND be)

void	setComputeMinSad (const bool data)

void	setComputeSadSad (const bool data)

void	setComputeSadMax (const bool data)

template<typename scalarType , typename triangulationType >
void	augmentPersistenceDiagram (std::vector< PersistencePair > &persistencePairs, const scalarType const scalars, const triangulationType triangulation)
	Complete a ttk::DiagramType instance with scalar field values (useful for persistence) and 3D coordinates of critical vertices.

ttk::CriticalType	getNodeType (ftm::FTMTree_MT *tree, ftm::TreeType treeType, const SimplexId vertexId) const

void	sortPersistenceDiagram (std::vector< PersistencePair > &diagram, const SimplexId *const offsets) const

template<typename scalarType >
int	computeCTPersistenceDiagram (ftm::FTMTreePP &tree, const std::vector< std::tuple< ttk::SimplexId, ttk::SimplexId, scalarType, bool > > &pairs, std::vector< PersistencePair > &diagram) const

template<typename scalarType , class triangulationType >
int	execute (std::vector< PersistencePair > &CTDiagram, const scalarType inputScalars, const size_t scalarsMTime, const SimplexId inputOffsets, const triangulationType triangulation, const std::vector< bool > updateMask=nullptr)

template<typename scalarType , class triangulationType >
int	executeFTM (std::vector< PersistencePair > &CTDiagram, const scalarType inputScalars, const SimplexId inputOffsets, const triangulationType *triangulation)

template<class triangulationType >
int	executeProgressiveTopology (std::vector< PersistencePair > &CTDiagram, const SimplexId inputOffsets, const triangulationType triangulation)

template<typename scalarType , class triangulationType >
int	executeApproximateTopology (std::vector< PersistencePair > &CTDiagram, const scalarType inputScalars, const triangulationType triangulation)

template<class triangulationType >
int	executePersistentSimplex (std::vector< PersistencePair > &CTDiagram, const SimplexId inputOffsets, const triangulationType triangulation)

template<typename scalarType , class triangulationType >
int	executeDiscreteMorseSandwich (std::vector< PersistencePair > &CTDiagram, const scalarType inputScalars, const size_t scalarsMTime, const SimplexId inputOffsets, const triangulationType triangulation, const std::vector< bool > updateMask=nullptr)

template<class triangulationType >
void	checkProgressivityRequirement (const triangulationType *triangulation)

template<class triangulationType >
void	checkManifold (const triangulationType *const triangulation)

void	preconditionTriangulation (AbstractTriangulation *triangulation)

void	setOutputMonotonyOffsets (void *data)

void	setOutputOffsets (void *data)

void	setOutputScalars (void *data)

void	setDeltaApproximate (double data)

template<class triangulationType >
void	checkProgressivityRequirement (const triangulationType *ttkNotUsed(triangulation))

Additional Inherited Members
Protected Types inherited from ttk::PersistenceDiagram
enum class	BACKEND { FTM = 0 , PROGRESSIVE_TOPOLOGY = 1 , DISCRETE_MORSE_SANDWICH = 2 , APPROXIMATE_TOPOLOGY = 3 , PERSISTENT_SIMPLEX = 4 }

Protected Attributes inherited from ttkAlgorithm
float	CompactTriangulationCacheSize {0.2f}

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_

Protected Attributes inherited from ttk::PersistenceDiagram
bool	IgnoreBoundary {false}

ftm::FTMTreePP	contourTree_ {}

dcg::DiscreteGradient	dcg_ {}

PersistentSimplexPairs	psp_ {}

DiscreteMorseSandwich	dms_ {}

BACKEND	BackEnd {BACKEND::DISCRETE_MORSE_SANDWICH}

ttk::ProgressiveTopology	progT_ {}

ttk::ApproximateTopology	approxT_ {}

int	StartingResolutionLevel {0}

int	StoppingResolutionLevel {-1}

bool	IsResumable {false}

double	TimeLimit {}

void *	outputScalars_ {}

void *	outputOffsets_ {}

void *	outputMonotonyOffsets_ {}

double	Epsilon

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

Detailed Description

TTK VTK-filter for the computation of an approximation of a persistence diagram.

Parameters

Output

The output of this filter is composed of:

The approximation of the persistence diagram (VTU).
The corresponding approximation of the scalar field (VTI).
Uncertainty boumds on the correct localization of persistence pairs.

This filter can be used as any other VTK filter (for instance, by using the sequence of calls SetInputData(), Update(), GetOutput()).

Related publication
"Fast Approximation of Persistence Diagrams with Guarantees"
Jules Vidal, Julien Tierny
IEEE Symposium on Large Data Visualization and Analysis (LDAV), 2021

See also: ttk::ApproximateTopology; ttk::PersistenceDiagram

Online examples:

Author: Jules Vidal julie.nosp@m.n.ti.nosp@m.erny@.nosp@m.lip6.nosp@m..fr

Date: 2022.

This filter computes an approximation of the persistence diagram of the extremum-saddle pairs of an input scalar field. The approximation comes with a user-controlled error on the relative Bottleneck distance to the exact diagram.

Parameters

Input Input scalar field, either 2D or 3D. Must be a regular grid.

Definition at line 49 of file ttkPersistenceDiagramApproximation.h.

Member Typedef Documentation

◆ Superclass

typedef ttkAlgorithm ttkPersistenceDiagramApproximation::Superclass

Definition at line 56 of file ttkPersistenceDiagramApproximation.h.

Constructor & Destructor Documentation

◆ ttkPersistenceDiagramApproximation()

ttkPersistenceDiagramApproximation::ttkPersistenceDiagramApproximation ( )

protected

Definition at line 18 of file ttkPersistenceDiagramApproximation.cpp.

Member Function Documentation

◆ FillInputPortInformation()

int ttkPersistenceDiagramApproximation::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)

overrideprotected

Definition at line 23 of file ttkPersistenceDiagramApproximation.cpp.

◆ FillOutputPortInformation()

int ttkPersistenceDiagramApproximation::FillOutputPortInformation	(	int	port,
		vtkInformation *	info
	)

overrideprotected

Definition at line 32 of file ttkPersistenceDiagramApproximation.cpp.

◆ GetClassName()

virtual const char * ttkPersistenceDiagramApproximation::GetClassName ( )

virtual

Reimplemented from ttkAlgorithm.

◆ GetEpsilon()

virtual double ttkPersistenceDiagramApproximation::GetEpsilon ( )

virtual

◆ GetForceInputOffsetScalarField()

virtual bool ttkPersistenceDiagramApproximation::GetForceInputOffsetScalarField ( )

virtual

◆ GetIsResumable()

virtual bool ttkPersistenceDiagramApproximation::GetIsResumable ( )

virtual

◆ GetShowInsideDomain()

virtual bool ttkPersistenceDiagramApproximation::GetShowInsideDomain ( )

virtual

◆ GetStartingResolutionLevel()

virtual int ttkPersistenceDiagramApproximation::GetStartingResolutionLevel ( )

virtual

◆ GetStoppingResolutionLevel()

virtual int ttkPersistenceDiagramApproximation::GetStoppingResolutionLevel ( )

virtual

◆ GetTimeLimit()

virtual double ttkPersistenceDiagramApproximation::GetTimeLimit ( )

virtual

◆ IsA()

virtual int ttkPersistenceDiagramApproximation::IsA ( const char * type )

virtual

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

static int ttkPersistenceDiagramApproximation::IsTypeOf ( const char * type )

static

◆ New()

static ttkPersistenceDiagramApproximation * ttkPersistenceDiagramApproximation::New ( )

static

◆ RequestData()

int ttkPersistenceDiagramApproximation::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)

overrideprotected

Definition at line 114 of file ttkPersistenceDiagramApproximation.cpp.

◆ SafeDownCast()

static ttkPersistenceDiagramApproximation * ttkPersistenceDiagramApproximation::SafeDownCast ( vtkObject * o )

static

◆ SetEpsilon()

virtual void ttkPersistenceDiagramApproximation::SetEpsilon ( double )

virtual

◆ SetForceInputOffsetScalarField()

virtual void ttkPersistenceDiagramApproximation::SetForceInputOffsetScalarField ( bool )

virtual

◆ SetIsResumable()

virtual void ttkPersistenceDiagramApproximation::SetIsResumable ( bool )

virtual

◆ SetShowInsideDomain()

virtual void ttkPersistenceDiagramApproximation::SetShowInsideDomain ( bool )

virtual

◆ SetStartingResolutionLevel()

virtual void ttkPersistenceDiagramApproximation::SetStartingResolutionLevel ( int )

virtual

◆ SetStoppingResolutionLevel()

virtual void ttkPersistenceDiagramApproximation::SetStoppingResolutionLevel ( int )

virtual

◆ SetTimeLimit()

virtual void ttkPersistenceDiagramApproximation::SetTimeLimit ( double )

virtual

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

/home/julien/Pro/git/github/ttk-tierny/core/vtk/ttkPersistenceDiagramApproximation/ttkPersistenceDiagramApproximation.h
/home/julien/Pro/git/github/ttk-tierny/core/vtk/ttkPersistenceDiagramApproximation/ttkPersistenceDiagramApproximation.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ ttkPersistenceDiagramApproximation()

Member Function Documentation

◆ FillInputPortInformation()

◆ FillOutputPortInformation()

◆ GetClassName()

◆ GetEpsilon()

◆ GetForceInputOffsetScalarField()

◆ GetIsResumable()

◆ GetShowInsideDomain()

◆ GetStartingResolutionLevel()

◆ GetStoppingResolutionLevel()

◆ GetTimeLimit()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ RequestData()

◆ SafeDownCast()

◆ SetEpsilon()

◆ SetForceInputOffsetScalarField()

◆ SetIsResumable()

◆ SetShowInsideDomain()

◆ SetStartingResolutionLevel()

◆ SetStoppingResolutionLevel()

◆ SetTimeLimit()