ttkTopologicalSimplification Class Reference

TTK VTK-filter for the topological simplification of scalar data. More...

#include <ttkTopologicalSimplification.h>

Inheritance diagram for ttkTopologicalSimplification:

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	SetForceInputOffsetScalarField (bool)
virtual bool	GetForceInputOffsetScalarField ()
virtual void	SetConsiderIdentifierAsBlackList (bool)
virtual bool	GetConsiderIdentifierAsBlackList ()
virtual void	SetAddPerturbation (bool)
virtual bool	GetAddPerturbation ()
virtual void	SetForceInputVertexScalarField (bool)
virtual bool	GetForceInputVertexScalarField ()
virtual void	SetMethod (int)
virtual int	GetMethod ()
virtual void	SetPersistenceThreshold (double)
virtual double	GetPersistenceThreshold ()
virtual void	SetUseFastPersistenceUpdate (bool)
virtual bool	GetUseFastPersistenceUpdate ()
virtual void	SetFastAssignmentUpdate (bool)
virtual bool	GetFastAssignmentUpdate ()
virtual void	SetEpochNumber (int)
virtual int	GetEpochNumber ()
virtual void	SetPDCMethod (int)
virtual int	GetPDCMethod ()
virtual void	SetMethodOptimization (int)
virtual int	GetMethodOptimization ()
virtual void	SetFinePairManagement (int)
virtual int	GetFinePairManagement ()
virtual void	SetChooseLearningRate (bool)
virtual bool	GetChooseLearningRate ()
virtual void	SetLearningRate (double)
virtual double	GetLearningRate ()
virtual void	SetAlpha (double)
virtual double	GetAlpha ()
virtual void	SetCoefStopCondition (double)
virtual double	GetCoefStopCondition ()
virtual void	SetOptimizationWithoutMatching (bool)
virtual bool	GetOptimizationWithoutMatching ()
virtual void	SetThresholdMethod (int)
virtual int	GetThresholdMethod ()
virtual void	SetThreshold (double)
virtual double	GetThreshold ()
virtual void	SetLowerThreshold (int)
virtual int	GetLowerThreshold ()
virtual void	SetUpperThreshold (int)
virtual int	GetUpperThreshold ()
virtual void	SetPairTypeToDelete (int)
virtual int	GetPairTypeToDelete ()
virtual void	SetConstraintAveraging (bool)
virtual bool	GetConstraintAveraging ()
virtual void	SetPrintFrequency (int)
virtual int	GetPrintFrequency ()
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 ttkTopologicalSimplification *	New ()
static int	IsTypeOf (const char *type)
static ttkTopologicalSimplification *	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
	ttkTopologicalSimplification ()
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, 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::TopologicalSimplification
	TopologicalSimplification ()
template<typename dataType , typename triangulationType >
int	execute (const dataType *const inputScalars, dataType *const outputScalars, const SimplexId *const identifiers, const SimplexId *const inputOffsets, SimplexId *const offsets, const SimplexId constraintNumber, const bool addPerturbation, triangulationType &triangulation, const ttk::DiagramType &constraintDiagram={})
void	setBackend (const BACKEND arg)
int	preconditionTriangulation (AbstractTriangulation *triangulation)

Additional Inherited Members
Protected Types inherited from ttk::TopologicalSimplification
enum class	BACKEND { LEGACY , LTS , TO }
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::TopologicalSimplification
BACKEND	backend_ {BACKEND::LTS}
LegacyTopologicalSimplification	legacyObject_
lts::LocalizedTopologicalSimplification	ltsObject_
ttk::TopologicalOptimization	topologyOptimizer_
SimplexId	vertexNumber_ {}
bool	UseFastPersistenceUpdate {true}
bool	FastAssignmentUpdate {true}
int	EpochNumber {1000}
int	PDCMethod {1}
int	MethodOptimization {0}
int	FinePairManagement {0}
bool	ChooseLearningRate {false}
double	LearningRate {0.0001}
double	Alpha {0.5}
double	CoefStopCondition {0.01}
bool	OptimizationWithoutMatching {false}
int	ThresholdMethod {1}
double	Threshold {0.01}
int	LowerThreshold {-1}
int	UpperThreshold {2}
int	PairTypeToDelete {1}
bool	ConstraintAveraging {true}
int	PrintFrequency {10}
Static Protected Attributes inherited from ttk::Debug
static COMMON_EXPORTS debug::LineMode	lastLineMode = ttk::debug::LineMode::NEW

Detailed Description

TTK VTK-filter for the topological simplification of scalar data.

Author

Guillaume Favelier guill.nosp@m.aume.nosp@m..fave.nosp@m.lier.nosp@m.@lip6.nosp@m..fr

Date

February 2016

Given an input scalar field and a list of critical points to remove, this filter minimally edits the scalar field such that the listed critical points disappear. This procedure is useful to speedup subsequent topological data analysis when outlier critical points can be easily identified. It is also useful for data simplification.

