TTK VTK-filter that works in conjunction with the ttkEndFor filter to iterate over blocks, rows, array values, and arrays. More...

#include <ttkForEach.h>

Inheritance diagram for ttkForEach:

Public Types
typedef ttkExtract	Superclass

Public Types inherited from ttkExtract
enum class	EXTRACTION_MODE { AUTO = -1 , BLOCKS = 0 , ROWS = 1 , GEOMETRY = 2 , ARRAY_VALUES = 3 , ARRAYS = 4 , BLOCK_TUPLES = 5 }

enum class	VALIDATION_MODE { LESS_THEN = 0 , LESS_EQUAL_THEN = 1 , EQUAL = 2 , UNEQUAL = 3 , GREATER_EQUAL_THEN = 4 , GREATER_THEN = 5 }

enum class	CELL_MODE { ALL = 0 , ANY = 1 }

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

virtual void	SetIterationIdx (int)

virtual int	GetIterationNumber ()

virtual void	SetIterationNumber (int)

Public Member Functions inherited from ttkExtract
virtual void	SetExtractionMode (int _arg)

virtual void	SetExtractionMode (EXTRACTION_MODE)

virtual EXTRACTION_MODE	GetExtractionMode () const

virtual void	SetValidationMode (int _arg)

virtual void	SetValidationMode (VALIDATION_MODE)

virtual VALIDATION_MODE	GetValidationMode () const

virtual void	SetCellMode (int _arg)

virtual void	SetCellMode (CELL_MODE)

virtual CELL_MODE	GetCellMode () const

virtual void	SetMaskOnly (bool)

virtual bool	GetMaskOnly ()

virtual void	SetOutputType (int)

virtual int	GetOutputType ()

virtual void	SetExpressionString (const std::string &)

virtual std::string	GetExpressionString ()

virtual void	SetExtractUniqueValues (bool)

virtual bool	GetExtractUniqueValues ()

virtual void	SetArrayAttributeType (int)

virtual int	GetArrayAttributeType ()

virtual void	SetOutputArrayName (const std::string &)

virtual std::string	GetOutputArrayName ()

virtual void	SetImageExtent (int, int, int, int, int, int)

virtual void	SetImageExtent (int[6])

virtual int *	GetImageExtent ()

virtual void	GetImageExtent (int &, int &, int &, int &, int &, int &)

virtual void	GetImageExtent (int[6])

std::string	GetVtkDataTypeName (const int outputType) const

int	ExtractBlocks (vtkDataObject output, vtkDataObject input, const std::vector< double > &indices, const bool &extractTuples) const

int	ExtractRows (vtkDataObject output, vtkDataObject input, const std::vector< double > &indices) const

int	AddMaskArray (vtkDataObject output, vtkDataObject input, const std::vector< double > &labels)

int	ExtractGeometry (vtkDataObject output, vtkDataObject input, const std::vector< double > &labels)

int	ExtractArrayValues (vtkDataObject output, vtkDataObject input, const std::vector< double > &indices)

int	ExtractArray (vtkDataObject output, vtkDataObject input, const std::vector< double > &indices)

virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

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

static int	IsTypeOf (const char *type)

static ttkForEach *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from ttkExtract
static ttkExtract *	New ()

static int	IsTypeOf (const char *type)

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

	~ttkForEach () override

int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override

Protected Member Functions inherited from ttkExtract
	ttkExtract ()

	~ttkExtract () override

int	FillInputPortInformation (int port, vtkInformation *info) override

int	FillOutputPortInformation (int port, vtkInformation *info) override

int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) 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)

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 works in conjunction with the ttkEndFor filter to iterate over blocks, rows, array values, and arrays.

Author: Jonas Lukasczyk jl@jl.nosp@m.uk.d.nosp@m.e

Date: 01.01.2019

This filter works in conjunction with the ttkEndFor filter to iterate over blocks, rows, array values, and arrays.

Parameters

Input	vktObject either a vtkMultiBlockDataSet, vtkTable, or vtkDataSet
Output	vktObject one element of the input

Online examples:

Definition at line 33 of file ttkForEach.h.

Member Typedef Documentation

◆ Superclass

typedef ttkExtract ttkForEach::Superclass

Definition at line 42 of file ttkForEach.h.

Constructor & Destructor Documentation

◆ ttkForEach()

ttkForEach::ttkForEach ( )

protected

Definition at line 17 of file ttkForEach.cpp.

◆ ~ttkForEach()

ttkForEach::~ttkForEach ( )

overrideprotecteddefault

Member Function Documentation

◆ GetClassName()

virtual const char * ttkForEach::GetClassName ( )

virtual

Reimplemented from ttkExtract.

◆ GetIterationIdx()

virtual int ttkForEach::GetIterationIdx ( )

virtual

◆ GetIterationNumber()

virtual int ttkForEach::GetIterationNumber ( )

virtual

◆ IsA()

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

virtual

Reimplemented from ttkExtract.

◆ IsTypeOf()

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

static

◆ New()

static ttkForEach * ttkForEach::New ( )

static

◆ RequestData()

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

overrideprotected

Definition at line 38 of file ttkForEach.cpp.

◆ SafeDownCast()

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

static

◆ SetIterationIdx()

virtual void ttkForEach::SetIterationIdx ( int )

virtual

◆ SetIterationNumber()

virtual void ttkForEach::SetIterationNumber ( int )

virtual

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

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

◆ ttkForEach()

◆ ~ttkForEach()

Member Function Documentation

◆ GetClassName()

◆ GetIterationIdx()

◆ GetIterationNumber()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ RequestData()

◆ SafeDownCast()

◆ SetIterationIdx()

◆ SetIterationNumber()