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

#include <ttkPathCompression.h>

Inheritance diagram for ttkPathCompression:

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	SetComputeAscendingSegmentation (bool)

virtual bool	GetComputeAscendingSegmentation ()

virtual void	SetComputeDescendingSegmentation (bool)

virtual bool	GetComputeDescendingSegmentation ()

virtual void	SetComputeMSSegmentationHash (bool)

virtual bool	GetComputeMSSegmentationHash ()

virtual void	SetForceInputOffsetScalarField (bool)

virtual bool	GetForceInputOffsetScalarField ()

Public Member Functions inherited from ttkAlgorithm
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

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, const int orderArrayIdx=0, const bool enforceOrderArrayIdx=false)

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)

virtual int	setWrapper (const Wrapper *wrapper)

Static Public Member Functions
static ttkPathCompression *	New ()

static int	IsTypeOf (const char *type)

static ttkPathCompression *	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
template<typename triangulationType >
int	dispatch (const SimplexId *const inputOffsets, const triangulationType &triangulation)

	ttkPathCompression ()

int	FillInputPortInformation (int port, vtkInformation *info) override

int	FillOutputPortInformation (int port, vtkInformation *info) override

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

Protected Member Functions inherited from ttkAlgorithm
	ttkAlgorithm ()

	~ttkAlgorithm () override

void	MPIGhostPipelinePreconditioning (vtkDataSet *input)

void	MPIPipelinePreconditioning (vtkDataSet input, std::vector< int > &neighbors, 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)

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

void	preconditionTriangulation (AbstractTriangulation *const data)

template<typename triangulationType >
int	execute (OutputSegmentation &outSegmentation, const SimplexId *const orderArray, const triangulationType &triangulation)
	Main function for computing the Morse-Smale complex.

template<typename triangulationType >
int	computePathCompression (SimplexId const ascSegmentation, SimplexId const dscSegmentation, const SimplexId *const orderArray, const triangulationType &triangulation) const
	Compute the ascending and descending segmentation in one run.

template<typename triangulationType >
int	computePathCompressionSingle (SimplexId const segmentation, const bool computeAscending, const SimplexId const orderArray, const triangulationType &triangulation) const
	Compute the ascending or descending segmentation.

template<typename triangulationType >
int	computeMSHash (SimplexId const morseSmaleSegmentation, const SimplexId const ascSegmentation, const SimplexId *const dscSegmentation, const triangulationType &triangulation) const
	Computes a MS segmentation hash.

Additional Inherited Members
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::PathCompression
bool	ComputeAscendingSegmentation {true}

bool	ComputeDescendingSegmentation {true}

bool	ComputeMSSegmentationHash {true}

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::PathCompression module.

Author: Robin Maack maack.nosp@m.@rpt.nosp@m.u.de

Date: May 2023.

Given an input order field, this filter computes its ascending and descending segmentation by assigning every vertex to its minimum or maximum in gradient or inverse gradient direction. For convienience a hash (no hash collision detection) of both segmentations can be created to represent the Morse-Smale segmentation.

Parameters

Input	Input scalar field, defined as a point data scalar field attached to a geometry, either 2D or 3D, either regular grid or triangulation (vtkDataSet)
Output	output scalar field, defined as a point data scalar field attached to a geometry, either 2D or 3D, either regular grid or triangulation (vtkDataSet) with resulting arrays attached to point data

The input data array needs to be specified via the standard VTK call vtkAlgorithm::SetInputArrayToProcess() with the following parameters:

Parameters

idx	0 (FIXED: the first array the algorithm requires)
port	0 (FIXED: first port)
connection	0 (FIXED: first connection)
fieldAssociation	0 (FIXED: point data)
arrayName	(DYNAMIC: string identifier of the input array)

The optional offset array can be specified via the standard VTK call vtkAlgorithm::SetInputArrayToProcess() with the following parameters:

Parameters

idx	1 (FIXED: the second array the algorithm requires)
port	0 (FIXED: first port)
connection	0 (FIXED: first connection)
fieldAssociation	0 (FIXED: point data)
arrayName	(DYNAMIC: string identifier of the offset array)

