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

TTK processing package for distance field computation on PL manifolds. More...

#include <DistanceField.h>

Inheritance diagram for ttk::DistanceField:
ttk::Debug ttk::BaseClass ttkDistanceField

Public Member Functions

 DistanceField ()
 
template<typename dataType >
dataType getDistance (const SimplexId a, const SimplexId b) const
 
template<typename dataType , class triangulationType = ttk::AbstractTriangulation>
int execute (const triangulationType *) const
 
void setVertexNumber (SimplexId vertexNumber)
 
void setSourceNumber (SimplexId sourceNumber)
 
int preconditionTriangulation (AbstractTriangulation *triangulation)
 
void setVertexIdentifierScalarFieldPointer (SimplexId *const data)
 
void setOutputScalarFieldPointer (void *data)
 
void setOutputIdentifiers (void *data)
 
void setOutputSegmentation (void *data)
 
- 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)
 

Protected Attributes

SimplexId vertexNumber_ {}
 
SimplexId sourceNumber_ {}
 
SimplexId * vertexIdentifierScalarFieldPointer_ {}
 
void * outputScalarFieldPointer_ {}
 
void * outputIdentifiers_ {}
 
void * outputSegmentation_ {}
 
- 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 processing package for distance field computation on PL manifolds.

Author
Guillaume Favelier guill.nosp@m.aume.nosp@m..fave.nosp@m.lier.nosp@m.@lip6.nosp@m..fr
Date
March 2016

This package takes a list of sources (a set of points with their global identifiers attached to them) and produces a distance field to the closest source.

Related publication
"A note on two problems in connexion with graphs"
Edsger W. Dijkstra
Numerische Mathematik, 1959.

See also
ttkDistanceField.cpp for a usage example.

Definition at line 32 of file DistanceField.h.

Constructor & Destructor Documentation

◆ DistanceField()

ttk::DistanceField::DistanceField ( )

Definition at line 3 of file DistanceField.cpp.

Member Function Documentation

◆ execute()

template<typename dataType , class triangulationType >
int ttk::DistanceField::execute ( const triangulationType *  triangulation_) const

Definition at line 82 of file DistanceField.h.

◆ getDistance()

template<typename dataType >
dataType ttk::DistanceField::getDistance ( const SimplexId  a,
const SimplexId  b 
) const

◆ preconditionTriangulation()

int ttk::DistanceField::preconditionTriangulation ( AbstractTriangulation *  triangulation)
inline

Definition at line 51 of file DistanceField.h.

◆ setOutputIdentifiers()

void ttk::DistanceField::setOutputIdentifiers ( void *  data)
inline

Definition at line 63 of file DistanceField.h.

◆ setOutputScalarFieldPointer()

void ttk::DistanceField::setOutputScalarFieldPointer ( void *  data)
inline

Definition at line 59 of file DistanceField.h.

◆ setOutputSegmentation()

void ttk::DistanceField::setOutputSegmentation ( void *  data)
inline

Definition at line 67 of file DistanceField.h.

◆ setSourceNumber()

void ttk::DistanceField::setSourceNumber ( SimplexId  sourceNumber)
inline

Definition at line 47 of file DistanceField.h.

◆ setVertexIdentifierScalarFieldPointer()

void ttk::DistanceField::setVertexIdentifierScalarFieldPointer ( SimplexId *const  data)
inline

Definition at line 55 of file DistanceField.h.

◆ setVertexNumber()

void ttk::DistanceField::setVertexNumber ( SimplexId  vertexNumber)
inline

Definition at line 43 of file DistanceField.h.

Member Data Documentation

◆ outputIdentifiers_

void* ttk::DistanceField::outputIdentifiers_ {}
protected

Definition at line 76 of file DistanceField.h.

◆ outputScalarFieldPointer_

void* ttk::DistanceField::outputScalarFieldPointer_ {}
protected

Definition at line 75 of file DistanceField.h.

◆ outputSegmentation_

void* ttk::DistanceField::outputSegmentation_ {}
protected

Definition at line 77 of file DistanceField.h.

◆ sourceNumber_

SimplexId ttk::DistanceField::sourceNumber_ {}
protected

Definition at line 73 of file DistanceField.h.

◆ vertexIdentifierScalarFieldPointer_

SimplexId* ttk::DistanceField::vertexIdentifierScalarFieldPointer_ {}
protected

Definition at line 74 of file DistanceField.h.

◆ vertexNumber_

SimplexId ttk::DistanceField::vertexNumber_ {}
protected

Definition at line 72 of file DistanceField.h.

The documentation for this class was generated from the following files:
Generated on Tue Jul 11 2023 08:20:59 for TTK by doxygen 1.9.6