TTK VTK-filter that computes connected components based on a scalar field. More...

#include <ttkConnectedComponents.h>

Inheritance diagram for ttkConnectedComponents:

Public Types
typedef ttkAlgorithm	Superclass

Public Types inherited from ttkAlgorithm
typedef vtkAlgorithm	Superclass

Public Member Functions
virtual void	SetBackgroundThreshold (double)

virtual double	GetBackgroundThreshold ()

virtual void	SetAugmentSegmentationWithComponentSize (bool)

virtual bool	GetAugmentSegmentationWithComponentSize ()

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

static int	IsTypeOf (const char *type)

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

	~ttkConnectedComponents () 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::ConnectedComponents
	ConnectedComponents ()

	~ConnectedComponents () override=default

int	preconditionTriangulation (ttk::AbstractTriangulation *triangulation) const

template<typename TT = ttk::AbstractTriangulation>
int	computeFloodFill (int labels, std::vector< Component > &components, const TT triangulation, const TID seed) const

template<typename DT >
int	initializeComponentIds (int componentIds, const TID nVertices, const DT featureMask=nullptr, const DT backgroundThreshold=0) const

template<typename TT = ttk::AbstractTriangulation>
int	computeConnectedComponents (std::vector< Component > &components, int componentIds, const TT triangulation) const

template<typename F , typename DT >
int	mapData (std::vector< Component > &components, const int componentIds, const int nVertices, const F f, DT out) 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 computes connected components based on a scalar field.

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

Date: 22.02.2022

VTK wrapping code for the ttk::ConnectedComponents package.

This filter consumes a scalar field with a feature mask and computes for each edge connected group of vertices with a non-background mask value a so-called connected component via flood-filling, where the background is masked with values smaller-equal zero. The computed components store the size, seed, and center of mass of each component. The flag UseSeedIdAsComponentId controls if the resulting segmentation is either labeled by the index of the component, or by its seed location (which can be used as a deterministic component label).

The input data array that contains the feature mask needs to be specified via the standard VTK call 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 VTK array)

See also: ttk::ConnectedComponents

Definition at line 40 of file ttkConnectedComponents.h.

Member Typedef Documentation

◆ Superclass

typedef ttkAlgorithm ttkConnectedComponents::Superclass

Definition at line 55 of file ttkConnectedComponents.h.

Constructor & Destructor Documentation

◆ ttkConnectedComponents()

ttkConnectedComponents::ttkConnectedComponents ( )

protected

Definition at line 18 of file ttkConnectedComponents.cpp.

◆ ~ttkConnectedComponents()

ttkConnectedComponents::~ttkConnectedComponents ( )

overrideprotecteddefault

Member Function Documentation

◆ FillInputPortInformation()

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

overrideprotected

Definition at line 26 of file ttkConnectedComponents.cpp.

◆ FillOutputPortInformation()

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

overrideprotected

Definition at line 35 of file ttkConnectedComponents.cpp.

◆ GetAugmentSegmentationWithComponentSize()

virtual bool ttkConnectedComponents::GetAugmentSegmentationWithComponentSize ( )

virtual

◆ GetBackgroundThreshold()

virtual double ttkConnectedComponents::GetBackgroundThreshold ( )

virtual

◆ GetClassName()

virtual const char * ttkConnectedComponents::GetClassName ( )

virtual

Reimplemented from ttkAlgorithm.

◆ IsA()

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

virtual

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

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

static

◆ New()

static ttkConnectedComponents * ttkConnectedComponents::New ( )

static

◆ RequestData()

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

overrideprotected

Definition at line 47 of file ttkConnectedComponents.cpp.

◆ SafeDownCast()

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

static

◆ SetAugmentSegmentationWithComponentSize()

virtual void ttkConnectedComponents::SetAugmentSegmentationWithComponentSize ( bool )

virtual

◆ SetBackgroundThreshold()

virtual void ttkConnectedComponents::SetBackgroundThreshold ( double )

virtual

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

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

◆ ttkConnectedComponents()

◆ ~ttkConnectedComponents()

Member Function Documentation

◆ FillInputPortInformation()

◆ FillOutputPortInformation()

◆ GetAugmentSegmentationWithComponentSize()

◆ GetBackgroundThreshold()

◆ GetClassName()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ RequestData()

◆ SafeDownCast()

◆ SetAugmentSegmentationWithComponentSize()

◆ SetBackgroundThreshold()