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

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

#include <ttkRipsPersistenceDiagram.h>

Inheritance diagram for ttkRipsPersistenceDiagram:
ttkAlgorithm ttk::RipsPersistenceDiagram ttk::Debug ttk::Debug ttk::BaseClass 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 SetSimplexMaximumDimension (int)
 
virtual int GetSimplexMaximumDimension ()
 
virtual void SetSimplexMaximumDiameter (double)
 
virtual double GetSimplexMaximumDiameter ()
 
virtual void SetInputIsDistanceMatrix (int)
 
virtual int GetInputIsDistanceMatrix ()
 
- 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::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)
 

Static Public Member Functions

static ttkRipsPersistenceDiagramNew ()
 
static int IsTypeOf (const char *type)
 
static ttkRipsPersistenceDiagramSafeDownCast (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

 ttkRipsPersistenceDiagram ()
 
 ~ttkRipsPersistenceDiagram () 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::RipsPersistenceDiagram
 RipsPersistenceDiagram ()
 
int execute (const std::vector< std::vector< double > > &points, std::vector< std::vector< ripser::pers_pair_t > > &ph) const
 Main entry point.
 

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_
 
- Protected Attributes inherited from ttk::RipsPersistenceDiagram
int SimplexMaximumDimension {1}
 
double SimplexMaximumDiameter {1.0}
 
int InputIsDistanceMatrix {0}
 
- 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::RipsPersistenceDiagram module.

Author
Mattéo Clémot matte.nosp@m.o.cl.nosp@m.emot@.nosp@m.univ.nosp@m.-lyon.nosp@m.1.fr
Date
January 2024.

VTK wrapping code for the ttk::RipsPersistenceDiagram package.

Parameters
InputInput table (vtkTable)
OutputPersistenceDiagram (vtkUnstructuredGrid)

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

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

See also
ttk::RipsPersistenceDiagram
ttkAlgorithm

Definition at line 34 of file ttkRipsPersistenceDiagram.h.

Member Typedef Documentation

◆ Superclass

Definition at line 45 of file ttkRipsPersistenceDiagram.h.

Constructor & Destructor Documentation

◆ ttkRipsPersistenceDiagram()

ttkRipsPersistenceDiagram::ttkRipsPersistenceDiagram ( )
protected

Definition at line 127 of file ttkRipsPersistenceDiagram.cpp.

◆ ~ttkRipsPersistenceDiagram()

ttkRipsPersistenceDiagram::~ttkRipsPersistenceDiagram ( )
overrideprotecteddefault

Member Function Documentation

◆ FillInputPortInformation()

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

Definition at line 132 of file ttkRipsPersistenceDiagram.cpp.

◆ FillOutputPortInformation()

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

Definition at line 141 of file ttkRipsPersistenceDiagram.cpp.

◆ GetClassName()

virtual const char * ttkRipsPersistenceDiagram::GetClassName ( )
virtual

Reimplemented from ttkAlgorithm.

◆ GetInputIsDistanceMatrix()

virtual int ttkRipsPersistenceDiagram::GetInputIsDistanceMatrix ( )
virtual

◆ GetSimplexMaximumDiameter()

virtual double ttkRipsPersistenceDiagram::GetSimplexMaximumDiameter ( )
virtual

◆ GetSimplexMaximumDimension()

virtual int ttkRipsPersistenceDiagram::GetSimplexMaximumDimension ( )
virtual

◆ IsA()

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

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

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

◆ New()

static ttkRipsPersistenceDiagram * ttkRipsPersistenceDiagram::New ( )
static

◆ RequestData()

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

Definition at line 150 of file ttkRipsPersistenceDiagram.cpp.

◆ SafeDownCast()

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

◆ SetInputIsDistanceMatrix()

virtual void ttkRipsPersistenceDiagram::SetInputIsDistanceMatrix ( int  )
virtual

◆ SetSimplexMaximumDiameter()

virtual void ttkRipsPersistenceDiagram::SetSimplexMaximumDiameter ( double  )
virtual

◆ SetSimplexMaximumDimension()

virtual void ttkRipsPersistenceDiagram::SetSimplexMaximumDimension ( int  )
virtual

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