TTK VTK-filter for the computation of critical points in PL scalar fields defined on PL manifolds. More...

#include <ttkScalarFieldCriticalPoints.h>

Inheritance diagram for ttkScalarFieldCriticalPoints:

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	GetVertexBoundary ()

virtual void	SetVertexBoundary (bool)

virtual bool	GetVertexIds ()

virtual void	SetVertexIds (bool)

virtual bool	GetVertexScalars ()

virtual void	SetVertexScalars (bool)

virtual bool	GetForceInputOffsetScalarField ()

virtual void	SetForceInputOffsetScalarField (bool)

virtual void	SetBackEnd (int _arg)

virtual void	SetBackEnd (BACKEND)

virtual BACKEND	GetBackEnd () const

virtual int	GetStartingResolutionLevel ()

virtual void	SetStartingResolutionLevel (int)

virtual int	GetStoppingResolutionLevel ()

virtual void	SetStoppingResolutionLevel (int)

virtual bool	GetIsResumable ()

virtual void	SetIsResumable (bool)

virtual double	GetTimeLimit ()

virtual void	SetTimeLimit (double)

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

static int	IsTypeOf (const char *type)

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

	~ttkScalarFieldCriticalPoints () override

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

template<class triangulationType = AbstractTriangulation>
int	execute (const SimplexId const offsets, const triangulationType triangulation)

template<class triangulationType = AbstractTriangulation>
int	executeLegacy (const SimplexId const offsets, const triangulationType triangulation)

template<class triangulationType = AbstractTriangulation>
int	executeProgressive (const SimplexId const offsets, const triangulationType triangulation)

template<class triangulationType >
void	checkProgressivityRequirement (const triangulationType *triangulation)

template<class triangulationType = AbstractTriangulation>
int	getLowerUpperComponents (const SimplexId vertexId, const SimplexId const offsets, const triangulationType triangulation, bool &isLowerOnBoundary, bool &isUpperOnBoundary, std::vector< std::vector< ttk::SimplexId > > upperComponents, std::vector< std::vector< ttk::SimplexId > > lowerComponents) const

template<class triangulationType = AbstractTriangulation>
char	getCriticalType (const SimplexId &vertexId, const SimplexId const offsets, const triangulationType triangulation, std::vector< std::vector< ttk::SimplexId > > upperComponents=nullptr, std::vector< std::vector< ttk::SimplexId > > lowerComponents=nullptr) const

char	getCriticalType (const SimplexId &vertexId, const SimplexId *const offsets, const std::vector< std::pair< SimplexId, SimplexId > > &vertexLinkEdgeList) const

void	setDomainDimension (const int &dimension)

void	setOutput (std::vector< std::pair< SimplexId, char > > *criticalPoints)

void	preconditionTriangulation (AbstractTriangulation *triangulation)

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

int	setVertexNumber (const SimplexId &vertexNumber)

void	setNonManifold (const bool b)

void	displayStats ()

template<class triangulationType >
void	checkProgressivityRequirement (const triangulationType *ttkNotUsed(triangulation))

Additional Inherited Members
Protected Types inherited from ttk::ScalarFieldCriticalPoints
enum class	BACKEND { GENERIC = 0 , PROGRESSIVE_TOPOLOGY = 1 }

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::ScalarFieldCriticalPoints
int	dimension_ {}

SimplexId	vertexNumber_ {}

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

std::vector< std::pair< SimplexId, char > > *	criticalPoints_ {}

bool	forceNonManifoldCheck {false}

BACKEND	BackEnd {BACKEND::PROGRESSIVE_TOPOLOGY}

ProgressiveTopology	progT_ {}

int	StartingResolutionLevel {0}

int	StoppingResolutionLevel {-1}

bool	IsResumable {false}

double	TimeLimit {}

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 critical points in PL scalar fields defined on PL manifolds.

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

Date: June 2015.

This filter computes the list of critical points of the input scalar field and classify them according to their type.

Parameters

Input	Input PL scalar field (vtkDataSet)
Output	Output critical points (vtkDataSet)

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 as any other VTK filter (for instance, by using the sequence of calls SetInputData(), Update(), GetOutput()).

See the corresponding standalone program for a usage example:

standalone/ScalarFieldCriticalPoints/main.cpp

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

Related publication
"Critical points and curvature for embedded polyhedral surfaces"
Thomas Banchoff
American Mathematical Monthly, 1970.

Progressive Approach used by default

Related publication
"A Progressive Approach to Scalar Field Topology"
Jules Vidal, Pierre Guillou, Julien Tierny
IEEE Transactions on Visualization and Computer Graphics, 2021

See also: ttk::ScalarFieldCriticalPoints

Online examples:

Definition at line 88 of file ttkScalarFieldCriticalPoints.h.

Member Typedef Documentation

◆ Superclass

typedef ttkAlgorithm ttkScalarFieldCriticalPoints::Superclass

