TTK VTK-filter that wraps the ttk::SeparatrixStability module. More...

#include <ttkSeparatrixStability.h>

Inheritance diagram for ttkSeparatrixStability:

Public Types
typedef ttkAlgorithm	Superclass

Public Types inherited from ttkAlgorithm
typedef vtkAlgorithm	Superclass

Public Member Functions
virtual void	SetPX (double)

virtual double	GetPX ()

virtual void	SetPY (double)

virtual double	GetPY ()

virtual void	SetPZ (double)

virtual double	GetPZ ()

virtual void	SetPF (double)

virtual double	GetPF ()

virtual void	SetMergeEdgesOnSaddles (bool)

virtual bool	GetMergeEdgesOnSaddles ()

virtual void	SetCostDeathBirth (double)

virtual double	GetCostDeathBirth ()

virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

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 ttkSeparatrixStability *	New ()

static int	IsTypeOf (const char *type)

static ttkSeparatrixStability *	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
	ttkSeparatrixStability ()

	~ttkSeparatrixStability () override=default

int	FillInputPortInformation (int port, vtkInformation *info) override

int	FillOutputPortInformation (int port, vtkInformation *info) override

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

int	execute (vtkMultiBlockDataSet &multiBlock1_Separatrices, vtkMultiBlockDataSet &output1_Separatrices)

bool	updateVisitedVertices (const int &globalId, std::vector< int > &localToGlobal, int &localId)

void	computePointIds (const int &cellId_1, const int &cellId_2, const int &sourceGlobalId, const int &destinationGlobalId, vtkDataSet *block, vtkIdType &srcPointId, vtkIdType &destPointId)

void	updateAdjacencyMatrix (const int &sourceLocalId, const int &destinationLocalId, const int &separatrixLocalId, GraphMatrixFull &adjacencyMatrix)

void	appendPoint (vtkPoints *points, const int &index, const double &scalar, std::vector< std::array< double, 3 > > &coords, std::vector< double > &scalars)

int	prepareData (vtkDataSet *block, std::vector< int > &localToGlobal, GraphMatrixFull &adjacencyMatrixFull, std::vector< std::array< double, 3 > > &coordsSource, std::vector< std::array< double, 3 > > &coordsDestination, std::vector< double > &scalarsSource, std::vector< double > &scalarsDestinatoin, int &n_separatrices, std::vector< int > &globalSourcePointId, std::vector< int > &globalDestinationPointId)

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::SeparatrixStability
	SeparatrixStability ()

int	buildOccurrenceArrays (const std::vector< GraphMatrixFull > &adjacencyMatrices, const std::vector< int > &separatrixCountForEachBlock, const std::vector< std::vector< std::array< double, 3 > > > &coordsSource, const std::vector< std::vector< std::array< double, 3 > > > &coordsDestination, const std::vector< std::vector< double > > &scalarsSource, const std::vector< std::vector< double > > &scalarsDestination, const bool &mergeEdgesOnSaddles, std::vector< std::vector< int > > &edgesOccurrencesForEachBlock, std::vector< std::vector< bool > > &isomorphismForEachBlock, std::vector< std::vector< std::vector< int > > > &matchingArrayForEachBlockSource, std::vector< std::vector< std::vector< int > > > &matchingArrayForEachBlockDestination, std::vector< std::vector< std::vector< int > > > &matchingArraySeparatrixForEachBlock)

void	setEpsilon (double e)

void	setWeights (const double &px, const double &py, const double &pz, const double &pf)

Additional Inherited Members
Protected Types inherited from ttk::SeparatrixStability
using	GraphMatrixMinor = std::vector<std::vector<std::vector<std::pair<int, int>>>>

using	GraphMatrixFull = std::vector<std::vector<int>>

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_

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

Detailed Description

TTK VTK-filter that wraps the ttk::SeparatrixStability module.

Author: Thomas Daniel thoma.nosp@m.s.da.nosp@m.niel1.nosp@m.24@g.nosp@m.mail..nosp@m.com

Date: July 2025.

It takes as an input a vtkMultiBlockDataSet representing the 1-dimensional separatrices of the Morse-Smale complex for an ensemble dataset. It computes as an output, a copy of the input, with for each separatrix, its rate of occurrence in the ensemble (based on partial isomorphism computations).

See also: ttk::SeparatrixStability; ttkAlgorithm

Online examples:

Molecular Vibration example

Related publication:
"BondMatcher: H-Bond Stability Analysis in Molecular Systems"
Thomas Daniel, Malgorzata Olejniczak, Julien Tierny
IEEE Transactions on Visualization and Computer Graphics
Proc. of IEEE VIS 2025.

Definition at line 38 of file ttkSeparatrixStability.h.

Member Typedef Documentation

◆ Superclass

typedef ttkAlgorithm ttkSeparatrixStability::Superclass

Definition at line 70 of file ttkSeparatrixStability.h.

Constructor & Destructor Documentation

◆ ttkSeparatrixStability()

ttkSeparatrixStability::ttkSeparatrixStability ( )

protected

Definition at line 25 of file ttkSeparatrixStability.cpp.

◆ ~ttkSeparatrixStability()

ttkSeparatrixStability::~ttkSeparatrixStability ( )

overrideprotecteddefault

Member Function Documentation

◆ appendPoint()

