TTK VTK-filter that computes the Jacobi set of a bivariate volumetric data-set. More...

#include <ttkJacobiSet.h>

Inheritance diagram for ttkJacobiSet:

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

virtual void	SetForceInputOffsetScalarField (bool)

virtual void	SetEdgeIds (bool)

virtual bool	GetEdgeIds ()

virtual void	SetVertexScalars (bool)

virtual bool	GetVertexScalars ()

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

static int	IsTypeOf (const char *type)

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

int	FillInputPortInformation (int port, vtkInformation *info) override

int	FillOutputPortInformation (int port, vtkInformation *info) override

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

template<class dataTypeU , class dataTypeV >
int	dispatch (const dataTypeU const uField, const dataTypeV const vField, ttk::Triangulation *const triangulation)

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::JacobiSet
template<class dataTypeU , class dataTypeV >
int	executeLegacy (std::vector< std::pair< SimplexId, char > > &jacobiSet, const dataTypeU const uField, const dataTypeV const vField)

	JacobiSet ()

template<class dataTypeU , class dataTypeV , typename triangulationType >
int	execute (std::vector< std::pair< SimplexId, char > > &jacobiSet, const dataTypeU const uField, const dataTypeV const vField, const triangulationType &triangulation, std::vector< char > *isPareto=nullptr)

template<class dataTypeU , class dataTypeV , typename triangulationType >
char	getCriticalType (const SimplexId &edgeId, const dataTypeU const uField, const dataTypeV const vField, const triangulationType &triangulation)

template<class dataTypeU , class dataTypeV >
int	perturb (const dataTypeU const uField, const dataTypeV const vField, const dataTypeU uEpsilon=Geometry::powIntTen(-DBL_DIG), const dataTypeV vEpsilon=Geometry::powIntTen(-DBL_DIG)) const

void	setEdgeFans (const std::vector< std::vector< SimplexId > > *edgeFans)

void	setEdgeFanLinkEdgeList (const std::vector< std::vector< std::pair< SimplexId, SimplexId > > > *edgeFanLinkEdgeLists)

void	setEdgeList (const std::vector< std::pair< SimplexId, SimplexId > > *edgeList)

void	setSosOffsets (std::vector< SimplexId > *sosOffsets)

void	setSosOffsetsU (const SimplexId *const sosOffsets)

void	setSosOffsetsV (const SimplexId *const sosOffsets)

void	setTetList (const SimplexId *tetList)

void	setVertexNumber (const SimplexId &vertexNumber)

void	preconditionTriangulation (AbstractTriangulation *const triangulation)

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::JacobiSet
SimplexId	vertexNumber_ {}

const SimplexId *	tetList_ {}

const std::vector< std::pair< SimplexId, SimplexId > > *	edgeList_ {}

const std::vector< std::vector< std::pair< SimplexId, SimplexId > > > *	edgeFanLinkEdgeLists_ {}

const std::vector< std::vector< SimplexId > > *	edgeFans_ {}

const SimplexId *	sosOffsetsU_ {}

const SimplexId *	sosOffsetsV_ {}

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

Detailed Description

TTK VTK-filter that computes the Jacobi set of a bivariate volumetric data-set.

Author: Julien Tierny julie.nosp@m.n.ti.nosp@m.erny@.nosp@m.lip6.nosp@m..fr

Date: May 2015.

Given a bivariate scalar field defined on a PL 3-manifold, this filter produces the list of Jacobi edges (each entry is a pair given by the edge identifier and the Jacobi edge type).

The input bivariate data must be provided as two independent scalar fields attached as point data to the input geometry.

Parameters

Input	Input bivariate volumetric data (vtkDataSet)
Output	Output Jacobi set (vtkDataSet)

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

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

Parameters

idx	0 for the U Component, 1 for the V Component
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 arrays can be specified via the standard VTK call vtkAlgorithm::SetInputArrayToProcess() with the following parameters:

Parameters

idx	2 for the U Offset Field, 3 for the V Offset Field
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()’.

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

Related publication
"Jacobi sets of multiple Morse functions"
Herbert Edelsbrunner, John Harer
Foundations of Computational Mathematics. Cambridge University Press, 2002.

See also: ttk::JacobiSet; vtkReebSpace

Online examples:

Builtin example 2

Definition at line 64 of file ttkJacobiSet.h.

Member Typedef Documentation

◆ Superclass

typedef ttkAlgorithm ttkJacobiSet::Superclass

Definition at line 68 of file ttkJacobiSet.h.

Constructor & Destructor Documentation

◆ ttkJacobiSet()

ttkJacobiSet::ttkJacobiSet ( )

protected

Definition at line 20 of file ttkJacobiSet.cpp.

Member Function Documentation

◆ dispatch()

template<class dataTypeU , class dataTypeV >

int ttkJacobiSet::dispatch	(	const dataTypeU *const	uField,
		const dataTypeV *const	vField,
		ttk::Triangulation *const	triangulation
	)

protected

Definition at line 43 of file ttkJacobiSet.cpp.

◆ FillInputPortInformation()

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

overrideprotected

Definition at line 26 of file ttkJacobiSet.cpp.

◆ FillOutputPortInformation()

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

overrideprotected

Definition at line 34 of file ttkJacobiSet.cpp.

◆ GetClassName()

virtual const char * ttkJacobiSet::GetClassName ( )

virtual

Reimplemented from ttkAlgorithm.

◆ GetEdgeIds()

virtual bool ttkJacobiSet::GetEdgeIds ( )

virtual

◆ GetForceInputOffsetScalarField()

virtual bool ttkJacobiSet::GetForceInputOffsetScalarField ( )

virtual

◆ GetVertexScalars()

virtual bool ttkJacobiSet::GetVertexScalars ( )

virtual

◆ IsA()

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

virtual

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

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

static

◆ New()

static ttkJacobiSet * ttkJacobiSet::New ( )

static

◆ RequestData()

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

overrideprotected

Definition at line 54 of file ttkJacobiSet.cpp.

◆ SafeDownCast()

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

static

◆ SetEdgeIds()

virtual void ttkJacobiSet::SetEdgeIds ( bool )

virtual

◆ SetForceInputOffsetScalarField()

virtual void ttkJacobiSet::SetForceInputOffsetScalarField ( bool )

virtual

◆ SetVertexScalars()

virtual void ttkJacobiSet::SetVertexScalars ( bool )

virtual

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

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

◆ ttkJacobiSet()

Member Function Documentation

◆ dispatch()

◆ FillInputPortInformation()

◆ FillOutputPortInformation()

◆ GetClassName()

◆ GetEdgeIds()

◆ GetForceInputOffsetScalarField()

◆ GetVertexScalars()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ RequestData()

◆ SafeDownCast()

◆ SetEdgeIds()

◆ SetForceInputOffsetScalarField()

◆ SetVertexScalars()