TTK
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
ttk::RipsPersistenceDiagram Class Reference
base

TTK base class that computes the persistence diagram of a Rips complex. More...

#include <RipsPersistenceDiagram.h>

Inheritance diagram for ttk::RipsPersistenceDiagram:
ttk::Debug ttk::BaseClass ttkRipsPersistenceDiagram

Public Member Functions

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

Protected Attributes

int SimplexMaximumDimension {1}
 
double SimplexMaximumDiameter {1.0}
 
int InputIsDistanceMatrix {0}
 
- 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_
 

Additional Inherited Members

- 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)
 
- Static Protected Attributes inherited from ttk::Debug
static COMMON_EXPORTS debug::LineMode lastLineMode = ttk::debug::LineMode::NEW
 

Detailed Description

TTK base class that computes the persistence diagram of a Rips complex.

The RipsPersistenceDiagram class provides a method to call the code Ripser in order to compute the persistence diagram of the Rips complex of the input.

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.

This module defines the RipsPersistenceDiagram class that takes a point cloud or a distance matrix and computes the persistence diagram of its Rips complex.

See also
ttk::Triangulation
ttkRipsPersistenceDiagram.cpp for a usage example.

Definition at line 30 of file RipsPersistenceDiagram.h.

Constructor & Destructor Documentation

◆ RipsPersistenceDiagram()

ttk::RipsPersistenceDiagram::RipsPersistenceDiagram ( )

Definition at line 3 of file RipsPersistenceDiagram.cpp.

Member Function Documentation

◆ execute()

int ttk::RipsPersistenceDiagram::execute ( const std::vector< std::vector< double > > &  points,
std::vector< std::vector< ripser::pers_pair_t > > &  ph 
) const

Main entry point.

Parameters
[in]pointsInput point cloud in any dimension or input distance matrix
[out]phComputed Rips persistence diagram

Definition at line 8 of file RipsPersistenceDiagram.cpp.

Member Data Documentation

◆ InputIsDistanceMatrix

int ttk::RipsPersistenceDiagram::InputIsDistanceMatrix {0}
protected

is input a distance matrix

Definition at line 51 of file RipsPersistenceDiagram.h.

◆ SimplexMaximumDiameter

double ttk::RipsPersistenceDiagram::SimplexMaximumDiameter {1.0}
protected

Rips threshold

Definition at line 49 of file RipsPersistenceDiagram.h.

◆ SimplexMaximumDimension

int ttk::RipsPersistenceDiagram::SimplexMaximumDimension {1}
protected

Max dimension of computed persistence diagram

Definition at line 47 of file RipsPersistenceDiagram.h.

The documentation for this class was generated from the following files:
Generated on Thu Sep 26 2024 06:50:21 for TTK by doxygen 1.9.8