TTK
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
ttkFTRGraph Class Reference

TTK VTK-filter for the computation of Reeb Graphs. More...

#include <ttkFTRGraph.h>

Inheritance diagram for ttkFTRGraph:
ttkAlgorithm ttk::Debug ttk::BaseClass

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 ()
 
int getSkeletonNodes (const ttk::ftr::Graph &graph, vtkUnstructuredGrid *outputSkeletonNodes)
 
int addDirectSkeletonArc (const ttk::ftr::Graph &graph, const ttk::ftr::idSuperArc arcId, vtkPoints *points, vtkUnstructuredGrid *skeletonArcs, ttk::ftr::ArcData &arcData)
 
int addSampledSkeletonArc (const ttk::ftr::Graph &graph, const ttk::ftr::idSuperArc arcId, vtkPoints *points, vtkUnstructuredGrid *skeletonArcs, ttk::ftr::ArcData &arcData)
 
int addCompleteSkeletonArc (const ttk::ftr::Graph &graph, const ttk::ftr::idSuperArc arcId, vtkPoints *points, vtkUnstructuredGrid *skeletonArcs, ttk::ftr::ArcData &arcData)
 
int getSkeletonArcs (const ttk::ftr::Graph &graph, vtkUnstructuredGrid *outputSkeletonArcs)
 
int getSegmentation (const ttk::ftr::Graph &graph, vtkDataSet *outputSegmentation)
 
template<typename VTK_TT , typename TTK_TT >
int dispatch (ttk::ftr::Graph &graph)
 
void SetSingleSweep (const bool ss)
 control whether the computation should start from min and max (default) or use a single sweep starting only from the min (may be more robust)
 
bool GetSingleSweep () const
 
void SetWithSegmentation (const bool segm)
 control if the output should contains the segmentation information
 
bool GetWithSegmentation () const
 
void SetWithNormalize (const bool norm)
 if set to true, a post processing pass will be used to enforce consistent node ids between executions
 
bool GetWithNormalize () const
 
void SetSampling (int lvl)
 control the sampling level of the superarcs
 
int GetSuperArcSamplingLevel () const
 
