TTK VTK-filter that wraps the discreteGradient processing package. More...

#include <ttkDiscreteGradient.h>

Inheritance diagram for ttkDiscreteGradient:

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	SetForceInputOffsetScalarField (bool)

virtual bool	GetForceInputOffsetScalarField ()

virtual void	SetComputeGradientGlyphs (bool)

virtual bool	GetComputeGradientGlyphs ()

virtual void	SetBackend (int)

virtual int	GetBackend ()

virtual void	SetStochasticGradientSeed (unsigned int)

virtual unsigned int	GetStochasticGradientSeed ()

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

static int	IsTypeOf (const char *type)

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

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::dcg::DiscreteGradient
	DiscreteGradient ()

template<typename dataType, typename triangulationType>
int	buildGradient (const triangulationType &triangulation, bool bypassCache=false, const std::vector< bool > *updateMask=nullptr)

template<typename triangulationType>
int	buildGradient (const triangulationType &triangulation, bool bypassCache=false, const std::vector< bool > *updateMask=nullptr)

void	setInputScalarField (const void *const data, const size_t mTime)

void	setBackend (const BACKEND newBackend)

void	setSeed (const unsigned int &newSeed)

void	setReturnSaddleConnectors (const bool &returnSaddleConnectors)

bool	newParameters ()

void	setSaddleConnectorsPersistenceThreshold (double threshold)

void	preconditionTriangulation (AbstractTriangulation *const data)

void	setLocalGradient ()
	Use local storage instead of cache.

void	setInputOffsets (const SimplexId *const data)

int	getDimensionality () const

int	getNumberOfDimensions () const

template<typename triangulationType>
SimplexId	getNumberOfCells (const int dimension, const triangulationType &triangulation) const

template<typename triangulationType>
bool	isBoundary (const Cell &cell, const triangulationType &triangulation) const

bool	isCellCritical (const int cellDim, const SimplexId cellId) const

bool	isCellCritical (const Cell &cell) const

template<typename triangulationType>
SimplexId	getPairedCell (const Cell &cell, const triangulationType &triangulation, bool isReverse=false) const

template<typename triangulationType>
int	getAscendingPath (const Cell &cell, std::vector< Cell > &vpath, const triangulationType &triangulation, const bool enableCycleDetector=false) const

template<typename triangulationType>
int	getDescendingPath (const Cell &cell, std::vector< Cell > &vpath, const triangulationType &triangulation) const

template<typename triangulationType>
bool	getDescendingPathThroughWall (const Cell &saddle2, const Cell &saddle1, const std::vector< bool > &isVisited, std::vector< Cell > *const vpath, const triangulationType &triangulation, const bool stopIfMultiConnected=false, const bool enableCycleDetector=false) const

template<typename triangulationType>
bool	getAscendingPathThroughWall (const Cell &saddle1, const Cell &saddle2, const std::vector< bool > &isVisited, std::vector< Cell > const vpath, const triangulationType &triangulation, const bool stopIfMultiConnected=false, const bool enableCycleDetector=false, bool const cycleFound=nullptr) const

template<typename triangulationType>
bool	detectGradientCycle (const Cell &cell, const triangulationType &triangulation) const

template<typename triangulationType>
int	getDescendingWall (const Cell &cell, VisitedMask &mask, const triangulationType &triangulation, std::vector< Cell > const wall=nullptr, std::vector< SimplexId > const saddles=nullptr) const

template<typename triangulationType>
int	getAscendingWall (const Cell &cell, VisitedMask &mask, const triangulationType &triangulation, std::vector< Cell > const wall=nullptr, std::vector< SimplexId > const saddles=nullptr) const

template<typename triangulationType>
SimplexId	getCellGreaterVertex (const Cell c, const triangulationType &triangulation) const

template<typename triangulationType>
SimplexId	getCellLowerVertex (const Cell c, const triangulationType &triangulation) const

template<typename triangulationType>
int	setCriticalPoints (const std::array< std::vector< SimplexId >, 4 > &criticalCellsByDim, std::vector< std::array< float, 3 > > &points, std::vector< char > &cellDimensions, std::vector< SimplexId > &cellIds, std::vector< char > &isOnBoundary, std::vector< SimplexId > &PLVertexIdentifiers, const triangulationType &triangulation) const

