TTK
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
ttkJacobiSet Class Reference

TTK VTK-filter that computes the Jacobi set of a bivariate volumetric data-set. More...

#include <ttkJacobiSet.h>

Inheritance diagram for ttkJacobiSet:
ttkAlgorithm ttk::JacobiSet ttk::Debug ttk::Debug ttk::BaseClass ttk::BaseClass

Public Member Functions

 vtkTypeMacro (ttkJacobiSet, ttkAlgorithm)
 
 vtkGetMacro (ForceInputOffsetScalarField, bool)
 
 vtkSetMacro (ForceInputOffsetScalarField, bool)
 
 vtkSetMacro (EdgeIds, bool)
 
 vtkGetMacro (EdgeIds, bool)
 
 vtkSetMacro (VertexScalars, bool)
 
 vtkGetMacro (VertexScalars, bool)
 
- Public Member Functions inherited from ttkAlgorithm
 vtkTypeMacro (ttkAlgorithm, vtkAlgorithm)
 
void UpdateThreadNumber ()
 
void SetThreadNumber (int threadNumber)
 
void SetUseAllCores (bool useAllCores)
 
void SetDebugLevel (int debugLevel)
 
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, const int orderArrayIdx=0, const bool enforceOrderArrayIdx=false)
 
ttk::SimplexIdGetIdentifierArrayPtr (const bool &enforceArrayIndex, const int &arrayIndex, const std::string &arrayName, vtkDataSet *const inputData, std::vector< ttk::SimplexId > &spareStorage, const int inputPort=0)
 
ttk::TriangulationGetTriangulation (vtkDataSet *object)
 
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 *)
 
- Public Member Functions inherited from ttk::Debug
 Debug ()
 
virtual ~Debug ()
 
virtual int setDebugLevel (const int &debugLevel)
 
virtual int setWrapper (const Wrapper *wrapper)
 
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 ttkJacobiSetNew ()
 
- Static Public Member Functions inherited from ttkAlgorithm
static ttkAlgorithmNew ()
 
static std::string GetOrderArrayName (vtkDataArray *const array)
 
static vtkInformationIntegerKey * SAME_DATA_TYPE_AS_INPUT_PORT ()
 

Protected Member Functions

 ttkJacobiSet ()
 
int FillInputPortInformation (int port, vtkInformation *info) override
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 
template<class dataTypeU , class dataTypeV >
int dispatch (const dataTypeU *const uField, const dataTypeV *const vField, ttk::Triangulation *const triangulation)
 
- Protected Member Functions inherited from ttkAlgorithm
 ttkAlgorithm ()
 
virtual ~ttkAlgorithm ()
 
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))
 
virtual int FillInputPortInformation (int ttkNotUsed(port), vtkInformation *ttkNotUsed(info)) override
 
virtual 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::JacobiSet
template<class dataTypeU , class dataTypeV >
int executeLegacy (std::vector< std::pair< SimplexId, char >> &jacobiSet, const dataTypeU *const uField, const dataTypeV *const vField)
 
 JacobiSet ()
 
template<class dataTypeU , class dataTypeV , typename triangulationType >
int execute (std::vector< std::pair< SimplexId, char >> &jacobiSet, const dataTypeU *const uField, const dataTypeV *const vField, const triangulationType &triangulation, std::vector< char > *isPareto=NULL)
 
template<class dataTypeU , class dataTypeV , typename triangulationType >
char getCriticalType (const SimplexId &edgeId, const dataTypeU *const uField, const dataTypeV *const vField, const triangulationType &triangulation)
 
template<class dataTypeU , class dataTypeV >
int perturbate (const dataTypeU *const uField, const dataTypeV *const vField, const dataTypeU uEpsilon=Geometry::powIntTen(-DBL_DIG), const dataTypeV vEpsilon=Geometry::powIntTen(-DBL_DIG)) const
 
void setEdgeFans (const std::vector< std::vector< SimplexId >> *edgeFans)
 
void setEdgeFanLinkEdgeList (const std::vector< std::vector< std::pair< SimplexId, SimplexId >>> *edgeFanLinkEdgeLists)
 
void setEdgeList (const std::vector< std::pair< SimplexId, SimplexId >> *edgeList)
 
void setSosOffsets (std::vector< SimplexId > *sosOffsets)
 
void setSosOffsetsU (const SimplexId *const sosOffsets)
 
void setSosOffsetsV (const SimplexId *const sosOffsets)
 
void setTetList (const SimplexId *tetList)
 
void setVertexNumber (const SimplexId &vertexNumber)
 
void preconditionTriangulation (AbstractTriangulation *const triangulation)
 

Additional Inherited Members

