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

#include <TrackingFromFields.h>

Inheritance diagram for ttk::TrackingFromFields:
ttk::Debug ttk::BaseClass ttkTrackingFromFields

Public Member Functions

 TrackingFromFields ()
 
template<typename dataType , typename triangulationType = ttk::AbstractTriangulation>
int performDiagramComputation (int fieldNumber, std::vector< ttk::DiagramType > &persistenceDiagrams, const triangulationType *triangulation)
 
int setInputDataPointer (int idx, void *data)
 
int setNumberOfInputs (int numberOfInputs)
 
void preconditionTriangulation (AbstractTriangulation *triangulation)
 
void setInputScalars (std::vector< void * > &is)
 
void setInputOffsets (std::vector< SimplexId * > &io)
 
- 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 numberOfInputs_ {0}
 
std::vector< void * > inputData_ {}
 
std::vector< SimplexId * > inputOffsets_ {}
 
- 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_
 

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

Definition at line 20 of file TrackingFromFields.h.

Constructor & Destructor Documentation

◆ TrackingFromFields()

ttk::TrackingFromFields::TrackingFromFields ( )
inline

Definition at line 23 of file TrackingFromFields.h.

Member Function Documentation

◆ performDiagramComputation()

template<typename dataType , typename triangulationType >
int ttk::TrackingFromFields::performDiagramComputation ( int  fieldNumber,
std::vector< ttk::DiagramType > &  persistenceDiagrams,
const triangulationType *  triangulation 
)

Execute the package.

Returns
Returns 0 upon success, negative values otherwise.

Definition at line 90 of file TrackingFromFields.h.

◆ preconditionTriangulation()

void ttk::TrackingFromFields::preconditionTriangulation ( AbstractTriangulation triangulation)
inline

Definition at line 61 of file TrackingFromFields.h.

◆ setInputDataPointer()

int ttk::TrackingFromFields::setInputDataPointer ( int  idx,
void *  data 
)
inline

Pass a pointer to an input array representing a scalarfield. The array is expected to be correctly allocated. idx in [0,numberOfInputs_[

Parameters
idxIndex of the input scalar field.
dataPointer to the data array.
Returns
Returns 0 upon success, negative values otherwise.
See also
setNumberOfInputs() and setVertexNumber().

Definition at line 44 of file TrackingFromFields.h.

◆ setInputOffsets()

void ttk::TrackingFromFields::setInputOffsets ( std::vector< SimplexId * > &  io)
inline
Precondition
For this function to behave correctly in the absence of the VTK wrapper, ttk::preconditionOrderArray() needs to be called to fill every buffer in the io vector prior to any computation (the VTK wrapper already includes a mechanism to automatically generate such a preconditioned buffer).
See also
examples/c++/main.cpp for an example use.

Definition at line 78 of file TrackingFromFields.h.

◆ setInputScalars()

void ttk::TrackingFromFields::setInputScalars ( std::vector< void * > &  is)
inline

Definition at line 66 of file TrackingFromFields.h.

◆ setNumberOfInputs()

int ttk::TrackingFromFields::setNumberOfInputs ( int  numberOfInputs)
inline

Set the number of input scalar fields

Parameters
numberOfInputsNumber of input scalar fields.
Returns
Returns 0 upon success, negative values otherwise

Definition at line 55 of file TrackingFromFields.h.

Member Data Documentation

◆ inputData_

std::vector<void *> ttk::TrackingFromFields::inputData_ {}
protected

Definition at line 84 of file TrackingFromFields.h.

◆ inputOffsets_

std::vector<SimplexId *> ttk::TrackingFromFields::inputOffsets_ {}
protected

Definition at line 85 of file TrackingFromFields.h.

◆ numberOfInputs_

int ttk::TrackingFromFields::numberOfInputs_ {0}
protected

Definition at line 83 of file TrackingFromFields.h.


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