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

#include <ttkMarchingTetrahedra.h>

Inheritance diagram for ttkMarchingTetrahedra:

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	SetSurfaceMode (int _arg)
virtual void	SetSurfaceMode (SURFACE_MODE)
virtual SURFACE_MODE	GetSurfaceMode () const
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 ttkMarchingTetrahedra *	New ()
static int	IsTypeOf (const char *type)
static ttkMarchingTetrahedra *	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
template<typename scalarType, typename triangulationType>
int	dispatch (vtkDataArray const inputScalars, vtkPolyData const outputSeparators, const triangulationType &triangulation)
	ttkMarchingTetrahedra ()
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::MarchingTetrahedra
	MarchingTetrahedra ()
template<typename dataType, typename triangulationType>
int	execute (const dataType *const scalars, const triangulationType &triangulation)
template<typename triangulationType>
int	computeMarchingCases_2D (unsigned char const tetCases, size_t const numEdges, const unsigned long long const scalars, const size_t const triangleCounter, const triangulationType &triangulation) const
template<typename triangulationType>
int	writeSeparators_2D (const unsigned char const tetCases, const size_t numEdges, const unsigned long long *const scalars, const triangulationType &triangulation)
template<typename triangulationType>
int	writeBoundaries_2D (const unsigned char const tetCases, const size_t numEdges, const unsigned long long *const scalars, const triangulationType &triangulation)
template<typename triangulationType>
int	writeBoundariesDetailed_2D (const unsigned char const tetCases, const size_t numEdges, const unsigned long long *const scalars, const triangulationType &triangulation)
template<typename triangulationType>
int	computeMarchingCases_3D (unsigned char const tetCases, size_t const numTriangles, const unsigned long long const scalars, const size_t const triangleCounter, const triangulationType &triangulation) const
template<typename triangulationType>
int	writeSeparators_3D (const unsigned char const tetCases, const size_t numTriangles, const unsigned long long *const scalars, const triangulationType &triangulation)
template<typename triangulationType>
int	writeBoundaries_3D (const unsigned char const tetCases, const size_t numTriangles, const unsigned long long *const scalars, const triangulationType &triangulation)
template<typename triangulationType>
int	writeBoundariesDetailed_3D (const unsigned char const tetCases, const size_t numTriangles, const unsigned long long *const scalars, const triangulationType &triangulation)

Additional Inherited Members
Protected Types inherited from ttk::MarchingTetrahedra
enum class	SURFACE_MODE { SM_SEPARATORS = 0 , SM_BOUNDARIES = 1 , SM_BOUNDARIES_DETAILED = 2 }
	Type of 2-separatrix output. More...
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::MarchingTetrahedra
SURFACE_MODE	SurfaceMode {SURFACE_MODE::SM_SEPARATORS}
SimplexId	output_numberOfPoints_ {}
SimplexId	output_numberOfCells_ {}
std::vector< float >	output_points_
std::vector< unsigned long long >	output_cells_labels_
std::vector< SimplexId >	output_cells_connectivity_
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::MarchingTetrahedra module.

Author: Robin Maack maack.nosp@m.@rpt.nosp@m.u.de

Date: May 2023.

Given an input point data array and triangulation this class executes the marching tetrahedra/triangles algorithm. It has three options that either separate each label with a single separating geometry inbetween two labels, or a separating geometry enclosing each label (detailed and fast mode).

Parameters

Input	Input scalar field, defined as a point data scalar field attached to a geometry, either 2D or 3D, either regular grid or triangulation (vtkDataSet)
Output	Output separating geometry (vtkPolyData)

This filter can be used like 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/MarchingTetrahedra/main.cpp

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

Related publication
"Parallel Computation of Piecewise Linear Morse-Smale Segmentations"
Robin G. C. Maack, Jonas Lukasczyk, Julien Tierny, Hans Hagen, Ross Maciejewski, Christoph Garth
IEEE Transactions on Visualization and Computer Graphics

See also: ttk::MarchingTetrahedra

Online examples:

Morse-Smale segmentation example

Definition at line 60 of file ttkMarchingTetrahedra.h.

Member Typedef Documentation

◆ Superclass

typedef ttkAlgorithm ttkMarchingTetrahedra::Superclass

Definition at line 67 of file ttkMarchingTetrahedra.h.

Constructor & Destructor Documentation

◆ ttkMarchingTetrahedra()

ttkMarchingTetrahedra::ttkMarchingTetrahedra ( )

protected

Definition at line 29 of file ttkMarchingTetrahedra.cpp.

Member Function Documentation

◆ dispatch()

template<typename scalarType, typename triangulationType>

int ttkMarchingTetrahedra::dispatch	(	vtkDataArray *const	inputScalars,
		vtkPolyData *const	outputSeparators,
		const triangulationType &	triangulation )

protected

Definition at line 54 of file ttkMarchingTetrahedra.cpp.

◆ FillInputPortInformation()

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

overrideprotected

Definition at line 35 of file ttkMarchingTetrahedra.cpp.

◆ FillOutputPortInformation()

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

overrideprotected

Definition at line 44 of file ttkMarchingTetrahedra.cpp.

◆ GetClassName()

virtual const char * ttkMarchingTetrahedra::GetClassName ( )

virtual

Reimplemented from ttkAlgorithm.

◆ GetSurfaceMode()

virtual SURFACE_MODE ttkMarchingTetrahedra::GetSurfaceMode ( ) const

virtual

◆ IsA()

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

virtual

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

int ttkMarchingTetrahedra::IsTypeOf ( const char * type )

static

◆ New()

ttkMarchingTetrahedra * ttkMarchingTetrahedra::New ( )

static

◆ RequestData()

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

overrideprotected

Definition at line 116 of file ttkMarchingTetrahedra.cpp.

◆ SafeDownCast()

ttkMarchingTetrahedra * ttkMarchingTetrahedra::SafeDownCast ( vtkObject * o )

static

◆ SetSurfaceMode() [1/2]

virtual void ttkMarchingTetrahedra::SetSurfaceMode ( int _arg )

virtual

◆ SetSurfaceMode() [2/2]

virtual void ttkMarchingTetrahedra::SetSurfaceMode ( SURFACE_MODE )

virtual

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

/data/julien/git/github/tierny/ttk-fork/core/vtk/ttkMarchingTetrahedra/ttkMarchingTetrahedra.h
/data/julien/git/github/tierny/ttk-fork/core/vtk/ttkMarchingTetrahedra/ttkMarchingTetrahedra.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

◆ ttkMarchingTetrahedra()

Member Function Documentation

◆ dispatch()

◆ FillInputPortInformation()

◆ FillOutputPortInformation()

◆ GetClassName()

◆ GetSurfaceMode()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ RequestData()

◆ SafeDownCast()

◆ SetSurfaceMode() [1/2]

◆ SetSurfaceMode() [2/2]