- Protected Attributes inherited from ttk::Debug
int debugLevel_
 
std::string debugMsgPrefix_
 
- Protected Attributes inherited from ttk::BaseClass
bool lastObject_
 
int threadNumber_
 
Wrapperwrapper_
 
- Protected Attributes inherited from ttk::JacobiSet
SimplexId vertexNumber_ {}
 
const SimplexIdtetList_ {}
 
const std::vector< std::pair< SimplexId, SimplexId > > * edgeList_ {}
 
const std::vector< std::vector< std::pair< SimplexId, SimplexId > > > * edgeFanLinkEdgeLists_ {}
 
const std::vector< std::vector< SimplexId > > * edgeFans_ {}
 
const SimplexIdsosOffsetsU_ {}
 
const SimplexIdsosOffsetsV_ {}
 
- Static Protected Attributes inherited from ttk::Debug
static COMMON_EXPORTS debug::LineMode lastLineMode = ttk::debug::LineMode::NEW
 

Detailed Description

TTK VTK-filter that computes the Jacobi set of a bivariate volumetric data-set.

Author
Julien Tierny julie.nosp@m.n.ti.nosp@m.erny@.nosp@m.lip6.nosp@m..fr
Date
May 2015.

Given a bivariate scalar field defined on a PL 3-manifold, this filter produces the list of Jacobi edges (each entry is a pair given by the edge identifier and the Jacobi edge type).

The input bivariate data must be provided as two independent scalar fields attached as point data to the input geometry.

Parameters
InputInput bivariate volumetric data (vtkDataSet)
OutputOutput Jacobi set (vtkDataSet)

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

The input data arrays needs to be specified via the standard VTK call vtkAlgorithm::SetInputArrayToProcess() with the following parameters:

Parameters
idx0 for the U Component, 1 for the V Component
port0 (FIXED: first port)
connection0 (FIXED: first connection)
fieldAssociation0 (FIXED: point data)
arrayName(DYNAMIC: string identifier of the input array)

The optional offset arrays can be specified via the standard VTK call vtkAlgorithm::SetInputArrayToProcess() with the following parameters:

Parameters
idx2 for the U Offset Field, 3 for the V Offset Field
port0 (FIXED: first port)
connection0 (FIXED: first connection)
fieldAssociation0 (FIXED: point data)
arrayName(DYNAMIC: string identifier of the offset array)
Note
: To use this optional array, ForceInputOffsetScalarField needs to be enabled with the setter ‘setForceInputOffsetScalarField()’.

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

Related publication
"Jacobi sets of multiple Morse functions"
Herbert Edelsbrunner, John Harer
Foundations of Computational Mathematics. Cambridge University Press, 2002.

See also
ttk::JacobiSet
vtkReebSpace

Definition at line 60 of file ttkJacobiSet.h.

Constructor & Destructor Documentation

◆ ttkJacobiSet()

ttkJacobiSet::ttkJacobiSet ( )
protected

Definition at line 20 of file ttkJacobiSet.cpp.

Member Function Documentation

◆ dispatch()

template<class dataTypeU , class dataTypeV >
int ttkJacobiSet::dispatch ( const dataTypeU *const  uField,
const dataTypeV *const  vField,
ttk::Triangulation *const  triangulation 
)
protected

Definition at line 43 of file ttkJacobiSet.cpp.

◆ FillInputPortInformation()

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

Definition at line 26 of file ttkJacobiSet.cpp.

◆ FillOutputPortInformation()

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

Definition at line 34 of file ttkJacobiSet.cpp.

◆ New()

static ttkJacobiSet* ttkJacobiSet::New ( )
static

◆ RequestData()

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

Definition at line 54 of file ttkJacobiSet.cpp.

◆ vtkGetMacro() [1/3]

ttkJacobiSet::vtkGetMacro ( EdgeIds  ,
bool   
)

◆ vtkGetMacro() [2/3]

ttkJacobiSet::vtkGetMacro ( ForceInputOffsetScalarField  ,
bool   
)

◆ vtkGetMacro() [3/3]

ttkJacobiSet::vtkGetMacro ( VertexScalars  ,
bool   
)

◆ vtkSetMacro() [1/3]

ttkJacobiSet::vtkSetMacro ( EdgeIds  ,
bool   
)

◆ vtkSetMacro() [2/3]

ttkJacobiSet::vtkSetMacro ( ForceInputOffsetScalarField  ,
bool   
)

◆ vtkSetMacro() [3/3]

ttkJacobiSet::vtkSetMacro ( VertexScalars  ,
bool   
)

◆ vtkTypeMacro()

ttkJacobiSet::vtkTypeMacro ( ttkJacobiSet  ,
ttkAlgorithm   
)

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