The list of critical points to remove must be associated with a point data scalar field that represent the vertex global identifiers in the input geometry.

Note that this filter will also produce an output vertex offset scalar field that can be used for further topological data analysis tasks to disambiguate vertices on flat plateaus. For instance, this output vertex offset field can specified to the ttkMergeTree, vtkIntegralLines, or vtkScalarFieldCriticalPoints filters.

Also, this filter can be given a specific input vertex offset.

Parameters

Input0	Input scalar field, either 2D or 3D, either regular grid or triangulation (vtkDataSet)
Input1	List of critical point constraints (vtkPointSet)
Output	Output simplified scalar field (vtkDataSet)

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

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

Related publications
"Generalized Topological Simplification of Scalar Fields on Surfaces"
Julien Tierny, Valerio Pascucci
IEEE Transactions on Visualization and Computer Graphics.
Proc. of IEEE VIS 2012.

"Localized Topological Simplification of Scalar Data"
Jonas Lukasczyk, Christoph Garth, Ross Maciejewski, Julien Tierny
IEEE Transactions on Visualization and Computer Graphics.
Proc. of IEEE VIS 2020.

"A Practical Solver for Scalar Data Topological Simplification"
Mohamed Kissi, Mathieu Pont, Joshua A. Levine, Julien Tierny
IEEE Transactions on Visualization and Computer Graphics.
Proc. of IEEE VIS 2024.

See also

ttkTopologicalSimplificationByPersistence

ttkScalarFieldCriticalPoints

ttkIntegralLines

ttkMergeTree

ttkMorseSmaleComplex

ttkIdentifiers

ttk::TopologicalSimplification

Online examples:

• 1-Manifold Learning example
  
• 1-Manifold Learning Circles example
  
• 2-Manifold Learning example
  
• BuiltInExample1 example
  
• Contour Tree Alignment example
  
• CT Bones example
  
• Dragon example
  
• Harmonic Skeleton example
  
• Image Processing example
  
• Interaction sites
  
• Karhunen-Love Digits 64-Dimensions example
  
• Morse Persistence example
  
• Morse-Smale Quadrangulation example
  
• Persistence clustering 0 example
  
• Persistence clustering 1 example
  
• Persistence clustering 2 example
  
• Persistence clustering 3 example
  
• Persistence clustering 4 example
  
• Tectonic Puzzle example
  
• Topological Optimization DarkSky example
  
• Topological Optimization for Pegasus Genus Repair example
  
• Topological Optimization for Torus Repair example
  
• Tribute example
  
• Uncertain Starting Vortex example
  

Definition at line 148 of file ttkTopologicalSimplification.h.

Member Typedef Documentation

Superclass

typedef ttkAlgorithm ttkTopologicalSimplification::Superclass

Definition at line 154 of file ttkTopologicalSimplification.h.

Constructor & Destructor Documentation

ttkTopologicalSimplification()

ttkTopologicalSimplification::ttkTopologicalSimplification ( )

protected

Definition at line 18 of file ttkTopologicalSimplification.cpp.

Member Function Documentation

FillInputPortInformation()

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

overrideprotected

Definition at line 23 of file ttkTopologicalSimplification.cpp.

FillOutputPortInformation()

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

overrideprotected

Definition at line 35 of file ttkTopologicalSimplification.cpp.

GetAddPerturbation()

virtual bool ttkTopologicalSimplification::GetAddPerturbation ( )

virtual

GetAlpha()

virtual double ttkTopologicalSimplification::GetAlpha ( )

virtual

GetChooseLearningRate()

virtual bool ttkTopologicalSimplification::GetChooseLearningRate ( )

virtual

GetClassName()

virtual const char * ttkTopologicalSimplification::GetClassName ( )

virtual

Reimplemented from ttkAlgorithm.

GetCoefStopCondition()

virtual double ttkTopologicalSimplification::GetCoefStopCondition ( )

virtual

GetConsiderIdentifierAsBlackList()

virtual bool ttkTopologicalSimplification::GetConsiderIdentifierAsBlackList ( )

virtual

GetConstraintAveraging()

virtual bool ttkTopologicalSimplification::GetConstraintAveraging ( )

virtual

GetEpochNumber()

virtual int ttkTopologicalSimplification::GetEpochNumber ( )

virtual

GetFastAssignmentUpdate()

virtual bool ttkTopologicalSimplification::GetFastAssignmentUpdate ( )

virtual

GetFinePairManagement()

virtual int ttkTopologicalSimplification::GetFinePairManagement ( )

virtual

GetForceInputOffsetScalarField()

virtual bool ttkTopologicalSimplification::GetForceInputOffsetScalarField ( )

virtual

GetForceInputVertexScalarField()

virtual bool ttkTopologicalSimplification::GetForceInputVertexScalarField ( )

virtual

GetLearningRate()

virtual double ttkTopologicalSimplification::GetLearningRate ( )

virtual

GetLowerThreshold()

