ViennaLS
Loading...
Searching...
No Matches
viennals::MarkVoidPoints< T, D > Class Template Reference

This class is used to mark points of the level set which are enclosed in a void. More...

#include <lsMarkVoidPoints.hpp>

Public Member Functions

 MarkVoidPoints ()
 
 MarkVoidPoints (SmartPointer< Domain< T, D > > passedlsDomain, bool passedReverseVoidDetection=false)
 
void setLevelSet (SmartPointer< Domain< T, D > > passedlsDomain)
 
void setReverseVoidDetection (bool passedReverseVoidDetection)
 Set whether the "top" level set should be the most positive(default) connected chain of level set values, or the most negative. Most positive/negative refers to the lexicographical ordering of the coordinate of the point.
 
void setDetectLargestSurface (bool passedDetect)
 Set whether the number of points of one connected surface should be used to detect void points. Defaults to false. If this is set to true, the largest connected surface will be kept and all other grid points marked as void points. By setting reverseVoidDetection to true, the smallest surface will be used instead.
 
void setVoidTopSurface (VoidTopSurfaceEnum topSurface)
 Set which connected component to use as the top surface and mark all other components as void points.
 
void setSaveComponentIds (bool scid)
 Set whether the connected component IDs used to generate the void points should be saved. Ech point is assigned a component ID denoting which other points it is connected to.
 
void apply ()
 

Static Public Attributes

static constexpr char voidPointLabel [] = "VoidPointMarkers"
 

Detailed Description

template<class T, int D>
class viennals::MarkVoidPoints< T, D >

This class is used to mark points of the level set which are enclosed in a void.

Constructor & Destructor Documentation

◆ MarkVoidPoints() [1/2]

template<class T , int D>
viennals::MarkVoidPoints< T, D >::MarkVoidPoints ( )
inline

◆ MarkVoidPoints() [2/2]

template<class T , int D>
viennals::MarkVoidPoints< T, D >::MarkVoidPoints ( SmartPointer< Domain< T, D > > passedlsDomain,
bool passedReverseVoidDetection = false )
inline

Member Function Documentation

◆ apply()

template<class T , int D>
void viennals::MarkVoidPoints< T, D >::apply ( )
inline

◆ setDetectLargestSurface()

template<class T , int D>
void viennals::MarkVoidPoints< T, D >::setDetectLargestSurface ( bool passedDetect)
inline

Set whether the number of points of one connected surface should be used to detect void points. Defaults to false. If this is set to true, the largest connected surface will be kept and all other grid points marked as void points. By setting reverseVoidDetection to true, the smallest surface will be used instead.

◆ setLevelSet()

template<class T , int D>
void viennals::MarkVoidPoints< T, D >::setLevelSet ( SmartPointer< Domain< T, D > > passedlsDomain)
inline

◆ setReverseVoidDetection()

template<class T , int D>
void viennals::MarkVoidPoints< T, D >::setReverseVoidDetection ( bool passedReverseVoidDetection)
inline

Set whether the "top" level set should be the most positive(default) connected chain of level set values, or the most negative. Most positive/negative refers to the lexicographical ordering of the coordinate of the point.

◆ setSaveComponentIds()

template<class T , int D>
void viennals::MarkVoidPoints< T, D >::setSaveComponentIds ( bool scid)
inline

Set whether the connected component IDs used to generate the void points should be saved. Ech point is assigned a component ID denoting which other points it is connected to.

◆ setVoidTopSurface()

template<class T , int D>
void viennals::MarkVoidPoints< T, D >::setVoidTopSurface ( VoidTopSurfaceEnum topSurface)
inline

Set which connected component to use as the top surface and mark all other components as void points.

Member Data Documentation

◆ voidPointLabel

template<class T , int D>
char viennals::MarkVoidPoints< T, D >::voidPointLabel[] = "VoidPointMarkers"
staticconstexpr

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