TTK VTK-filter for harmonic field computations. More...

#include <ttkHarmonicField.h>

Inheritance diagram for ttkHarmonicField:

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	SetOutputScalarFieldName (const std::string &)

virtual std::string	GetOutputScalarFieldName ()

virtual void	SetForceConstraintIdentifiers (bool)

virtual bool	GetForceConstraintIdentifiers ()

virtual void	SetUseCotanWeights (bool)

virtual bool	GetUseCotanWeights ()

void	SetSolvingMethod (const int arg_)

virtual int	GetSolvingMethod ()

virtual void	SetLogAlpha (double)

virtual double	GetLogAlpha ()

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

static int	IsTypeOf (const char *type)

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

	~ttkHarmonicField () override=default

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

void	preconditionTriangulation (AbstractTriangulation &triangulation) const

template<class T , class TriangulationType = AbstractTriangulation>
int	execute (const TriangulationType &triangulation, const SimplexId constraintNumber, const SimplexId const sources, const T const constraints, T *const outputScalarField, const bool useCotanWeights=true, const SolvingMethodUserType solvingMethod=SolvingMethodUserType::AUTO, const double logAlpha=5.0) const

Additional Inherited Members
Protected Types inherited from ttk::HarmonicField
enum class	SolvingMethodUserType { AUTO , CHOLESKY , ITERATIVE }

enum class	SolvingMethodType { CHOLESKY , ITERATIVE }

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 harmonic field computations.

Author: Pierre Guillou pierr.nosp@m.e.gu.nosp@m.illou.nosp@m.@lip.nosp@m.6.fr

Date: February 2019

The current filter takes a list of sources with attached scalar values and produces a scalar harmonic field fulfilling these constraints.

Parameters

Input0	Input geometry, either 2D or 3D, either regular grid or triangulation (vtkDataSet)
Input1	List of critical point constraints (vtkPointSet)
Output	Output harmonic 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 publication
"Dynamic harmonic fields for surface processing"
Kai Xu, Hao Zhang, Daniel Cohen-Or, Yueshan Xiong
Computers & Graphics 2009.

See also: ttkScalarFieldCriticalPoints; ttkIntegralLines; ttkFTMTree; ttkIdentifiers; ttk::HarmonicField

Online examples:

Harmonic Skeleton example

Definition at line 51 of file ttkHarmonicField.h.

Member Typedef Documentation

◆ Superclass

typedef ttkAlgorithm ttkHarmonicField::Superclass

Definition at line 57 of file ttkHarmonicField.h.

Constructor & Destructor Documentation

◆ ttkHarmonicField()

ttkHarmonicField::ttkHarmonicField ( )

protected

Definition at line 15 of file ttkHarmonicField.cpp.

◆ ~ttkHarmonicField()

ttkHarmonicField::~ttkHarmonicField ( )

overrideprotecteddefault

Member Function Documentation

◆ FillInputPortInformation()

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

overrideprotected

Definition at line 20 of file ttkHarmonicField.cpp.

◆ FillOutputPortInformation()

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

overrideprotected

Definition at line 31 of file ttkHarmonicField.cpp.

◆ GetClassName()

virtual const char * ttkHarmonicField::GetClassName ( )

virtual

Reimplemented from ttkAlgorithm.

◆ GetForceConstraintIdentifiers()

virtual bool ttkHarmonicField::GetForceConstraintIdentifiers ( )

virtual

◆ GetLogAlpha()

virtual double ttkHarmonicField::GetLogAlpha ( )

virtual

◆ GetOutputScalarFieldName()

virtual std::string ttkHarmonicField::GetOutputScalarFieldName ( )

virtual

◆ GetSolvingMethod()

virtual int ttkHarmonicField::GetSolvingMethod ( )

inlinevirtual

Definition at line 78 of file ttkHarmonicField.h.

◆ GetUseCotanWeights()

virtual bool ttkHarmonicField::GetUseCotanWeights ( )

virtual

◆ IsA()

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

virtual

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

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

static

◆ New()

static ttkHarmonicField * ttkHarmonicField::New ( )

static

◆ RequestData()

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

overrideprotected

Definition at line 40 of file ttkHarmonicField.cpp.

◆ SafeDownCast()

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

static

◆ SetForceConstraintIdentifiers()

virtual void ttkHarmonicField::SetForceConstraintIdentifiers ( bool )

virtual

◆ SetLogAlpha()

virtual void ttkHarmonicField::SetLogAlpha ( double )

virtual

◆ SetOutputScalarFieldName()

virtual void ttkHarmonicField::SetOutputScalarFieldName ( const std::string & )

virtual

◆ SetSolvingMethod()

void ttkHarmonicField::SetSolvingMethod ( const int arg_ )

inline

Definition at line 68 of file ttkHarmonicField.h.

◆ SetUseCotanWeights()

virtual void ttkHarmonicField::SetUseCotanWeights ( bool )

virtual

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

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

◆ ttkHarmonicField()

◆ ~ttkHarmonicField()

Member Function Documentation

◆ FillInputPortInformation()

◆ FillOutputPortInformation()

◆ GetClassName()

◆ GetForceConstraintIdentifiers()

◆ GetLogAlpha()

◆ GetOutputScalarFieldName()

◆ GetSolvingMethod()

◆ GetUseCotanWeights()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ RequestData()

◆ SafeDownCast()

◆ SetForceConstraintIdentifiers()

◆ SetLogAlpha()

◆ SetOutputScalarFieldName()

◆ SetSolvingMethod()

◆ SetUseCotanWeights()