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

TTK VTK-filter for smoothing meshes on surfaces. More...

#include <ttkSurfaceGeometrySmoother.h>

Inheritance diagram for ttkSurfaceGeometrySmoother:
ttkAlgorithm ttk::SurfaceGeometrySmoother 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 SetNumberOfIterations (int)
 
virtual int GetNumberOfIterations ()
 
virtual void SetUseMaskScalarField (bool)
 
virtual bool GetUseMaskScalarField ()
 
virtual void SetForceInputMaskScalarField (bool)
 
virtual bool GetForceInputMaskScalarField ()
 
virtual void SetForceIdentifiersField (bool)
 
virtual bool GetForceIdentifiersField ()
 
- 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 ttkSurfaceGeometrySmootherNew ()
 
static int IsTypeOf (const char *type)
 
static ttkSurfaceGeometrySmootherSafeDownCast (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

 ttkSurfaceGeometrySmoother ()
 
 ~ttkSurfaceGeometrySmoother () override=default
 
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::SurfaceGeometrySmoother
template<typename triangulationType0 , typename triangulationType1 >
int relaxProject (std::vector< Point > &outputPoints, std::vector< Point > &tmpStorage, std::vector< SimplexId > &nearestVertexId, std::vector< bool > &trianglesTested, std::vector< SimplexId > &visitedTriangles, std::vector< float > &dists, const char *const mask, const triangulationType0 &triangulationToSmooth, const triangulationType1 &triangulationSurface) const
 
template<typename triangulationType >
Point relax (const SimplexId a, std::vector< ttk::SurfaceGeometrySmoother::Point > &outputPoints, const triangulationType &triangulationToSmooth) const
 Computes the barycenter of a given point's neighbors.
 
 SurfaceGeometrySmoother ()
 
 ~SurfaceGeometrySmoother () override=default
 
void preconditionTriangulationToSmooth (AbstractTriangulation *const triangulation)
 
void preconditionTriangulationSurface (AbstractTriangulation *const triangulation)
 
template<typename triangulationType0 , typename triangulationType1 >
int execute (float *const outputCoords, const float *const inputCoords, const char *const mask, const SimplexId *const vertsId, const int nIter, const triangulationType0 &triangulationToSmooth, const triangulationType1 &triangulationSurface) const
 

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

Detailed Description

TTK VTK-filter for smoothing meshes on surfaces.

Author
Pierre Guillou pierr.nosp@m.e.gu.nosp@m.illou.nosp@m.@lip.nosp@m.6.fr
Date
March 2022.

ttk::GeometrySmoother with a twist! This class smoothes and projects a 1D or a 2D mesh onto a 2D closed triangulated surface.

Parameters
InputvtkDataSet
OutputvtkDataSet

The input data array 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 optional mask array can 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 mask array)
Note
: To use this optional array, ForceInputMaskScalarField needs to be enabled with the setter ‘setForceInputMaskScalarField()’.

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

See also
vtkGeometrySmoother
ttk::SurfaceGeometrySmoother

Online examples:

Definition at line 60 of file ttkSurfaceGeometrySmoother.h.

Member Typedef Documentation

◆ Superclass

Definition at line 67 of file ttkSurfaceGeometrySmoother.h.

Constructor & Destructor Documentation

◆ ttkSurfaceGeometrySmoother()

ttkSurfaceGeometrySmoother::ttkSurfaceGeometrySmoother ( )
protected

Definition at line 13 of file ttkSurfaceGeometrySmoother.cpp.

◆ ~ttkSurfaceGeometrySmoother()

ttkSurfaceGeometrySmoother::~ttkSurfaceGeometrySmoother ( )
overrideprotecteddefault

Member Function Documentation

◆ FillInputPortInformation()

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

Definition at line 18 of file ttkSurfaceGeometrySmoother.cpp.

◆ FillOutputPortInformation()

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

Definition at line 30 of file ttkSurfaceGeometrySmoother.cpp.

◆ GetClassName()

virtual const char * ttkSurfaceGeometrySmoother::GetClassName ( )
virtual

Reimplemented from ttkAlgorithm.

◆ GetForceIdentifiersField()

virtual bool ttkSurfaceGeometrySmoother::GetForceIdentifiersField ( )
virtual

◆ GetForceInputMaskScalarField()

virtual bool ttkSurfaceGeometrySmoother::GetForceInputMaskScalarField ( )
virtual

◆ GetNumberOfIterations()

virtual int ttkSurfaceGeometrySmoother::GetNumberOfIterations ( )
virtual

◆ GetUseMaskScalarField()

virtual bool ttkSurfaceGeometrySmoother::GetUseMaskScalarField ( )
virtual

◆ IsA()

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

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

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

◆ New()

static ttkSurfaceGeometrySmoother * ttkSurfaceGeometrySmoother::New ( )
static

◆ RequestData()

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

Definition at line 39 of file ttkSurfaceGeometrySmoother.cpp.

◆ SafeDownCast()

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

◆ SetForceIdentifiersField()

virtual void ttkSurfaceGeometrySmoother::SetForceIdentifiersField ( bool  )
virtual

◆ SetForceInputMaskScalarField()

virtual void ttkSurfaceGeometrySmoother::SetForceInputMaskScalarField ( bool  )
virtual

◆ SetNumberOfIterations()

virtual void ttkSurfaceGeometrySmoother::SetNumberOfIterations ( int  )
virtual

◆ SetUseMaskScalarField()

virtual void ttkSurfaceGeometrySmoother::SetUseMaskScalarField ( bool  )
virtual

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