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

TTK VTK-filter which projects a data-set to 2D given two point-data scalar fields to be used as 2D coordinates. More...

#include <ttkProjectionFromField.h>

Inheritance diagram for ttkProjectionFromField:
ttkAlgorithm ttk::Debug ttk::BaseClass

Public Member Functions

 vtkTypeMacro (ttkProjectionFromField, ttkAlgorithm)
 
 vtkSetMacro (UseTextureCoordinates, bool)
 
 vtkGetMacro (UseTextureCoordinates, bool)
 
 vtkSetMacro (Use3DCoordinatesArray, bool)
 
 vtkGetMacro (Use3DCoordinatesArray, bool)
 
 vtkSetMacro (ProjectPersistenceDiagram, bool)
 
 vtkGetMacro (ProjectPersistenceDiagram, 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 ttkProjectionFromFieldNew ()
 
- 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

 ttkProjectionFromField ()
 
int FillInputPortInformation (int port, vtkInformation *info) override
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 
int projectPersistenceDiagram (vtkUnstructuredGrid *const inputDiagram, vtkUnstructuredGrid *const outputDiagram)
 Switch a given Persistence Diagram representation. More...
 
int projectDiagramInsideDomain (vtkUnstructuredGrid *const inputDiagram, vtkUnstructuredGrid *const outputDiagram)
 Generate the spatial embedding of a given Persistence Diagram. More...
 
template<typename VTK_TT >
int projectDiagramIn2D (vtkUnstructuredGrid *const inputDiagram, vtkUnstructuredGrid *const outputDiagram, const VTK_TT *const births, const VTK_TT *const deaths)
 Generate the 2D embedding of a given Persistence Diagram. More...
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 
- 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)
 

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_
 
- Static Protected Attributes inherited from ttk::Debug
static COMMON_EXPORTS debug::LineMode lastLineMode = ttk::debug::LineMode::NEW
 

Detailed Description

TTK VTK-filter which projects a data-set to 2D given two point-data scalar fields to be used as 2D coordinates.

Author
Julien Tierny julie.nosp@m.n.ti.nosp@m.erny@.nosp@m.lip6.nosp@m..fr
Date
November 2014.
Parameters
InputInput data-set, with at least two point data scalar fields or texture coordinates (vtkPointSet)
OutputOutput projected data-set (vtkPointSet)

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

The input data array for the first component (u) needs to be specified via the standard VTK call vtkAlgorithm::SetInputArrayToProcess() with the following parameters:

Parameters
idx0 (FIXED: the first array the algorithm requires)
port0 (FIXED: first port)
connection0 (FIXED: first connection)
fieldAssociation0 (FIXED: point data)
arrayName(DYNAMIC: string identifier of the input array)

The input data array for the second component (v) needs to be specified via the standard VTK call vtkAlgorithm::SetInputArrayToProcess() with the following parameters:

Parameters
idx1 (FIXED: the second array the algorithm requires)
port0 (FIXED: first port)
connection0 (FIXED: first connection)
fieldAssociation0 (FIXED: point data)
arrayName(DYNAMIC: string identifier of the input array)

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

See also
vtkTextureMapFromField

Definition at line 49 of file ttkProjectionFromField.h.

Constructor & Destructor Documentation

◆ ttkProjectionFromField()

ttkProjectionFromField::ttkProjectionFromField ( )
protected

Definition at line 20 of file ttkProjectionFromField.cpp.

Member Function Documentation

◆ FillInputPortInformation()

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

Definition at line 27 of file ttkProjectionFromField.cpp.

◆ FillOutputPortInformation()

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

Definition at line 36 of file ttkProjectionFromField.cpp.

◆ New()

static ttkProjectionFromField* ttkProjectionFromField::New ( )
static

◆ projectDiagramIn2D()

template<typename VTK_TT >
int ttkProjectionFromField::projectDiagramIn2D ( vtkUnstructuredGrid *const  inputDiagram,
vtkUnstructuredGrid *const  outputDiagram,
const VTK_TT *const  births,
const VTK_TT *const  deaths 
)
protected

Generate the 2D embedding of a given Persistence Diagram.

Definition at line 109 of file ttkProjectionFromField.cpp.

◆ projectDiagramInsideDomain()

int ttkProjectionFromField::projectDiagramInsideDomain ( vtkUnstructuredGrid *const  inputDiagram,
vtkUnstructuredGrid *const  outputDiagram 
)
protected

Generate the spatial embedding of a given Persistence Diagram.

Definition at line 45 of file ttkProjectionFromField.cpp.

◆ projectPersistenceDiagram()

int ttkProjectionFromField::projectPersistenceDiagram ( vtkUnstructuredGrid *const  inputDiagram,
vtkUnstructuredGrid *const  outputDiagram 
)
protected

Switch a given Persistence Diagram representation.

Definition at line 171 of file ttkProjectionFromField.cpp.

◆ RequestData()

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

Definition at line 216 of file ttkProjectionFromField.cpp.

◆ vtkGetMacro() [1/3]

ttkProjectionFromField::vtkGetMacro ( ProjectPersistenceDiagram  ,
bool   
)

◆ vtkGetMacro() [2/3]

ttkProjectionFromField::vtkGetMacro ( Use3DCoordinatesArray  ,
bool   
)

◆ vtkGetMacro() [3/3]

ttkProjectionFromField::vtkGetMacro ( UseTextureCoordinates  ,
bool   
)

◆ vtkSetMacro() [1/3]

ttkProjectionFromField::vtkSetMacro ( ProjectPersistenceDiagram  ,
bool   
)

◆ vtkSetMacro() [2/3]

ttkProjectionFromField::vtkSetMacro ( Use3DCoordinatesArray  ,
bool   
)

◆ vtkSetMacro() [3/3]

ttkProjectionFromField::vtkSetMacro ( UseTextureCoordinates  ,
bool   
)

◆ vtkTypeMacro()

ttkProjectionFromField::vtkTypeMacro ( ttkProjectionFromField  ,
ttkAlgorithm   
)

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