Note: : To use this optional array, ForceInputOffsetScalarField needs to be enabled with the setter ‘setForceInputOffsetScalarField()’.

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

See the corresponding standalone program for a usage example:

standalone/PathCompression/main.cpp

See the related ParaView example state files for usage examples within a VTK pipeline.

Related publication
"Parallel Computation of Piecewise Linear Morse-Smale Segmentations"
Robin G. C. Maack, Jonas Lukasczyk, Julien Tierny, Hans Hagen, Ross Maciejewski, Christoph Garth
IEEE Transactions on Visualization and Computer Graphics

See also: ttk::PathCompression

Online examples:

Morse-Smale segmentation example

Definition at line 73 of file ttkPathCompression.h.

Member Typedef Documentation

◆ Superclass

typedef ttkAlgorithm ttkPathCompression::Superclass

Definition at line 80 of file ttkPathCompression.h.

Constructor & Destructor Documentation

◆ ttkPathCompression()

ttkPathCompression::ttkPathCompression ( )

protected

Definition at line 21 of file ttkPathCompression.cpp.

Member Function Documentation

◆ dispatch()

template<typename triangulationType >

int ttkPathCompression::dispatch	(	const SimplexId *const	inputOffsets,
		const triangulationType &	triangulation
	)

protected

Definition at line 46 of file ttkPathCompression.cpp.

◆ FillInputPortInformation()

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

overrideprotected

Definition at line 27 of file ttkPathCompression.cpp.

◆ FillOutputPortInformation()

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

overrideprotected

Definition at line 36 of file ttkPathCompression.cpp.

◆ GetClassName()

virtual const char * ttkPathCompression::GetClassName ( )

virtual

Reimplemented from ttkAlgorithm.

◆ GetComputeAscendingSegmentation()

virtual bool ttkPathCompression::GetComputeAscendingSegmentation ( )

virtual

◆ GetComputeDescendingSegmentation()

virtual bool ttkPathCompression::GetComputeDescendingSegmentation ( )

virtual

◆ GetComputeMSSegmentationHash()

virtual bool ttkPathCompression::GetComputeMSSegmentationHash ( )

virtual

◆ GetForceInputOffsetScalarField()

virtual bool ttkPathCompression::GetForceInputOffsetScalarField ( )

virtual

◆ IsA()

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

virtual

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

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

static

◆ New()

static ttkPathCompression * ttkPathCompression::New ( )

static

◆ RequestData()

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

overrideprotected

Definition at line 58 of file ttkPathCompression.cpp.

◆ SafeDownCast()

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

static

◆ SetComputeAscendingSegmentation()

virtual void ttkPathCompression::SetComputeAscendingSegmentation ( bool )

virtual

◆ SetComputeDescendingSegmentation()

virtual void ttkPathCompression::SetComputeDescendingSegmentation ( bool )

virtual

◆ SetComputeMSSegmentationHash()

virtual void ttkPathCompression::SetComputeMSSegmentationHash ( bool )

virtual

◆ SetForceInputOffsetScalarField()

virtual void ttkPathCompression::SetForceInputOffsetScalarField ( bool )

virtual

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

/home/julien/Pro/git/github/ttk-tierny/core/vtk/ttkPathCompression/ttkPathCompression.h
/home/julien/Pro/git/github/ttk-tierny/core/vtk/ttkPathCompression/ttkPathCompression.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

◆ ttkPathCompression()

Member Function Documentation

◆ dispatch()

◆ FillInputPortInformation()

◆ FillOutputPortInformation()

◆ GetClassName()

◆ GetComputeAscendingSegmentation()

◆ GetComputeDescendingSegmentation()

◆ GetComputeMSSegmentationHash()

◆ GetForceInputOffsetScalarField()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ RequestData()

◆ SafeDownCast()

◆ SetComputeAscendingSegmentation()

◆ SetComputeDescendingSegmentation()

◆ SetComputeMSSegmentationHash()

◆ SetForceInputOffsetScalarField()