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

TTK VTK-filter that wraps the ttk::RipsComplex processing package. More...

#include <ttkRipsComplex.h>

Inheritance diagram for ttkRipsComplex:
ttkAlgorithm ttk::RipsComplex 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)
 
void SetScalarFields (const std::string &s)
 
void ClearScalarFields ()
 
virtual void SetOutputDimension (int)
 
virtual int GetOutputDimension ()
 
virtual void SetEpsilon (double)
 
virtual double GetEpsilon ()
 
virtual void SetKeepAllDataArrays (bool)
 
virtual bool GetKeepAllDataArrays ()
 
virtual void SetSelectFieldsWithRegexp (bool)
 
virtual bool GetSelectFieldsWithRegexp ()
 
virtual void SetStdDev (double)
 
virtual double GetStdDev ()
 
virtual void SetComputeGaussianDensity (bool)
 
virtual bool GetComputeGaussianDensity ()
 
virtual void SetRegexpString (const std::string &)
 
virtual std::string GetRegexpString ()
 
virtual void SetXColumn (const std::string &)
 
virtual std::string GetXColumn ()
 
virtual void SetYColumn (const std::string &)
 
virtual std::string GetYColumn ()
 
virtual void SetZColumn (const std::string &)
 
virtual std::string GetZColumn ()
 
- 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 ttkRipsComplexNew ()
 
static int IsTypeOf (const char *type)
 
static ttkRipsComplexSafeDownCast (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

 ttkRipsComplex ()
 
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::RipsComplex
int computeDiameterStats (const SimplexId nPoints, std::array< double *const, 3 > diamStats, const std::vector< SimplexId > &connectivity, const std::vector< double > &cellDiameters) const
 Compute diameter statistics on points.
 
int computeGaussianDensity (double *const density, const std::vector< std::vector< double > > &distanceMatrix) const
 Compute Gaussian density on points.
 
 RipsComplex ()
 
int execute (std::vector< SimplexId > &connectivity, std::vector< double > &diameters, std::array< double *const, 3 > diamStats, const std::vector< std::vector< double > > &distanceMatrix, double *const density=nullptr) 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::RipsComplex
int OutputDimension {2}
 
double Epsilon {1.0}
 
double StdDev {1.0}
 
bool ComputeGaussianDensity {false}
 
- 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::RipsComplex processing package.

Author
Pierre Guillou pierr.nosp@m.e.gu.nosp@m.illou.nosp@m.@lip.nosp@m.6.fr
Date
January 2022.

VTK wrapping code for the ttk::RipsComplex package.

Parameters
InputInput table (vtkTable)
OutputTriangulation (vtkUnstructuredGrid)

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

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

See also
ttk::RipsComplex

Online examples:

Definition at line 39 of file ttkRipsComplex.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file ttkRipsComplex.h.

Constructor & Destructor Documentation

◆ ttkRipsComplex()

ttkRipsComplex::ttkRipsComplex ( )
protected

Definition at line 22 of file ttkRipsComplex.cpp.

Member Function Documentation

◆ ClearScalarFields()

void ttkRipsComplex::ClearScalarFields ( )
inline

Definition at line 51 of file ttkRipsComplex.h.

◆ FillInputPortInformation()

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

Definition at line 27 of file ttkRipsComplex.cpp.

◆ FillOutputPortInformation()

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

Definition at line 35 of file ttkRipsComplex.cpp.

◆ GetClassName()

virtual const char * ttkRipsComplex::GetClassName ( )
virtual

Reimplemented from ttkAlgorithm.

◆ GetComputeGaussianDensity()

virtual bool ttkRipsComplex::GetComputeGaussianDensity ( )
virtual

◆ GetEpsilon()

virtual double ttkRipsComplex::GetEpsilon ( )
virtual

◆ GetKeepAllDataArrays()

virtual bool ttkRipsComplex::GetKeepAllDataArrays ( )
virtual

◆ GetOutputDimension()

virtual int ttkRipsComplex::GetOutputDimension ( )
virtual

◆ GetRegexpString()

virtual std::string ttkRipsComplex::GetRegexpString ( )
virtual

◆ GetSelectFieldsWithRegexp()

virtual bool ttkRipsComplex::GetSelectFieldsWithRegexp ( )
virtual

◆ GetStdDev()

virtual double ttkRipsComplex::GetStdDev ( )
virtual

◆ GetXColumn()

virtual std::string ttkRipsComplex::GetXColumn ( )
virtual

◆ GetYColumn()

virtual std::string ttkRipsComplex::GetYColumn ( )
virtual

◆ GetZColumn()

virtual std::string ttkRipsComplex::GetZColumn ( )
virtual

◆ IsA()

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

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

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

◆ New()

static ttkRipsComplex * ttkRipsComplex::New ( )
static

◆ RequestData()

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

Definition at line 43 of file ttkRipsComplex.cpp.

◆ SafeDownCast()

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

◆ SetComputeGaussianDensity()

virtual void ttkRipsComplex::SetComputeGaussianDensity ( bool  )
virtual

◆ SetEpsilon()

virtual void ttkRipsComplex::SetEpsilon ( double  )
virtual

◆ SetKeepAllDataArrays()

virtual void ttkRipsComplex::SetKeepAllDataArrays ( bool  )
virtual

◆ SetOutputDimension()

virtual void ttkRipsComplex::SetOutputDimension ( int  )
virtual

◆ SetRegexpString()

virtual void ttkRipsComplex::SetRegexpString ( const std::string &  )
virtual

◆ SetScalarFields()

void ttkRipsComplex::SetScalarFields ( const std::string &  s)
inline

Definition at line 46 of file ttkRipsComplex.h.

◆ SetSelectFieldsWithRegexp()

virtual void ttkRipsComplex::SetSelectFieldsWithRegexp ( bool  )
virtual

◆ SetStdDev()

virtual void ttkRipsComplex::SetStdDev ( double  )
virtual

◆ SetXColumn()

virtual void ttkRipsComplex::SetXColumn ( const std::string &  )
virtual

◆ SetYColumn()

virtual void ttkRipsComplex::SetYColumn ( const std::string &  )
virtual

◆ SetZColumn()

virtual void ttkRipsComplex::SetZColumn ( const std::string &  )
virtual

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