template<typename triangulationType>
int	setCriticalPoints (std::vector< std::array< float, 3 > > &points, std::vector< char > &cellDimensions, std::vector< SimplexId > &cellIds, std::vector< char > &isOnBoundary, std::vector< SimplexId > &PLVertexIdentifiers, const triangulationType &triangulation) const

template<typename triangulationType>
int	getCriticalPoints (std::array< std::vector< SimplexId >, 4 > &criticalCellsByDim, const triangulationType &triangulation) const

template<typename triangulationType>
int	getCriticalPoints (std::vector< Cell > &criticalPoints, const triangulationType &triangulation) const

int	setManifoldSize (const std::array< std::vector< SimplexId >, 4 > &criticalCellsByDim, const SimplexId const ascendingManifold, const SimplexId const descendingManifold, std::vector< SimplexId > &manifoldSize) const

template<typename triangulationType>
int	setGradientGlyphs (std::vector< std::array< float, 3 > > &points, std::vector< char > &points_pairOrigins, std::vector< char > &cells_pairTypes, std::vector< SimplexId > &cellsIds, std::vector< char > &cellsDimensions, const triangulationType &triangulation) const

CriticalType	criticalTypeFromCellDimension (const int dim) const
	Return the critical type corresponding to given dimension.

template<typename dataType, typename triangulationType>
dataType	getPersistence (const Cell &up, const Cell &down, const dataType *const scalars, const triangulationType &triangulation) const

bool	isMinimum (const Cell &cell) const

bool	isSaddle1 (const Cell &cell) const

bool	isSaddle2 (const Cell &cell) const

bool	isMaximum (const Cell &cell) const

template<typename triangulationType>
int	reverseAscendingPath (const std::vector< Cell > &vpath, const triangulationType &triangulation) const

template<typename triangulationType>
int	reverseDescendingPath (const std::vector< Cell > &vpath, const triangulationType &triangulation) const

template<typename triangulationType>
int	reverseAscendingPathOnWall (const std::vector< Cell > &vpath, const triangulationType &triangulation, bool cancelReversal=false) const

template<typename triangulationType>
int	reverseDescendingPathOnWall (const std::vector< Cell > &vpath, const triangulationType &triangulation) const

int	getCriticalPointMap (const std::vector< std::pair< SimplexId, char > > &criticalPoints, std::vector< char > &isPL)

template<typename dataType, typename triangulationType>
int	simplifySaddleSaddleConnections1 (const std::vector< std::pair< SimplexId, char > > &criticalPoints, const std::vector< char > &isPL, const int iterationThreshold, const bool allowBoundary, const bool allowBruteForce, const bool returnSaddleConnectors, const triangulationType &triangulation)

template<typename dataType, typename triangulationType>
int	simplifySaddleSaddleConnections2 (const std::vector< std::pair< SimplexId, char > > &criticalPoints, const std::vector< char > &isPL, const int iterationThreshold, const bool allowBoundary, const bool allowBruteForce, const bool returnSaddleConnectors, const triangulationType &triangulation)

template<typename dataType, typename triangulationType>
int	filterSaddleConnectors (const bool allowBoundary, const triangulationType &triangulation)

template<typename triangulationType>
ttk::SimplexId	getCellGreaterVertex (const Cell c, const triangulationType &triangulation) const

template<typename triangulationType>
ttk::SimplexId	getCellLowerVertex (const Cell c, const triangulationType &triangulation) const

Additional Inherited Members
Protected Types inherited from ttk::dcg::DiscreteGradient
enum class	BACKEND { CLASSIC_BACKEND = 0 , STOCHASTIC_BACKEND = 1 }

Static Protected Member Functions inherited from ttk::dcg::DiscreteGradient
static void	clearCache (const AbstractTriangulation &triangulation)

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::dcg::DiscreteGradient
int	dimensionality_ {-1}

int	IterationThreshold {50}

double	SaddleConnectorsPersistenceThreshold {}

SimplexId	numberOfVertices_ {}

BACKEND	BackEnd {BACKEND::CLASSIC_BACKEND}

