TTK VTK-filter that wraps the ttk::HelloWorld module. More...

#include <ttkHelloWorld.h>

Inheritance diagram for ttkHelloWorld:

Public Types
typedef ttkAlgorithm	Superclass

Public Types inherited from ttkAlgorithm
typedef vtkAlgorithm	Superclass

Public Member Functions
virtual void	SetOutputArrayName (const std::string &)

virtual std::string	GetOutputArrayName ()

virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

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

static int	IsTypeOf (const char *type)

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

	~ttkHelloWorld () 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, 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::HelloWorld
	HelloWorld ()

int	preconditionTriangulation (ttk::AbstractTriangulation *triangulation) const

template<class dataType , class triangulationType = ttk::AbstractTriangulation>
int	computeAverages (dataType outputData, const dataType inputData, const triangulationType *triangulation) 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_

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

Detailed Description

TTK VTK-filter that wraps the ttk::HelloWorld module.

TODO 4: Provide your information and update the documentation (in particular regarding the order convention if input arrays need to be specified with the standard VTK call SetInputArrayToProcess()).

Author: Your Name Here your..nosp@m.emai.nosp@m.l@add.nosp@m.ress.nosp@m..here

Date: The Date Here.

This VTK filter uses the ttk::HelloWorld module to compute an averaging of the data values of an input point data array defined on the input vtkDataSet.

Parameters

Input	vtkDataSet.
Output	vtkDataSet.

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

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)

See the corresponding standalone program for a usage example:

standalone/HelloWorld/main.cpp

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

See also: ttk::HelloWorld; ttkAlgorithm

Definition at line 72 of file ttkHelloWorld.h.

Member Typedef Documentation

◆ Superclass

typedef ttkAlgorithm ttkHelloWorld::Superclass

Definition at line 97 of file ttkHelloWorld.h.

Constructor & Destructor Documentation

◆ ttkHelloWorld()

ttkHelloWorld::ttkHelloWorld ( )

protected

TODO 7: Implement the filter constructor and destructor (see cpp file)

TODO 7: Implement the filter constructor and destructor in the cpp file.

The constructor has to specify the number of input and output ports with the functions SetNumberOfInputPorts and SetNumberOfOutputPorts, respectively. It should also set default values for all filter parameters.

The destructor is usually empty unless you want to manage memory explicitly, by for example allocating memory on the heap that needs to be freed when the filter is destroyed.

Definition at line 30 of file ttkHelloWorld.cpp.

◆ ~ttkHelloWorld()

ttkHelloWorld::~ttkHelloWorld ( )

overrideprotecteddefault

Member Function Documentation

◆ FillInputPortInformation()

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

overrideprotected

TODO 8: Specify the input data type of each input port (see cpp file)

TODO 8: Specify the required input data type of each input port

This method specifies the required input object data types of the filter by adding the vtkAlgorithm::INPUT_REQUIRED_DATA_TYPE() key to the port information.

Definition at line 42 of file ttkHelloWorld.cpp.

◆ FillOutputPortInformation()

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

overrideprotected

TODO 9: Specify the data object type of each output port (see cpp file)

TODO 9: Specify the data object type of each output port

This method specifies in the port information object the data type of the corresponding output objects. It is possible to either explicitly specify a type by adding a vtkDataObject::DATA_TYPE_NAME() key:

 info->Set( vtkDataObject::DATA_TYPE_NAME(), "vtkUnstructuredGrid" );

or to pass a type of an input port to an output port by adding the ttkAlgorithm::SAME_DATA_TYPE_AS_INPUT_PORT() key (see below).

Note: prior to the execution of the RequestData method the pipeline will initialize empty output data objects based on this information.

Definition at line 65 of file ttkHelloWorld.cpp.

◆ GetClassName()

virtual const char * ttkHelloWorld::GetClassName ( )

virtual

Reimplemented from ttkAlgorithm.

◆ GetOutputArrayName()

virtual std::string ttkHelloWorld::GetOutputArrayName ( )

virtual

◆ IsA()

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

virtual

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

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

static

◆ New()

static ttkHelloWorld * ttkHelloWorld::New ( )

static

This static method and the macro below are VTK conventions on how to instantiate VTK objects. You don't have to modify this.

◆ RequestData()

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

overrideprotected

TODO 10: Pass VTK data to the base code and convert base code output to VTK (see cpp file)

TODO 10: Pass VTK data to the base code and convert base code output to VTK

This method is called during the pipeline execution to update the already initialized output data objects based on the given input data objects and filter parameters.

Note: 1) The passed input data objects are validated based on the information provided by the FillInputPortInformation method. 2) The output objects are already initialized based on the information provided by the FillOutputPortInformation method.

Definition at line 86 of file ttkHelloWorld.cpp.

◆ SafeDownCast()

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

static

◆ SetOutputArrayName()

virtual void ttkHelloWorld::SetOutputArrayName ( const std::string & )

virtual

TODO 6: Automatically generate getters and setters of filter parameters via vtkMacros.

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

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

◆ ttkHelloWorld()

◆ ~ttkHelloWorld()

Member Function Documentation

◆ FillInputPortInformation()

◆ FillOutputPortInformation()

◆ GetClassName()

◆ GetOutputArrayName()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ RequestData()

◆ SafeDownCast()

◆ SetOutputArrayName()