void ttkSeparatrixStability::appendPoint	(	vtkPoints *	points,
		const int &	index,
		const double &	scalar,
		std::vector< std::array< double, 3 > > &	coords,
		std::vector< double > &	scalars )

protected

Definition at line 132 of file ttkSeparatrixStability.cpp.

◆ computePointIds()

void ttkSeparatrixStability::computePointIds	(	const int &	cellId_1,
		const int &	cellId_2,
		const int &	sourceGlobalId,
		const int &	destinationGlobalId,
		vtkDataSet *	block,
		vtkIdType &	srcPointId,
		vtkIdType &	destPointId )

protected

Definition at line 96 of file ttkSeparatrixStability.cpp.

◆ execute()

int ttkSeparatrixStability::execute	(	vtkMultiBlockDataSet *&	multiBlock1_Separatrices,
		vtkMultiBlockDataSet *&	output1_Separatrices )

protected

Definition at line 236 of file ttkSeparatrixStability.cpp.

◆ FillInputPortInformation()

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

overrideprotected

Definition at line 30 of file ttkSeparatrixStability.cpp.

◆ FillOutputPortInformation()

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

overrideprotected

Definition at line 39 of file ttkSeparatrixStability.cpp.

◆ GetClassName()

virtual const char * ttkSeparatrixStability::GetClassName ( )

virtual

Reimplemented from ttkAlgorithm.

◆ GetCostDeathBirth()

virtual double ttkSeparatrixStability::GetCostDeathBirth ( )

virtual

◆ GetMergeEdgesOnSaddles()

virtual bool ttkSeparatrixStability::GetMergeEdgesOnSaddles ( )

virtual

◆ GetPF()

virtual double ttkSeparatrixStability::GetPF ( )

virtual

◆ GetPX()

virtual double ttkSeparatrixStability::GetPX ( )

virtual

◆ GetPY()

virtual double ttkSeparatrixStability::GetPY ( )

virtual

◆ GetPZ()

virtual double ttkSeparatrixStability::GetPZ ( )

virtual

◆ IsA()

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

virtual

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

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

static

◆ New()

static ttkSeparatrixStability * ttkSeparatrixStability::New ( )

static

◆ prepareData()

int ttkSeparatrixStability::prepareData	(	vtkDataSet *	block,
		std::vector< int > &	localToGlobal,
		GraphMatrixFull &	adjacencyMatrixFull,
		std::vector< std::array< double, 3 > > &	coordsSource,
		std::vector< std::array< double, 3 > > &	coordsDestination,
		std::vector< double > &	scalarsSource,
		std::vector< double > &	scalarsDestinatoin,
		int &	n_separatrices,
		std::vector< int > &	globalSourcePointId,
		std::vector< int > &	globalDestinationPointId )

protected

Definition at line 144 of file ttkSeparatrixStability.cpp.

◆ RequestData()

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

overrideprotected

Definition at line 439 of file ttkSeparatrixStability.cpp.

◆ SafeDownCast()

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

static

◆ SetCostDeathBirth()

virtual void ttkSeparatrixStability::SetCostDeathBirth ( double )

virtual

◆ SetMergeEdgesOnSaddles()

virtual void ttkSeparatrixStability::SetMergeEdgesOnSaddles ( bool )

virtual

◆ SetPF()

virtual void ttkSeparatrixStability::SetPF ( double )

virtual

◆ SetPX()

virtual void ttkSeparatrixStability::SetPX ( double )

virtual

◆ SetPY()

virtual void ttkSeparatrixStability::SetPY ( double )

virtual

◆ SetPZ()

virtual void ttkSeparatrixStability::SetPZ ( double )

virtual

◆ updateAdjacencyMatrix()

void ttkSeparatrixStability::updateAdjacencyMatrix	(	const int &	sourceLocalId,
		const int &	destinationLocalId,
		const int &	separatrixLocalId,
		GraphMatrixFull &	adjacencyMatrix )

protected

Definition at line 64 of file ttkSeparatrixStability.cpp.

◆ updateVisitedVertices()

bool ttkSeparatrixStability::updateVisitedVertices	(	const int &	globalId,
		std::vector< int > &	localToGlobal,
		int &	localId )

protected

Definition at line 48 of file ttkSeparatrixStability.cpp.

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

/home/julien/Pro/git/github/thomas/ttk-dani/core/vtk/ttkSeparatrixStability/ttkSeparatrixStability.h
/home/julien/Pro/git/github/thomas/ttk-dani/core/vtk/ttkSeparatrixStability/ttkSeparatrixStability.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

◆ ttkSeparatrixStability()

◆ ~ttkSeparatrixStability()

Member Function Documentation

◆ appendPoint()

◆ computePointIds()

◆ execute()

◆ FillInputPortInformation()

◆ FillOutputPortInformation()

◆ GetClassName()

◆ GetCostDeathBirth()

◆ GetMergeEdgesOnSaddles()

◆ GetPF()

◆ GetPX()

◆ GetPY()

◆ GetPZ()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ prepareData()

◆ RequestData()

◆ SafeDownCast()

◆ SetCostDeathBirth()

◆ SetMergeEdgesOnSaddles()

◆ SetPF()

◆ SetPX()

◆ SetPY()

◆ SetPZ()

◆ updateAdjacencyMatrix()

◆ updateVisitedVertices()