TTK processing package for scalar field smoothing. More...

#include <ScalarFieldSmoother.h>

Inheritance diagram for ttk::ScalarFieldSmoother:

Public Member Functions
	ScalarFieldSmoother ()

	~ScalarFieldSmoother () override

void	setDimensionNumber (const int &dimensionNumber)

void	setInputDataPointer (void *data)

void	setOutputDataPointer (void *data)

void	setMaskDataPointer (const char *const mask)

int	preconditionTriangulation (AbstractTriangulation *triangulation)

template<class dataType , class triangulationType = AbstractTriangulation>
int	smooth (const triangulationType *triangulation, const int &numberOfIterations) const

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
int	dimensionNumber_ {1}

void *	inputData_ {nullptr}

void *	outputData_ {nullptr}

const char *	mask_ {nullptr}

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_

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

Static Protected Attributes inherited from ttk::Debug
static COMMON_EXPORTS debug::LineMode	lastLineMode = ttk::debug::LineMode::NEW

Detailed Description

TTK processing package for scalar field smoothing.

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

Date: October 2014.

This class is a dummy example for the development of TTK classes. It smooths an input scalar field by averaging the scalar values on the link of each vertex.

Parameters

dataType Data type of the input scalar field (char, float, etc.).

See also: ttkScalarFieldSmoother.cpp for a usage example.

Online examples:

Definition at line 64 of file ScalarFieldSmoother.h.

Constructor & Destructor Documentation

◆ ScalarFieldSmoother()

ttk::ScalarFieldSmoother::ScalarFieldSmoother ( )

Definition at line 3 of file ScalarFieldSmoother.cpp.

◆ ~ScalarFieldSmoother()

ttk::ScalarFieldSmoother::~ScalarFieldSmoother ( )

overridedefault

Member Function Documentation

◆ preconditionTriangulation()

int ttk::ScalarFieldSmoother::preconditionTriangulation ( AbstractTriangulation * triangulation )

inline

Definition at line 86 of file ScalarFieldSmoother.h.

◆ setDimensionNumber()

void ttk::ScalarFieldSmoother::setDimensionNumber ( const int & dimensionNumber )

inline

Definition at line 70 of file ScalarFieldSmoother.h.

◆ setInputDataPointer()

void ttk::ScalarFieldSmoother::setInputDataPointer ( void * data )

inline

Definition at line 74 of file ScalarFieldSmoother.h.

◆ setMaskDataPointer()

void ttk::ScalarFieldSmoother::setMaskDataPointer ( const char *const mask )

inline

Definition at line 82 of file ScalarFieldSmoother.h.

◆ setOutputDataPointer()

void ttk::ScalarFieldSmoother::setOutputDataPointer ( void * data )

inline

Definition at line 78 of file ScalarFieldSmoother.h.

◆ smooth()

template<class dataType , class triangulationType >

int ttk::ScalarFieldSmoother::smooth	(	const triangulationType *	triangulation,
		const int &	numberOfIterations
	)		const

Definition at line 111 of file ScalarFieldSmoother.h.

Member Data Documentation

◆ dimensionNumber_

int ttk::ScalarFieldSmoother::dimensionNumber_ {1}

protected

Definition at line 102 of file ScalarFieldSmoother.h.

◆ inputData_

void* ttk::ScalarFieldSmoother::inputData_ {nullptr}

protected

Definition at line 103 of file ScalarFieldSmoother.h.

◆ mask_

const char* ttk::ScalarFieldSmoother::mask_ {nullptr}

protected

Definition at line 104 of file ScalarFieldSmoother.h.

◆ outputData_

void * ttk::ScalarFieldSmoother::outputData_ {nullptr}

protected

Definition at line 103 of file ScalarFieldSmoother.h.

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

/home/julien/Pro/git/github/ttk-tierny/core/base/scalarFieldSmoother/ScalarFieldSmoother.h
/home/julien/Pro/git/github/ttk-tierny/core/base/scalarFieldSmoother/ScalarFieldSmoother.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ScalarFieldSmoother()

◆ ~ScalarFieldSmoother()

Member Function Documentation

◆ preconditionTriangulation()

◆ setDimensionNumber()

◆ setInputDataPointer()

◆ setMaskDataPointer()

◆ setOutputDataPointer()

◆ smooth()

Member Data Documentation

◆ dimensionNumber_

◆ inputData_

◆ mask_

◆ outputData_