TTK VTK-filter for scalar field smoothing. More...

#include <ttkScalarFieldSmoother.h>

Inheritance diagram for ttkScalarFieldSmoother:

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	SetNumberOfIterations (int)

virtual int	GetNumberOfIterations ()

virtual void	SetForceInputMaskScalarField (bool)

virtual bool	GetForceInputMaskScalarField ()

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

static int	IsTypeOf (const char *type)

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

	~ttkScalarFieldSmoother () override

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::ScalarFieldSmoother
	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

Additional Inherited Members
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::ScalarFieldSmoother
int	dimensionNumber_ {1}

void *	inputData_ {nullptr}

void *	outputData_ {nullptr}

const char *	mask_ {nullptr}

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

Detailed Description

TTK VTK-filter for scalar field smoothing.

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

Date: November 2014.

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

Parameters

Input	vtkDataSet
Output	vtkDataSet

The input data array needs to be specified via the standard VTK call vtkAlgorithm::SetInputArrayToProcess() with the following parameters:

Parameters

idx	0 (FIXED: the first array the algorithm requires)
port	0 (FIXED: first port)
connection	0 (FIXED: first connection)
fieldAssociation	0 (FIXED: point data)
arrayName	(DYNAMIC: string identifier of the input array)

The optional mask array can be specified via the standard VTK call vtkAlgorithm::SetInputArrayToProcess() with the following parameters:

Parameters

idx	1 (FIXED: the second array the algorithm requires)
port	0 (FIXED: first port)
connection	0 (FIXED: first connection)
fieldAssociation	0 (FIXED: point data)
arrayName	(DYNAMIC: string identifier of the mask array)

Note: : To use this optional array, ForceInputMaskScalarField needs to be enabled with the setter ‘setForceInputMaskScalarField()’.

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

See the corresponding standalone program for a usage example:

standalone/ScalarFieldSmoother/main.cpp

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

See also: vtkGeometrySmoother; ttk::ScalarFieldSmoother

Online examples:

Definition at line 73 of file ttkScalarFieldSmoother.h.

Member Typedef Documentation

◆ Superclass

typedef ttkAlgorithm ttkScalarFieldSmoother::Superclass

Definition at line 80 of file ttkScalarFieldSmoother.h.

Constructor & Destructor Documentation

◆ ttkScalarFieldSmoother()

ttkScalarFieldSmoother::ttkScalarFieldSmoother ( )

protected

Definition at line 17 of file ttkScalarFieldSmoother.cpp.

◆ ~ttkScalarFieldSmoother()

ttkScalarFieldSmoother::~ttkScalarFieldSmoother ( )

overrideprotecteddefault

Member Function Documentation

◆ FillInputPortInformation()

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

overrideprotected

Definition at line 24 of file ttkScalarFieldSmoother.cpp.

◆ FillOutputPortInformation()

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

overrideprotected

Definition at line 33 of file ttkScalarFieldSmoother.cpp.

◆ GetClassName()

virtual const char * ttkScalarFieldSmoother::GetClassName ( )

virtual

Reimplemented from ttkAlgorithm.

◆ GetForceInputMaskScalarField()

virtual bool ttkScalarFieldSmoother::GetForceInputMaskScalarField ( )

virtual

◆ GetNumberOfIterations()

virtual int ttkScalarFieldSmoother::GetNumberOfIterations ( )

virtual

◆ IsA()

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

virtual

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

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

static

◆ New()

static ttkScalarFieldSmoother * ttkScalarFieldSmoother::New ( )

static

◆ RequestData()

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

overrideprotected

Definition at line 42 of file ttkScalarFieldSmoother.cpp.

◆ SafeDownCast()

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

static

◆ SetForceInputMaskScalarField()

virtual void ttkScalarFieldSmoother::SetForceInputMaskScalarField ( bool )

virtual

◆ SetNumberOfIterations()

virtual void ttkScalarFieldSmoother::SetNumberOfIterations ( int )

virtual

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

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

◆ ttkScalarFieldSmoother()

◆ ~ttkScalarFieldSmoother()

Member Function Documentation

◆ FillInputPortInformation()

◆ FillOutputPortInformation()

◆ GetClassName()

◆ GetForceInputMaskScalarField()

◆ GetNumberOfIterations()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ RequestData()

◆ SafeDownCast()

◆ SetForceInputMaskScalarField()

◆ SetNumberOfIterations()