TTK processing package for the topological simplification of scalar data. More...

#include <HarmonicField.h>

Inheritance diagram for ttk::HarmonicField:

Protected Types
enum class	SolvingMethodUserType { AUTO , CHOLESKY , ITERATIVE }

enum class	SolvingMethodType { CHOLESKY , ITERATIVE }

Protected Member Functions
	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

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)

Additional Inherited Members
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)

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 processing package for the topological simplification of scalar data.

Author: Pierre Guillou pierr.nosp@m.e.gu.nosp@m.illou.nosp@m.@lip.nosp@m.6.fr; Julien Tierny julie.nosp@m.n.ti.nosp@m.erny@.nosp@m.lip6.nosp@m..fr

Date: February 2019

See also: ttkHarmonicField.cpp % for a usage example.

Online examples:

Harmonic Skeleton example

Definition at line 27 of file HarmonicField.h.

Member Enumeration Documentation

◆ SolvingMethodType

enum class ttk::HarmonicField::SolvingMethodType

strongprotected

Enumerator
CHOLESKY
ITERATIVE

Definition at line 31 of file HarmonicField.h.

◆ SolvingMethodUserType

enum class ttk::HarmonicField::SolvingMethodUserType

strongprotected

Enumerator
AUTO
CHOLESKY
ITERATIVE

Definition at line 30 of file HarmonicField.h.

Constructor & Destructor Documentation

◆ HarmonicField()

ttk::HarmonicField::HarmonicField ( )

inlineprotected

Definition at line 33 of file HarmonicField.h.

Member Function Documentation

◆ execute()

template<class T , class TriangulationType >

int ttk::HarmonicField::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

protected

Definition at line 37 of file HarmonicField.cpp.

◆ preconditionTriangulation()

void ttk::HarmonicField::preconditionTriangulation ( AbstractTriangulation & triangulation ) const

inlineprotected

Definition at line 38 of file HarmonicField.h.

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

/home/julien/Pro/git/github/ttk-tierny/core/base/harmonicField/HarmonicField.h
/home/julien/Pro/git/github/ttk-tierny/core/base/harmonicField/HarmonicField.cpp

Protected Types

Protected Member Functions

Additional Inherited Members