Definition at line 95 of file ttkScalarFieldCriticalPoints.h.

Constructor & Destructor Documentation

◆ ttkScalarFieldCriticalPoints()

ttkScalarFieldCriticalPoints::ttkScalarFieldCriticalPoints ( )

protected

Definition at line 22 of file ttkScalarFieldCriticalPoints.cpp.

◆ ~ttkScalarFieldCriticalPoints()

ttkScalarFieldCriticalPoints::~ttkScalarFieldCriticalPoints ( )

overrideprotecteddefault

Member Function Documentation

◆ FillInputPortInformation()

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

overrideprotected

Definition at line 30 of file ttkScalarFieldCriticalPoints.cpp.

◆ FillOutputPortInformation()

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

overrideprotected

Definition at line 40 of file ttkScalarFieldCriticalPoints.cpp.

◆ GetBackEnd()

virtual BACKEND ttkScalarFieldCriticalPoints::GetBackEnd ( ) const

virtual

◆ GetClassName()

virtual const char * ttkScalarFieldCriticalPoints::GetClassName ( )

virtual

Reimplemented from ttkAlgorithm.

◆ GetForceInputOffsetScalarField()

virtual bool ttkScalarFieldCriticalPoints::GetForceInputOffsetScalarField ( )

virtual

◆ GetIsResumable()

virtual bool ttkScalarFieldCriticalPoints::GetIsResumable ( )

virtual

◆ GetStartingResolutionLevel()

virtual int ttkScalarFieldCriticalPoints::GetStartingResolutionLevel ( )

virtual

◆ GetStoppingResolutionLevel()

virtual int ttkScalarFieldCriticalPoints::GetStoppingResolutionLevel ( )

virtual

◆ GetTimeLimit()

virtual double ttkScalarFieldCriticalPoints::GetTimeLimit ( )

virtual

◆ GetVertexBoundary()

virtual bool ttkScalarFieldCriticalPoints::GetVertexBoundary ( )

virtual

◆ GetVertexIds()

virtual bool ttkScalarFieldCriticalPoints::GetVertexIds ( )

virtual

◆ GetVertexScalars()

virtual bool ttkScalarFieldCriticalPoints::GetVertexScalars ( )

virtual

◆ IsA()

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

virtual

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

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

static

◆ New()

static ttkScalarFieldCriticalPoints * ttkScalarFieldCriticalPoints::New ( )

static

◆ RequestData()

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

overrideprotected

Definition at line 50 of file ttkScalarFieldCriticalPoints.cpp.

◆ SafeDownCast()

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

static

◆ SetBackEnd() [1/2]

virtual void ttkScalarFieldCriticalPoints::SetBackEnd ( BACKEND )

virtual

◆ SetBackEnd() [2/2]

virtual void ttkScalarFieldCriticalPoints::SetBackEnd ( int _arg )

virtual

◆ SetForceInputOffsetScalarField()

virtual void ttkScalarFieldCriticalPoints::SetForceInputOffsetScalarField ( bool )

virtual

◆ SetIsResumable()

virtual void ttkScalarFieldCriticalPoints::SetIsResumable ( bool )

virtual

◆ SetStartingResolutionLevel()

virtual void ttkScalarFieldCriticalPoints::SetStartingResolutionLevel ( int )

virtual

◆ SetStoppingResolutionLevel()

virtual void ttkScalarFieldCriticalPoints::SetStoppingResolutionLevel ( int )

virtual

◆ SetTimeLimit()

virtual void ttkScalarFieldCriticalPoints::SetTimeLimit ( double )

virtual

◆ SetVertexBoundary()

virtual void ttkScalarFieldCriticalPoints::SetVertexBoundary ( bool )

virtual

◆ SetVertexIds()

virtual void ttkScalarFieldCriticalPoints::SetVertexIds ( bool )

virtual

◆ SetVertexScalars()

virtual void ttkScalarFieldCriticalPoints::SetVertexScalars ( bool )

virtual

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

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

◆ ttkScalarFieldCriticalPoints()

◆ ~ttkScalarFieldCriticalPoints()

Member Function Documentation

◆ FillInputPortInformation()

◆ FillOutputPortInformation()

◆ GetBackEnd()

◆ GetClassName()

◆ GetForceInputOffsetScalarField()

◆ GetIsResumable()

◆ GetStartingResolutionLevel()

◆ GetStoppingResolutionLevel()

◆ GetTimeLimit()

◆ GetVertexBoundary()

◆ GetVertexIds()

◆ GetVertexScalars()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ RequestData()

◆ SafeDownCast()

◆ SetBackEnd() [1/2]

◆ SetBackEnd() [2/2]

◆ SetForceInputOffsetScalarField()

◆ SetIsResumable()

◆ SetStartingResolutionLevel()

◆ SetStoppingResolutionLevel()

◆ SetTimeLimit()

◆ SetVertexBoundary()

◆ SetVertexIds()

◆ SetVertexScalars()