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	SetUseLTS (bool)
virtual bool	GetUseLTS ()
virtual void	SetPersistenceThreshold (double)
virtual double	GetPersistenceThreshold ()
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 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, 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::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, const triangulationType &triangulation)
void	setBackend (const BACKEND arg)
int	preconditionTriangulation (AbstractTriangulation *triangulation)

Additional Inherited Members
Protected Types inherited from ttk::TopologicalSimplification
enum class	BACKEND { LEGACY , LTS }
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_
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 ttkFTMTree, 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
Proc. of IEEE VIS 2012.
IEEE Transactions on Visualization and Computer Graphics, 2012.

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

See also

ttkTopologicalSimplificationByPersistence

ttkScalarFieldCriticalPoints

ttkIntegralLines

ttkFTMTree

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
  
• Tribute example
  
• Uncertain Starting Vortex example
  

Definition at line 132 of file ttkTopologicalSimplification.h.

Member Typedef Documentation

Superclass

typedef ttkAlgorithm ttkTopologicalSimplification::Superclass

Definition at line 138 of file ttkTopologicalSimplification.h.

Constructor & Destructor Documentation

ttkTopologicalSimplification()

ttkTopologicalSimplification::ttkTopologicalSimplification ( )

protected

Definition at line 17 of file ttkTopologicalSimplification.cpp.

Member Function Documentation

FillInputPortInformation()

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

overrideprotected

Definition at line 22 of file ttkTopologicalSimplification.cpp.

FillOutputPortInformation()

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

overrideprotected

Definition at line 34 of file ttkTopologicalSimplification.cpp.

GetAddPerturbation()

virtual bool ttkTopologicalSimplification::GetAddPerturbation ( )

virtual

GetClassName()

virtual const char * ttkTopologicalSimplification::GetClassName ( )

virtual

Reimplemented from ttkAlgorithm.

GetConsiderIdentifierAsBlackList()

virtual bool ttkTopologicalSimplification::GetConsiderIdentifierAsBlackList ( )

virtual

GetForceInputOffsetScalarField()

virtual bool ttkTopologicalSimplification::GetForceInputOffsetScalarField ( )

virtual

GetForceInputVertexScalarField()

virtual bool ttkTopologicalSimplification::GetForceInputVertexScalarField ( )

virtual

GetPersistenceThreshold()

virtual double ttkTopologicalSimplification::GetPersistenceThreshold ( )

virtual

GetUseLTS()

virtual bool ttkTopologicalSimplification::GetUseLTS ( )

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 43 of file ttkTopologicalSimplification.cpp.

SafeDownCast()

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

static

SetAddPerturbation()

virtual void ttkTopologicalSimplification::SetAddPerturbation ( bool  )

virtual

SetConsiderIdentifierAsBlackList()

virtual void ttkTopologicalSimplification::SetConsiderIdentifierAsBlackList ( bool  )

virtual

SetForceInputOffsetScalarField()

virtual void ttkTopologicalSimplification::SetForceInputOffsetScalarField ( bool  )

virtual

SetForceInputVertexScalarField()

virtual void ttkTopologicalSimplification::SetForceInputVertexScalarField ( bool  )

virtual

SetPersistenceThreshold()

virtual void ttkTopologicalSimplification::SetPersistenceThreshold ( double  )

virtual

SetUseLTS()

virtual void ttkTopologicalSimplification::SetUseLTS ( 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