ttkPersistenceDiagramUtils.h File Reference

#include <Debug.h>
#include <PersistenceDiagramUtils.h>
#include <ttkPersistenceDiagramModule.h>

Go to the source code of this file.

Functions
TTKPERSISTENCEDIAGRAM_EXPORT int	VTUToDiagram (ttk::DiagramType &diagram, vtkUnstructuredGrid *vtu, const ttk::Debug &dbg)
	Converts a Persistence Diagram in the VTK Unstructured Grid format (as generated by the ttkPersistenceDiagram module) to the ttk::DiagramType format.
TTKPERSISTENCEDIAGRAM_EXPORT int	DiagramToVTU (vtkUnstructuredGrid *vtu, const ttk::DiagramType &diagram, vtkDataArray *const inputScalars, const ttk::Debug &dbg, const int dim, const bool embedInDomain)
	Converts a Persistence Diagram in the ttk::DiagramType format to the VTK Unstructured Grid format (as generated by the ttkPersistenceDiagram module).
TTKPERSISTENCEDIAGRAM_EXPORT int	ProjectDiagramInsideDomain (vtkUnstructuredGrid *const inputDiagram, vtkUnstructuredGrid *const outputDiagram, const ttk::Debug &dbg)
	Generate the spatial embedding of a given Persistence Diagram.
TTKPERSISTENCEDIAGRAM_EXPORT int	ProjectDiagramIn2D (vtkUnstructuredGrid *const inputDiagram, vtkUnstructuredGrid *const outputDiagram, const ttk::Debug &dbg)
	Generate the 2D embedding of a given Persistence Diagram.
TTKPERSISTENCEDIAGRAM_EXPORT int	TranslateDiagram (vtkUnstructuredGrid *const diagram, const std::array< double, 3 > &trans)
	Translate a diagram to a new position.
TTKPERSISTENCEDIAGRAM_EXPORT int	ResetDiagramPosition (vtkUnstructuredGrid *const diagram, const ttk::Debug &dbg)
	Translate back a canonical diagram into its original position.

Function Documentation

DiagramToVTU()

TTKPERSISTENCEDIAGRAM_EXPORT int DiagramToVTU	(	vtkUnstructuredGrid *	vtu,
		const ttk::DiagramType &	diagram,
		vtkDataArray *const	inputScalars,
		const ttk::Debug &	dbg,
		const int	dim,
		const bool	embedInDomain
	)

Converts a Persistence Diagram in the ttk::DiagramType format to the VTK Unstructured Grid format (as generated by the ttkPersistenceDiagram module).

Parameters

[out]	vtu	Output VTK Unstructured Grid
[in]	diagram	Vector of persistence pairs
[in]	inputScalars	vtkDataArray pointer to input scalar field
[in]	dbg	Reference to a ttk::Debug instance (for error messages)
[in]	dim	Data-set dimensionality (to convert pair dimension to pair type)
[in]	embedInDomain	Switch between the canonical and the embedded representation

Returns

0 in case of success, negative number otherwise

Definition at line 156 of file ttkPersistenceDiagramUtils.cpp.

ProjectDiagramIn2D()

TTKPERSISTENCEDIAGRAM_EXPORT int ProjectDiagramIn2D	(	vtkUnstructuredGrid *const	inputDiagram,
		vtkUnstructuredGrid *const	outputDiagram,
		const ttk::Debug &	dbg
	)

Generate the 2D embedding of a given Persistence Diagram.

Use the cellData arrays Birth and Death to project the Diagram

Parameters

[in]	inputDiagram	Input diagram in its spatial embedding form
[out]	outputDiagram	Projected diagram in its canonical form
[in]	dbg	Debug instance (for logging and access to threadNumber_)

Returns

0 in case of success

Definition at line 375 of file ttkPersistenceDiagramUtils.cpp.

ProjectDiagramInsideDomain()

TTKPERSISTENCEDIAGRAM_EXPORT int ProjectDiagramInsideDomain	(	vtkUnstructuredGrid *const	inputDiagram,
		vtkUnstructuredGrid *const	outputDiagram,
		const ttk::Debug &	dbg
	)

Generate the spatial embedding of a given Persistence Diagram.

Use the pointData array Coordinates to project the Diagram

Parameters

[in]	inputDiagram	Input diagram in its canonical form
[out]	outputDiagram	Projected diagram inside the input domain
[in]	dbg	Debug instance (for logging and access to threadNumber_)

Returns

0 in case of success

Definition at line 302 of file ttkPersistenceDiagramUtils.cpp.

ResetDiagramPosition()

TTKPERSISTENCEDIAGRAM_EXPORT int ResetDiagramPosition	(	vtkUnstructuredGrid *const	diagram,
		const ttk::Debug &	dbg
	)

Translate back a canonical diagram into its original position.

Use the cellData array Birth as original coordinates

Parameters

[in,out]	diagram	Input diagram in its spatial embedding form
[in]	dbg	Debug instance (for logging and access to threadNumber_)

Returns

0 in case of success

Definition at line 467 of file ttkPersistenceDiagramUtils.cpp.

TranslateDiagram()

TTKPERSISTENCEDIAGRAM_EXPORT int TranslateDiagram	(	vtkUnstructuredGrid *const	diagram,
		const std::array< double, 3 > &	trans
	)

Translate a diagram to a new position.

Parameters

[in,out]	diagram	Input diagram in its spatial embedding form
[in]	trans	Translation vector

Returns

0 in case of success

Definition at line 448 of file ttkPersistenceDiagramUtils.cpp.

VTUToDiagram()

TTKPERSISTENCEDIAGRAM_EXPORT int VTUToDiagram	(	ttk::DiagramType &	diagram,
		vtkUnstructuredGrid *	vtu,
		const ttk::Debug &	dbg
	)

Converts a Persistence Diagram in the VTK Unstructured Grid format (as generated by the ttkPersistenceDiagram module) to the ttk::DiagramType format.

Parameters

[out]	diagram	Vector to be filled with persistence pairs
[in]	vtu	Input VTK Unstructured Grid
[in]	dbg	Reference to a ttk::Debug instance (for error messages)

Returns

0 in case of success, negative number otherwise

Definition at line 16 of file ttkPersistenceDiagramUtils.cpp.