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

TTK VTK-filter that takes an input time-varying data set (represented by a list of scalar fields) and which computes a tracking mesh. More...

#include <ttkTrackingFromFields.h>

Inheritance diagram for ttkTrackingFromFields:
ttkAlgorithm ttk::TrackingFromFields 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 SetDistanceAlgorithm (const std::string &)
 
virtual std::string GetDistanceAlgorithm ()
 
virtual void SetSampling (int)
 Temporal sampling (take every N timestep).
 
virtual int GetSampling ()
 
virtual void SetStartTimestep (int)
 First timestep.
 
virtual int GetStartTimestep ()
 
virtual void SetEndTimestep (int)
 Last timestep (-1 to use the last timestep available).
 
virtual int GetEndTimestep ()
 
virtual void SetTolerance (double)
 Discard pairs below this threshold (percentage of the function span).
 
virtual double GetTolerance ()
 
virtual void SetPX (double)
 Importance weight for the X component of the extremum.
 
virtual double GetPX ()
 
virtual void SetPY (double)
 Importance weight for the Y component of the extremum.
 
virtual double GetPY ()
 
virtual void SetPZ (double)
 Importance weight for the Z component of the extremum.
 
virtual double GetPZ ()
 
virtual void SetPE (double)
 Importance weight for extrema.
 
virtual double GetPE ()
 
virtual void SetPS (double)
 Importance weight for saddles.
 
virtual double GetPS ()
 
virtual void SetWassersteinMetric (const std::string &)
 Value of the parameter p for the Wp (p-th Wasserstein) distance computation (type "inf" for the Bottleneck distance).
 
virtual std::string GetWassersteinMetric ()
 
virtual void SetPVAlgorithm (int)
 Method for computing matchings.
 
virtual int GetPVAlgorithm ()
 
virtual void SetUseGeometricSpacing (bool)
 For the translation of the second set of critical points even the persistence diagrams are embedded in the original domain. This is useful to visualize the matching between the diagrams of two 2D scalar fields.
 
virtual bool GetUseGeometricSpacing ()
 
virtual void SetSpacing (double)
 Translation on the Z axis between the output representations of the persistence diagrams.
 
virtual double GetSpacing ()
 
virtual void SetDoPostProc (bool)
 Do post-processing.
 
virtual bool GetDoPostProc ()
 
virtual void SetPostProcThresh (double)
 Threshold for merging/splitting trajectories in connected components array.
 
virtual double GetPostProcThresh ()
 
- 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 ttkTrackingFromFieldsNew ()
 
static int IsTypeOf (const char *type)
 
static ttkTrackingFromFieldsSafeDownCast (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

 ttkTrackingFromFields ()
 
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::TrackingFromFields
 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)
 

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::TrackingFromFields
int numberOfInputs_ {0}
 
std::vector< void * > inputData_ {}
 
std::vector< SimplexId * > inputOffsets_ {}
 
- Static Protected Attributes inherited from ttk::Debug
static COMMON_EXPORTS debug::LineMode lastLineMode = ttk::debug::LineMode::NEW
 

Detailed Description

TTK VTK-filter that takes an input time-varying data set (represented by a list of scalar fields) and which computes a tracking mesh.

