TTK VTK-filter for the computation of merge and contour trees. More...

#include <ttkFTMTree.h>

Inheritance diagram for ttkFTMTree:

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)

int	preconditionTriangulation ()

int	getScalars ()

int	getOffsets ()

int	getSkeletonNodes (vtkUnstructuredGrid *outputSkeletonNodes)

int	addDirectSkeletonArc (const ttk::ftm::idSuperArc arcId, const int cc, vtkPoints points, vtkUnstructuredGrid skeletonArcs, ttk::ftm::ArcData &arcData)

int	addSampledSkeletonArc (const ttk::ftm::idSuperArc arcId, const int cc, vtkPoints points, vtkUnstructuredGrid skeletonArcs, ttk::ftm::ArcData &arcData)

int	addCompleteSkeletonArc (const ttk::ftm::idSuperArc arcId, const int cc, vtkPoints points, vtkUnstructuredGrid skeletonArcs, ttk::ftm::ArcData &arcData)

int	getSkeletonArcs (vtkUnstructuredGrid *outputSkeletonArcs)

int	getSegmentation (vtkDataSet *outputSegmentation)


virtual bool	GetForceInputOffsetScalarField ()
	the offset array to use for simulation of simplicity

virtual void	SetForceInputOffsetScalarField (bool)


void	SetTreeType (const int type)
	the type of tree to compute (Join, Split, Contour, JoinSplit)

ttk::ftm::TreeType	GetTreeType () const


void	SetWithSegmentation (const bool segm)
	control if the output should contains the segmentation information

bool	GetWithSegmentation () const


void	SetWithNormalize (const bool norm)
	if true, a post process pass will ensure NodesId have a deterministic order

bool	GetWithNormalize () const


void	SetWithAdvStats (const bool adv)
	Compute additional information on the segmentation like the span and size (in nb of vertex) of each region.

bool	GetWithAdvStats () const


void	SetSuperArcSamplingLevel (int lvl)
	control the sampling level of the superarc. By default: 0

int	GetSuperArcSamplingLevel () const

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

static int	IsTypeOf (const char *type)

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

int	FillInputPortInformation (int port, vtkInformation *info) override

int	FillOutputPortInformation (int port, vtkInformation *info) override

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

void	identify (vtkDataSet *ds) const

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)

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_

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 merge and contour trees.

Author: Charles Gueunet charl.nosp@m.es.g.nosp@m.ueune.nosp@m.t@ki.nosp@m.tware.nosp@m..com

Date: June 2017.

See also: ttk::ftm::FTMTree

The computation of the Merge / Contour tree done by this package is done in parallel if TTK_ENABLE_OPENMP is set to ON, using a task based approach described in the article mention below. The VTK wrapper will first call a connectivity filter, and then call a contour / merge tree computation for each connected components. The final tree is then aggregated.

Parameters

Input	Input scalar field, either 2D or 3D, regular grid or triangulation (vtkDataSet)
TreeType	the Type of three to Compute: Join Tree (leaves corresponds to minima of the scalar field) Split Tree (leaves corresponds to maxima of the scalar field) Contour Tree (combination of both) JoinSplit (compute both merge trees but do not combine them (advanced))
Segmentation	control wethear or not the output should be augmented with the segmentation.
SuperArcSamplingLevel	control the number of subdivision of each superarc. Intermediate point will be located on the barycenter of the corresponding portion of vertex.
Output	the output of this filter is composed of: The nodes of the tree The arcs of the tree The semgentation of the initial dataset The structure of the tree (Nodes+Arcs) have a concept of nodeId, which is an id that is consistent between execution if SetWithNormalize is set to True. The downNodeId of an arc is its starting node (directed towards the leaves as the computation starts here) and the upNodeId it the ending node, in direction of the Root of the tree. The segmentation also contains some basics metrics like the size of each region (RegionSpan) or its number of vertex (RegionSize)

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

Related publication
"Task-based Augmented Merge Trees with Fibonacci Heaps"
Charles Gueunet, Pierre Fortin, Julien Jomier, Julien Tierny
2017 IEEE 7th Symposium on Large Data Analysis and Visualization (LDAV), doi: 10.1109/LDAV.2017.8231846.
"Task-based augmented contour trees with fibonacci heaps"
Charles Gueunet, Pierre Fortin, Julien Jomier, Julien Tierny
IEEE Transactions on Parallel and Distributed Systems, Volume 30, Issue 8, Pages 1889-1905

Online examples:

Definition at line 93 of file ttkFTMTree.h.

Member Typedef Documentation

◆ Superclass

typedef ttkAlgorithm ttkFTMTree::Superclass

Definition at line 98 of file ttkFTMTree.h.

Constructor & Destructor Documentation

◆ ttkFTMTree()

ttkFTMTree::ttkFTMTree ( )

protected

Definition at line 18 of file ttkFTMTree.cpp.

Member Function Documentation

◆ addCompleteSkeletonArc()

int ttkFTMTree::addCompleteSkeletonArc	(	const ttk::ftm::idSuperArc	arcId,
		const int	cc,
		vtkPoints *	points,
		vtkUnstructuredGrid *	skeletonArcs,
		ttk::ftm::ArcData &	arcData
	)

Definition at line 212 of file ttkFTMTree.cpp.

◆ addDirectSkeletonArc()

int ttkFTMTree::addDirectSkeletonArc	(	const ttk::ftm::idSuperArc	arcId,
		const int	cc,
		vtkPoints *	points,
		vtkUnstructuredGrid *	skeletonArcs,
		ttk::ftm::ArcData &	arcData
	)