virtual int ttkTopologicalSimplification::GetLowerThreshold ( )

virtual

GetMethod()

virtual int ttkTopologicalSimplification::GetMethod ( )

virtual

GetMethodOptimization()

virtual int ttkTopologicalSimplification::GetMethodOptimization ( )

virtual

GetOptimizationWithoutMatching()

virtual bool ttkTopologicalSimplification::GetOptimizationWithoutMatching ( )

virtual

GetPairTypeToDelete()

virtual int ttkTopologicalSimplification::GetPairTypeToDelete ( )

virtual

GetPDCMethod()

virtual int ttkTopologicalSimplification::GetPDCMethod ( )

virtual

GetPersistenceThreshold()

virtual double ttkTopologicalSimplification::GetPersistenceThreshold ( )

virtual

GetPrintFrequency()

virtual int ttkTopologicalSimplification::GetPrintFrequency ( )

virtual

GetThreshold()

virtual double ttkTopologicalSimplification::GetThreshold ( )

virtual

GetThresholdMethod()

virtual int ttkTopologicalSimplification::GetThresholdMethod ( )

virtual

GetUpperThreshold()

virtual int ttkTopologicalSimplification::GetUpperThreshold ( )

virtual

GetUseFastPersistenceUpdate()

virtual bool ttkTopologicalSimplification::GetUseFastPersistenceUpdate ( )

virtual

IsA()

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

virtual

Reimplemented from ttkAlgorithm.

IsTypeOf()

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

static

New()

static ttkTopologicalSimplification * ttkTopologicalSimplification::New ( )

static

RequestData()

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

overrideprotected

Definition at line 44 of file ttkTopologicalSimplification.cpp.

SafeDownCast()

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

static

SetAddPerturbation()

virtual void ttkTopologicalSimplification::SetAddPerturbation ( bool  )

virtual

SetAlpha()

virtual void ttkTopologicalSimplification::SetAlpha ( double  )

virtual

SetChooseLearningRate()

virtual void ttkTopologicalSimplification::SetChooseLearningRate ( bool  )

virtual

SetCoefStopCondition()

virtual void ttkTopologicalSimplification::SetCoefStopCondition ( double  )

virtual

SetConsiderIdentifierAsBlackList()

virtual void ttkTopologicalSimplification::SetConsiderIdentifierAsBlackList ( bool  )

virtual

SetConstraintAveraging()

virtual void ttkTopologicalSimplification::SetConstraintAveraging ( bool  )

virtual

SetEpochNumber()

virtual void ttkTopologicalSimplification::SetEpochNumber ( int  )

virtual

SetFastAssignmentUpdate()

virtual void ttkTopologicalSimplification::SetFastAssignmentUpdate ( bool  )

virtual

SetFinePairManagement()

virtual void ttkTopologicalSimplification::SetFinePairManagement ( int  )

virtual

SetForceInputOffsetScalarField()

virtual void ttkTopologicalSimplification::SetForceInputOffsetScalarField ( bool  )

virtual

SetForceInputVertexScalarField()

virtual void ttkTopologicalSimplification::SetForceInputVertexScalarField ( bool  )

virtual

SetLearningRate()

virtual void ttkTopologicalSimplification::SetLearningRate ( double  )

virtual

SetLowerThreshold()

virtual void ttkTopologicalSimplification::SetLowerThreshold ( int  )

virtual

SetMethod()

virtual void ttkTopologicalSimplification::SetMethod ( int  )

virtual

SetMethodOptimization()

virtual void ttkTopologicalSimplification::SetMethodOptimization ( int  )

virtual

SetOptimizationWithoutMatching()

virtual void ttkTopologicalSimplification::SetOptimizationWithoutMatching ( bool  )

virtual

SetPairTypeToDelete()

virtual void ttkTopologicalSimplification::SetPairTypeToDelete ( int  )

virtual

SetPDCMethod()

virtual void ttkTopologicalSimplification::SetPDCMethod ( int  )

virtual

SetPersistenceThreshold()

virtual void ttkTopologicalSimplification::SetPersistenceThreshold ( double  )

virtual

SetPrintFrequency()

virtual void ttkTopologicalSimplification::SetPrintFrequency ( int  )

virtual

SetThreshold()

virtual void ttkTopologicalSimplification::SetThreshold ( double  )

virtual

SetThresholdMethod()

virtual void ttkTopologicalSimplification::SetThresholdMethod ( int  )

virtual

SetUpperThreshold()

virtual void ttkTopologicalSimplification::SetUpperThreshold ( int  )

virtual

SetUseFastPersistenceUpdate()

virtual void ttkTopologicalSimplification::SetUseFastPersistenceUpdate ( bool  )

virtual

---

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

• /home/julien/Pro/git/github/ttk-tierny/core/vtk/ttkTopologicalSimplification/ttkTopologicalSimplification.h
• /home/julien/Pro/git/github/ttk-tierny/core/vtk/ttkTopologicalSimplification/ttkTopologicalSimplification.cpp