BACKEND	OldBackEnd {BACKEND::CLASSIC_BACKEND}

unsigned int	Seed {}

unsigned int	OldSeed {}

bool	ReturnSaddleConnectors {}

bool	OldReturnSaddleConnectors {}

AbstractTriangulation::gradientType	localGradient_ {}

AbstractTriangulation::gradientKeyType	inputScalarField_ {}

AbstractTriangulation::gradientType *	gradient_ {}

const SimplexId *	inputOffsets_ {}

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 discreteGradient processing package.

Author: Guillaume Favelier guill.nosp@m.aume.nosp@m..fave.nosp@m.lier.nosp@m.@sorb.nosp@m.onne.nosp@m.-univ.nosp@m.ersi.nosp@m.te.fr

Date: April 2018.

VTK wrapping code for the ttk::dcg::DiscreteGradient package.

Parameters

Input	Input scalar field (vtkDataSet)
Output	Output scalar field (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 offset 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 offset array)

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

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

See the corresponding ParaView state file example for a usage example within a VTK pipeline.

See also: ttk::DiscreteGradient

Definition at line 50 of file ttkDiscreteGradient.h.

Member Typedef Documentation

◆ Superclass

typedef ttkAlgorithm ttkDiscreteGradient::Superclass

Definition at line 56 of file ttkDiscreteGradient.h.

Constructor & Destructor Documentation

◆ ttkDiscreteGradient()

ttkDiscreteGradient::ttkDiscreteGradient ( )

protected

Definition at line 17 of file ttkDiscreteGradient.cpp.

Member Function Documentation

◆ FillInputPortInformation()

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

overrideprotected

Definition at line 22 of file ttkDiscreteGradient.cpp.

◆ FillOutputPortInformation()

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

overrideprotected

Definition at line 31 of file ttkDiscreteGradient.cpp.

◆ GetBackend()

virtual int ttkDiscreteGradient::GetBackend ( )

virtual

◆ GetClassName()

virtual const char * ttkDiscreteGradient::GetClassName ( )

virtual

Reimplemented from ttkAlgorithm.

◆ GetComputeGradientGlyphs()

virtual bool ttkDiscreteGradient::GetComputeGradientGlyphs ( )

virtual

◆ GetForceInputOffsetScalarField()

virtual bool ttkDiscreteGradient::GetForceInputOffsetScalarField ( )

virtual

◆ GetStochasticGradientSeed()

virtual unsigned int ttkDiscreteGradient::GetStochasticGradientSeed ( )

virtual

◆ IsA()

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

virtual

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

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

static

◆ New()

static ttkDiscreteGradient * ttkDiscreteGradient::New ( )

static

◆ RequestData()

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

overrideprotected

Definition at line 238 of file ttkDiscreteGradient.cpp.

◆ SafeDownCast()

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

static

◆ SetBackend()

virtual void ttkDiscreteGradient::SetBackend ( int )

virtual

◆ SetComputeGradientGlyphs()

virtual void ttkDiscreteGradient::SetComputeGradientGlyphs ( bool )

virtual

◆ SetForceInputOffsetScalarField()

virtual void ttkDiscreteGradient::SetForceInputOffsetScalarField ( bool )

virtual

◆ SetStochasticGradientSeed()

virtual void ttkDiscreteGradient::SetStochasticGradientSeed ( unsigned int )

virtual

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

/home/julien/Pro/git/github/thomas/ttk-dani/core/vtk/ttkDiscreteGradient/ttkDiscreteGradient.h
/home/julien/Pro/git/github/thomas/ttk-dani/core/vtk/ttkDiscreteGradient/ttkDiscreteGradient.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

◆ ttkDiscreteGradient()

Member Function Documentation

◆ FillInputPortInformation()

◆ FillOutputPortInformation()

◆ GetBackend()

◆ GetClassName()

◆ GetComputeGradientGlyphs()

◆ GetForceInputOffsetScalarField()

◆ GetStochasticGradientSeed()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ RequestData()

◆ SafeDownCast()

◆ SetBackend()

◆ SetComputeGradientGlyphs()

◆ SetForceInputOffsetScalarField()

◆ SetStochasticGradientSeed()