Definition at line 282 of file ttkFTMTree.cpp.

◆ addSampledSkeletonArc()

int ttkFTMTree::addSampledSkeletonArc	(	const ttk::ftm::idSuperArc	arcId,
		const int	cc,
		vtkPoints *	points,
		vtkUnstructuredGrid *	skeletonArcs,
		ttk::ftm::ArcData &	arcData
	)

Definition at line 333 of file ttkFTMTree.cpp.

◆ FillInputPortInformation()

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

overrideprotected

Definition at line 24 of file ttkFTMTree.cpp.

◆ FillOutputPortInformation()

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

overrideprotected

Definition at line 32 of file ttkFTMTree.cpp.

◆ GetClassName()

virtual const char * ttkFTMTree::GetClassName ( )

virtual

Reimplemented from ttkAlgorithm.

◆ GetForceInputOffsetScalarField()

virtual bool ttkFTMTree::GetForceInputOffsetScalarField ( )

virtual

the offset array to use for simulation of simplicity

◆ getOffsets()

int ttkFTMTree::getOffsets ( )

Definition at line 432 of file ttkFTMTree.cpp.

◆ getScalars()

int ttkFTMTree::getScalars ( )

Definition at line 459 of file ttkFTMTree.cpp.

◆ getSegmentation()

int ttkFTMTree::getSegmentation ( vtkDataSet * outputSegmentation )

Definition at line 478 of file ttkFTMTree.cpp.

◆ getSkeletonArcs()

int ttkFTMTree::getSkeletonArcs ( vtkUnstructuredGrid * outputSkeletonArcs )

Definition at line 504 of file ttkFTMTree.cpp.

◆ getSkeletonNodes()

int ttkFTMTree::getSkeletonNodes ( vtkUnstructuredGrid * outputSkeletonNodes )

Definition at line 552 of file ttkFTMTree.cpp.

◆ GetSuperArcSamplingLevel()

int ttkFTMTree::GetSuperArcSamplingLevel ( ) const

inline

Definition at line 160 of file ttkFTMTree.h.

◆ GetTreeType()

ttk::ftm::TreeType ttkFTMTree::GetTreeType ( ) const

inline

Definition at line 114 of file ttkFTMTree.h.

◆ GetWithAdvStats()

bool ttkFTMTree::GetWithAdvStats ( ) const

inline

Definition at line 149 of file ttkFTMTree.h.

◆ GetWithNormalize()

bool ttkFTMTree::GetWithNormalize ( ) const

inline

Definition at line 137 of file ttkFTMTree.h.

◆ GetWithSegmentation()

bool ttkFTMTree::GetWithSegmentation ( ) const

inline

Definition at line 125 of file ttkFTMTree.h.

◆ identify()

void ttkFTMTree::identify ( vtkDataSet * ds ) const

protected

Definition at line 679 of file ttkFTMTree.cpp.

◆ IsA()

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

virtual

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

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

static

◆ New()

static ttkFTMTree * ttkFTMTree::New ( )

static

◆ preconditionTriangulation()

int ttkFTMTree::preconditionTriangulation ( )

Definition at line 647 of file ttkFTMTree.cpp.

◆ RequestData()

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

overrideprotected

Definition at line 43 of file ttkFTMTree.cpp.

◆ SafeDownCast()

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

static

◆ SetForceInputOffsetScalarField()

virtual void ttkFTMTree::SetForceInputOffsetScalarField ( bool )

virtual

◆ SetSuperArcSamplingLevel()

void ttkFTMTree::SetSuperArcSamplingLevel ( int lvl )

inline

control the sampling level of the superarc. By default: 0

Definition at line 156 of file ttkFTMTree.h.

◆ SetTreeType()

void ttkFTMTree::SetTreeType ( const int type )

inline

the type of tree to compute (Join, Split, Contour, JoinSplit)

Definition at line 110 of file ttkFTMTree.h.

◆ SetWithAdvStats()

void ttkFTMTree::SetWithAdvStats ( const bool adv )

inline

Compute additional information on the segmentation like the span and size (in nb of vertex) of each region.

Definition at line 145 of file ttkFTMTree.h.

◆ SetWithNormalize()

void ttkFTMTree::SetWithNormalize ( const bool norm )

inline

if true, a post process pass will ensure NodesId have a deterministic order

Definition at line 133 of file ttkFTMTree.h.

◆ SetWithSegmentation()

void ttkFTMTree::SetWithSegmentation ( const bool segm )

inline

control if the output should contains the segmentation information

Definition at line 121 of file ttkFTMTree.h.

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

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

◆ ttkFTMTree()

Member Function Documentation

◆ addCompleteSkeletonArc()

◆ addDirectSkeletonArc()

◆ addSampledSkeletonArc()

◆ FillInputPortInformation()

◆ FillOutputPortInformation()

◆ GetClassName()

◆ GetForceInputOffsetScalarField()

◆ getOffsets()

◆ getScalars()

◆ getSegmentation()

◆ getSkeletonArcs()

◆ getSkeletonNodes()

◆ GetSuperArcSamplingLevel()

◆ GetTreeType()

◆ GetWithAdvStats()

◆ GetWithNormalize()

◆ GetWithSegmentation()

◆ identify()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ preconditionTriangulation()

◆ RequestData()

◆ SafeDownCast()

◆ SetForceInputOffsetScalarField()

◆ SetSuperArcSamplingLevel()

◆ SetTreeType()

◆ SetWithAdvStats()

◆ SetWithNormalize()

◆ SetWithSegmentation()