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

TTK VTK-filter that wraps the bottleneckDistance processing package. More...

#include <ttkBottleneckDistance.h>

Inheritance diagram for ttkBottleneckDistance:
ttkAlgorithm ttk::BottleneckDistance 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 SetTolerance (double)
 
virtual double GetTolerance ()
 
virtual void SetPX (double)
 
virtual double GetPX ()
 
virtual void SetPY (double)
 
virtual double GetPY ()
 
virtual void SetPZ (double)
 
virtual double GetPZ ()
 
virtual void SetPE (double)
 
virtual double GetPE ()
 
virtual void SetPS (double)
 
virtual double GetPS ()
 
virtual void SetUseOutputMatching (bool)
 
virtual bool GetUseOutputMatching ()
 
virtual void SetWassersteinMetric (const std::string &)
 
virtual std::string GetWassersteinMetric ()
 
virtual void SetDistanceAlgorithm (const std::string &)
 
virtual std::string GetDistanceAlgorithm ()
 
virtual void SetPVAlgorithm (int)
 
virtual int GetPVAlgorithm ()
 
virtual void SetUseGeometricSpacing (bool)
 
virtual bool GetUseGeometricSpacing ()
 
virtual void SetSpacing (double)
 
virtual double GetSpacing ()
 
double Getresult ()
 
int FillInputPortInformation (int port, vtkInformation *info) override
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 
int RequestData (vtkInformation *, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 
- 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 ttkBottleneckDistanceNew ()
 
static int IsTypeOf (const char *type)
 
static ttkBottleneckDistanceSafeDownCast (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

 ttkBottleneckDistance ()
 
- 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::BottleneckDistance
 BottleneckDistance ()
 
int execute (const ttk::DiagramType &diag0, const ttk::DiagramType &diag1, std::vector< MatchingType > &matchings)
 
void setPersistencePercentThreshold (const double t)
 
void setPX (const double px)
 
void setPY (const double py)
 
void setPZ (const double pz)
 
void setPE (const double pe)
 
void setPS (const double ps)
 
void setAlgorithm (const std::string &algorithm)
 
void setPVAlgorithm (const int algorithm)
 
void setWasserstein (const std::string &wasserstein)
 
double getDistance ()
 

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::BottleneckDistance
double distance_ {-1.0}
 
std::array< double, 3 > costs_ {}
 
std::string WassersteinMetric {"2"}
 
std::string DistanceAlgorithm {}
 
int PVAlgorithm {-1}
 
double Tolerance {1.0}
 
double PX {0.0}
 
double PY {0.0}
 
double PZ {0.0}
 
double PE {1.0}
 
double PS {1.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 bottleneckDistance processing package.

Author
Maxime Soler soler.nosp@m..max.nosp@m.ime@t.nosp@m.otal.nosp@m..com
Date
The Date Here.

VTK wrapping code for the ttk::BottleneckDistance package.

Parameters
InputInput scalar field (vtkDataSet)
OutputOutput scalar field (vtkDataSet)

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

See the corresponding ParaView state file example for a usage example within a VTK pipeline.

See also
ttk::BottleneckDistance

Definition at line 29 of file ttkBottleneckDistance.h.

Member Typedef Documentation

◆ Superclass

Definition at line 36 of file ttkBottleneckDistance.h.

Constructor & Destructor Documentation

◆ ttkBottleneckDistance()

ttkBottleneckDistance::ttkBottleneckDistance ( )
protected

Definition at line 15 of file ttkBottleneckDistance.cpp.

Member Function Documentation

◆ FillInputPortInformation()

int ttkBottleneckDistance::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
override

Definition at line 20 of file ttkBottleneckDistance.cpp.

◆ FillOutputPortInformation()

int ttkBottleneckDistance::FillOutputPortInformation ( int  port,
vtkInformation *  info 
)
override

Definition at line 29 of file ttkBottleneckDistance.cpp.

◆ GetClassName()

virtual const char * ttkBottleneckDistance::GetClassName ( )
virtual

Reimplemented from ttkAlgorithm.

◆ GetDistanceAlgorithm()

virtual std::string ttkBottleneckDistance::GetDistanceAlgorithm ( )
virtual

◆ GetPE()

virtual double ttkBottleneckDistance::GetPE ( )
virtual

◆ GetPS()

virtual double ttkBottleneckDistance::GetPS ( )
virtual

◆ GetPVAlgorithm()

virtual int ttkBottleneckDistance::GetPVAlgorithm ( )
virtual

◆ GetPX()

virtual double ttkBottleneckDistance::GetPX ( )
virtual

◆ GetPY()

virtual double ttkBottleneckDistance::GetPY ( )
virtual

◆ GetPZ()

virtual double ttkBottleneckDistance::GetPZ ( )
virtual

◆ Getresult()

double ttkBottleneckDistance::Getresult ( )
inline

Definition at line 74 of file ttkBottleneckDistance.h.

◆ GetSpacing()

virtual double ttkBottleneckDistance::GetSpacing ( )
virtual

◆ GetTolerance()

virtual double ttkBottleneckDistance::GetTolerance ( )
virtual

◆ GetUseGeometricSpacing()

virtual bool ttkBottleneckDistance::GetUseGeometricSpacing ( )
virtual

◆ GetUseOutputMatching()

virtual bool ttkBottleneckDistance::GetUseOutputMatching ( )
virtual

◆ GetWassersteinMetric()

virtual std::string ttkBottleneckDistance::GetWassersteinMetric ( )
virtual

◆ IsA()

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

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

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

◆ New()

static ttkBottleneckDistance * ttkBottleneckDistance::New ( )
static

◆ RequestData()

int ttkBottleneckDistance::RequestData ( vtkInformation *  ,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
override

Definition at line 135 of file ttkBottleneckDistance.cpp.

◆ SafeDownCast()

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

◆ SetDistanceAlgorithm()

virtual void ttkBottleneckDistance::SetDistanceAlgorithm ( const std::string &  )
virtual

◆ SetPE()

virtual void ttkBottleneckDistance::SetPE ( double  )
virtual

◆ SetPS()

virtual void ttkBottleneckDistance::SetPS ( double  )
virtual

◆ SetPVAlgorithm()

virtual void ttkBottleneckDistance::SetPVAlgorithm ( int  )
virtual

◆ SetPX()

virtual void ttkBottleneckDistance::SetPX ( double  )
virtual

◆ SetPY()

virtual void ttkBottleneckDistance::SetPY ( double  )
virtual

◆ SetPZ()

virtual void ttkBottleneckDistance::SetPZ ( double  )
virtual

◆ SetSpacing()

virtual void ttkBottleneckDistance::SetSpacing ( double  )
virtual

◆ SetTolerance()

virtual void ttkBottleneckDistance::SetTolerance ( double  )
virtual

◆ SetUseGeometricSpacing()

virtual void ttkBottleneckDistance::SetUseGeometricSpacing ( bool  )
virtual

◆ SetUseOutputMatching()

virtual void ttkBottleneckDistance::SetUseOutputMatching ( bool  )
virtual

◆ SetWassersteinMetric()

virtual void ttkBottleneckDistance::SetWassersteinMetric ( const std::string &  )
virtual

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