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

TTK VTK-filter which produces a valid range polygon for fiber surface extraction. More...

#include <ttkRangePolygon.h>

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

Public Member Functions

 vtkTypeMacro (ttkRangePolygon, ttkAlgorithm)
 
 vtkGetMacro (ClosedLoop, bool)
 
 vtkSetMacro (ClosedLoop, bool)
 
 vtkGetMacro (NumberOfIterations, int)
 
 vtkSetMacro (NumberOfIterations, int)
 
- 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 ttkRangePolygonNew ()
 
- 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

 ttkRangePolygon ()
 
 ~ttkRangePolygon () override
 
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 ()
 
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 produces a valid range polygon for fiber surface extraction.

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

Given an input 2D selection, this filter produces a polygon to be used as an input to vtkFiberSurface. Typically, users generate a 2D selection from the continuous scatterplot and this filter translates this selection into a valid range polygon.

The user can either select:

  1. Cells on the continuous scatterplot ("Select Cells with Polygon" in ParaView)
    Warning
    If used from ParaView, users may need to zoom in sufficiently so that the "Extract Selection" indeed captures all of the user brushed cells.
    In this case, the generated polygon may count A LOT of edges, which will seriously increase run-times. The next alternative is the default recommendation.
  2. Points on the continuous scatterplot ("Interactive Select Points on" in ParaView)
    Warning
    This feature will only work properly with the TTK-branded ParaView (ParaView sources need to be patched with TTK fixes, see the documentation)
Parameters
InputInput 2D selection, typically "Extract Selection" in ParaView (vtkUnstructuredGrid)
OutputRange polygon to be used with vtkFiberSurface (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
"Fast and Exact Fiber Surface Extraction for Tetrahedral Meshes"
Pavol Klacansky, Julien Tierny, Hamish Carr, Zhao Geng
IEEE Transactions on Visualization and Computer Graphics, 2016.

See also
vtkContinuousScatterplot
vtkFiberSurface
ttk::FiberSurface
vtkReebSpace

Definition at line 63 of file ttkRangePolygon.h.

Constructor & Destructor Documentation

◆ ttkRangePolygon()

ttkRangePolygon::ttkRangePolygon ( )
protected

Definition at line 19 of file ttkRangePolygon.cpp.

◆ ~ttkRangePolygon()

ttkRangePolygon::~ttkRangePolygon ( )
overrideprotected

Definition at line 30 of file ttkRangePolygon.cpp.

Member Function Documentation

◆ FillInputPortInformation()

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

Definition at line 33 of file ttkRangePolygon.cpp.

◆ FillOutputPortInformation()

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

Definition at line 42 of file ttkRangePolygon.cpp.

◆ New()

static ttkRangePolygon* ttkRangePolygon::New ( )
static

◆ RequestData()

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

Definition at line 51 of file ttkRangePolygon.cpp.

◆ vtkGetMacro() [1/2]

ttkRangePolygon::vtkGetMacro ( ClosedLoop  ,
bool   
)

◆ vtkGetMacro() [2/2]

ttkRangePolygon::vtkGetMacro ( NumberOfIterations  ,
int   
)

◆ vtkSetMacro() [1/2]

ttkRangePolygon::vtkSetMacro ( ClosedLoop  ,
bool   
)

◆ vtkSetMacro() [2/2]

ttkRangePolygon::vtkSetMacro ( NumberOfIterations  ,
int   
)

◆ vtkTypeMacro()

ttkRangePolygon::vtkTypeMacro ( ttkRangePolygon  ,
ttkAlgorithm   
)

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