- 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::SimplexIdGetIdentifierArrayPtr (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::TriangulationGetTriangulation (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 ttkFTRGraphNew ()
 
static int IsTypeOf (const char *type)
 
static ttkFTRGraphSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from ttkAlgorithm
static ttkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static ttkAlgorithmSafeDownCast (vtkObject *o)
 
static std::string GetOrderArrayName (vtkDataArray *const array)
 
static vtkInformationIntegerKey * SAME_DATA_TYPE_AS_INPUT_PORT ()
 

Protected Member Functions

 ttkFTRGraph ()
 
void identify (vtkDataSet *ds) const
 
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, 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_
 
Wrapperwrapper_
 
- Static Protected Attributes inherited from ttk::Debug
static COMMON_EXPORTS debug::LineMode lastLineMode = ttk::debug::LineMode::NEW
 

Detailed Description

TTK VTK-filter for the computation of Reeb Graphs.

Author
Charles Gueunet charl.nosp@m.es.g.nosp@m.ueune.nosp@m.t@ki.nosp@m.tware.nosp@m..com
Date
June 2017.
See also
ttk::ftm::FTRGraph

The computation of the Reeb graph done by this package is done in parallel if TTK_ENABLE_OPENMP is set to ON, using a task based approach described in the article mention below.

Parameters
InputInput scalar field, either 2D or 3D, regular grid or triangulation (vtkDataSet)
SingleSweepcontrol if the computation should start from both minima and maxima simultaneously. If you encounter troubled with FTR, you should try to use the single sweep. It is slower but may be more robust.
Segmentationcontrol wethear or not the output should be augmented with the segmentation.
SuperArcSamplingLevelcontrol the number of subdivision of each superarc. Intermediate point will be located on the barycenter of the corresponding portion of vertex.
Outputthe output of this filter is composed of:
  1. The nodes of the tree
  2. The arcs of the tree
  3. The semgentation of the initial dataset The structure of the tree (Nodes+Arcs) have a concept of nodeId, which is an id that is consistent between execution if SetWithNormalize is set to True. The downNodeId of an arc is its starting node (directed towards the leaves as the computation starts here) and the upNodeId it the ending node, in direction of the Root of the tree. The segmentation also contains some basics metrics like the size of each region (RegionSpan) or its number of vertex (RegionSize)

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

Related publication
"Task-based Augmented Reeb Graphs with Dynamic ST-Trees"
Charles Gueunet, Pierre Fortin, Julien Jomier, Julien Tierny
EGPGV19: Eurographics Symposium on Parallel Graphics and Visualization

Online examples:

Definition at line 63 of file ttkFTRGraph.h.

Member Typedef Documentation

◆ Superclass

Definition at line 66 of file ttkFTRGraph.h.

Constructor & Destructor Documentation

◆ ttkFTRGraph()

ttkFTRGraph::ttkFTRGraph ( )
protected

Definition at line 14 of file ttkFTRGraph.cpp.

Member Function Documentation

◆ addCompleteSkeletonArc()

int ttkFTRGraph::addCompleteSkeletonArc ( const ttk::ftr::Graph graph,
const ttk::ftr::idSuperArc  arcId,
vtkPoints *  points,
vtkUnstructuredGrid *  skeletonArcs,
ttk::ftr::ArcData arcData 
)

Definition at line 39 of file ttkFTRGraph.cpp.

◆ addDirectSkeletonArc()

int ttkFTRGraph::addDirectSkeletonArc ( const ttk::ftr::Graph graph,
const ttk::ftr::idSuperArc  arcId,
vtkPoints *  points,
vtkUnstructuredGrid *  skeletonArcs,
ttk::ftr::ArcData arcData 
)

Definition at line 110 of file ttkFTRGraph.cpp.

◆ addSampledSkeletonArc()

int ttkFTRGraph::addSampledSkeletonArc ( const ttk::ftr::Graph graph,
const ttk::ftr::idSuperArc  arcId,
vtkPoints *  points,
vtkUnstructuredGrid *  skeletonArcs,
ttk::ftr::ArcData arcData 
)

Definition at line 156 of file ttkFTRGraph.cpp.

◆ dispatch()

template<typename VTK_TT , typename TTK_TT >
int ttkFTRGraph::dispatch ( ttk::ftr::Graph graph)

Definition at line 259 of file ttkFTRGraph.cpp.

◆ FillInputPortInformation()

int ttkFTRGraph::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
overrideprotected

Definition at line 20 of file ttkFTRGraph.cpp.

◆ FillOutputPortInformation()

int ttkFTRGraph::FillOutputPortInformation ( int  port,
vtkInformation *  info 
)
overrideprotected

Definition at line 28 of file ttkFTRGraph.cpp.

◆ GetClassName()

virtual const char * ttkFTRGraph::GetClassName ( )
virtual

Reimplemented from ttkAlgorithm.

◆ GetForceInputOffsetScalarField()

virtual bool ttkFTRGraph::GetForceInputOffsetScalarField ( )
virtual

◆ getSegmentation()

int ttkFTRGraph::getSegmentation ( const ttk::ftr::Graph graph,
vtkDataSet *  outputSegmentation 
)

Definition at line 355 of file ttkFTRGraph.cpp.

◆ GetSingleSweep()

bool ttkFTRGraph::GetSingleSweep ( ) const
inline

Definition at line 79 of file ttkFTRGraph.h.

◆ getSkeletonArcs()

int ttkFTRGraph::getSkeletonArcs ( const ttk::ftr::Graph graph,
vtkUnstructuredGrid *  outputSkeletonArcs 
)

Definition at line 372 of file ttkFTRGraph.cpp.

◆ getSkeletonNodes()

int ttkFTRGraph::getSkeletonNodes ( const ttk::ftr::Graph graph,
vtkUnstructuredGrid *  outputSkeletonNodes 
)

Definition at line 418 of file ttkFTRGraph.cpp.

◆ GetSuperArcSamplingLevel()

int ttkFTRGraph::GetSuperArcSamplingLevel ( ) const
inline

Definition at line 113 of file ttkFTRGraph.h.

◆ GetWithNormalize()

bool ttkFTRGraph::GetWithNormalize ( ) const
inline

Definition at line 102 of file ttkFTRGraph.h.

◆ GetWithSegmentation()

bool ttkFTRGraph::GetWithSegmentation ( ) const
inline

Definition at line 90 of file ttkFTRGraph.h.

◆ identify()

void ttkFTRGraph::identify ( vtkDataSet *  ds) const
protected

Definition at line 447 of file ttkFTRGraph.cpp.

◆ IsA()

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

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

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

◆ New()

static ttkFTRGraph * ttkFTRGraph::New ( )
static

◆ RequestData()

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

Definition at line 281 of file ttkFTRGraph.cpp.

◆ SafeDownCast()

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

◆ SetForceInputOffsetScalarField()

virtual void ttkFTRGraph::SetForceInputOffsetScalarField ( bool  )
virtual

◆ SetSampling()

void ttkFTRGraph::SetSampling ( int  lvl)
inline

control the sampling level of the superarcs

Definition at line 109 of file ttkFTRGraph.h.

◆ SetSingleSweep()

void ttkFTRGraph::SetSingleSweep ( const bool  ss)
inline

control whether the computation should start from min and max (default) or use a single sweep starting only from the min (may be more robust)

Definition at line 75 of file ttkFTRGraph.h.

◆ SetWithNormalize()

void ttkFTRGraph::SetWithNormalize ( const bool  norm)
inline

if set to true, a post processing pass will be used to enforce consistent node ids between executions

Definition at line 98 of file ttkFTRGraph.h.

◆ SetWithSegmentation()

void ttkFTRGraph::SetWithSegmentation ( const bool  segm)
inline

control if the output should contains the segmentation information

Definition at line 86 of file ttkFTRGraph.h.


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