Author
Maxime Soler soler.nosp@m..max.nosp@m.ime@t.nosp@m.otal.nosp@m..com
Date
August 2018.
Parameters
InputInput time-dependent scalar field, either 2D or 3D, regular grid or triangulation (vtkDataSet); time steps are obtained by GetPointData()->GetArray(i) in increasing time order.
OutputOutput persistence diagram (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.

Related publication
"Lifted Wasserstein Matcher for Fast and Robust Topology Tracking"
Maxime Soler, Melanie Plainchault, Bruno Conche, Julien Tierny
Proc. of IEEE Symposium on Large Data Analysis and Visualization, 2018

Online examples:

Definition at line 44 of file ttkTrackingFromFields.h.

Member Typedef Documentation

◆ Superclass

Definition at line 51 of file ttkTrackingFromFields.h.

Constructor & Destructor Documentation

◆ ttkTrackingFromFields()

ttkTrackingFromFields::ttkTrackingFromFields ( )
protected

Definition at line 12 of file ttkTrackingFromFields.cpp.

Member Function Documentation

◆ FillInputPortInformation()

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

Definition at line 25 of file ttkTrackingFromFields.cpp.

◆ FillOutputPortInformation()

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

Definition at line 17 of file ttkTrackingFromFields.cpp.

◆ GetClassName()

virtual const char * ttkTrackingFromFields::GetClassName ( )
virtual

Reimplemented from ttkAlgorithm.

◆ GetDistanceAlgorithm()

virtual std::string ttkTrackingFromFields::GetDistanceAlgorithm ( )
virtual

◆ GetDoPostProc()

virtual bool ttkTrackingFromFields::GetDoPostProc ( )
virtual

◆ GetEndTimestep()

virtual int ttkTrackingFromFields::GetEndTimestep ( )
virtual

◆ GetPE()

virtual double ttkTrackingFromFields::GetPE ( )
virtual

◆ GetPostProcThresh()

virtual double ttkTrackingFromFields::GetPostProcThresh ( )
virtual

◆ GetPS()

virtual double ttkTrackingFromFields::GetPS ( )
virtual

◆ GetPVAlgorithm()

virtual int ttkTrackingFromFields::GetPVAlgorithm ( )
virtual

◆ GetPX()

virtual double ttkTrackingFromFields::GetPX ( )
virtual

◆ GetPY()

virtual double ttkTrackingFromFields::GetPY ( )
virtual

◆ GetPZ()

virtual double ttkTrackingFromFields::GetPZ ( )
virtual

◆ GetSampling()

virtual int ttkTrackingFromFields::GetSampling ( )
virtual

◆ GetSpacing()

virtual double ttkTrackingFromFields::GetSpacing ( )
virtual

◆ GetStartTimestep()

virtual int ttkTrackingFromFields::GetStartTimestep ( )
virtual

◆ GetTolerance()

virtual double ttkTrackingFromFields::GetTolerance ( )
virtual

◆ GetUseGeometricSpacing()

virtual bool ttkTrackingFromFields::GetUseGeometricSpacing ( )
virtual

◆ GetWassersteinMetric()

virtual std::string ttkTrackingFromFields::GetWassersteinMetric ( )
virtual

◆ IsA()

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

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

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

◆ New()

static ttkTrackingFromFields * ttkTrackingFromFields::New ( )
static

◆ RequestData()

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

Definition at line 110 of file ttkTrackingFromFields.cpp.

◆ SafeDownCast()

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

◆ SetDistanceAlgorithm()

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

◆ SetDoPostProc()

virtual void ttkTrackingFromFields::SetDoPostProc ( bool  )
virtual

Do post-processing.

◆ SetEndTimestep()

virtual void ttkTrackingFromFields::SetEndTimestep ( int  )
virtual

Last timestep (-1 to use the last timestep available).

◆ SetPE()

virtual void ttkTrackingFromFields::SetPE ( double  )
virtual

Importance weight for extrema.

◆ SetPostProcThresh()

virtual void ttkTrackingFromFields::SetPostProcThresh ( double  )
virtual

Threshold for merging/splitting trajectories in connected components array.

◆ SetPS()

virtual void ttkTrackingFromFields::SetPS ( double  )
virtual

Importance weight for saddles.

◆ SetPVAlgorithm()

virtual void ttkTrackingFromFields::SetPVAlgorithm ( int  )
virtual

Method for computing matchings.

0: sparse Munkres (Wasserstein), Gabow-Tarjan (Bottleneck)

◆ SetPX()

virtual void ttkTrackingFromFields::SetPX ( double  )
virtual

Importance weight for the X component of the extremum.

◆ SetPY()

virtual void ttkTrackingFromFields::SetPY ( double  )
virtual

Importance weight for the Y component of the extremum.

◆ SetPZ()

virtual void ttkTrackingFromFields::SetPZ ( double  )
virtual

Importance weight for the Z component of the extremum.

◆ SetSampling()

virtual void ttkTrackingFromFields::SetSampling ( int  )
virtual

Temporal sampling (take every N timestep).

◆ SetSpacing()

virtual void ttkTrackingFromFields::SetSpacing ( double  )
virtual

Translation on the Z axis between the output representations of the persistence diagrams.

◆ SetStartTimestep()

virtual void ttkTrackingFromFields::SetStartTimestep ( int  )
virtual

First timestep.

◆ SetTolerance()

virtual void ttkTrackingFromFields::SetTolerance ( double  )
virtual

Discard pairs below this threshold (percentage of the function span).

◆ SetUseGeometricSpacing()

virtual void ttkTrackingFromFields::SetUseGeometricSpacing ( bool  )
virtual

For the translation of the second set of critical points even the persistence diagrams are embedded in the original domain. This is useful to visualize the matching between the diagrams of two 2D scalar fields.

◆ SetWassersteinMetric()

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

Value of the parameter p for the Wp (p-th Wasserstein) distance computation (type "inf" for the Bottleneck distance).


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