Filtering (e.g. diffusion) of narrow-band level sets. An optional scalar field can be used to produce a (smooth) alpha mask for the filtering. More...

#include <LevelSetFilter.h>

Inherits LevelSetTracker< GridT, InterruptT >.

Public Types
typedef LevelSetTracker< GridT, InterruptT >	BaseType

typedef GridT	GridType

typedef MaskT	MaskType

typedef GridType::TreeType	TreeType

typedef TreeType::ValueType	ValueType

typedef MaskType::ValueType	AlphaType

typedef tree::LeafManager < TreeType >::LeafRange	RangeType

typedef TreeType::LeafNodeType	LeafType

typedef tree::LeafManager < TreeType >	LeafManagerType

typedef LeafManagerType::LeafRange	LeafRange

typedef LeafManagerType::BufferType	BufferType

Public Member Functions
	BOOST_STATIC_ASSERT (boost::is_floating_point< AlphaType >::value)

	LevelSetFilter (GridType &grid, InterruptT *interrupt=NULL)
	Main constructor from a grid. More...

	LevelSetFilter (const LevelSetFilter &other)
	Shallow copy constructor called by tbb::parallel_for() threads during filtering. More...

virtual	~LevelSetFilter ()
	Destructor. More...

void	operator() (const RangeType &range) const
	Used internally by tbb::parallel_for(). More...

AlphaType	minMask () const
	Return the minimum value of the mask to be used for the derivation of a smooth alpha value. More...

AlphaType	maxMask () const
	Return the maximum value of the mask to be used for the derivation of a smooth alpha value. More...

void	setMaskRange (AlphaType min, AlphaType max)
	Define the range for the (optional) scalar mask. More...

bool	isMaskInverted () const
	Return true if the mask is inverted, i.e. min->max in the original mask maps to 1->0 in the inverted alpha mask. More...

void	invertMask (bool invert=true)
	Invert the optional mask, i.e. min->max in the original mask maps to 1->0 in the inverted alpha mask. More...

void	meanCurvature (const MaskType *mask=NULL)
	One iteration of mean-curvature flow of the level set. More...

void	laplacian (const MaskType *mask=NULL)
	One iteration of laplacian flow of the level set. More...

void	gaussian (int width=1, const MaskType *mask=NULL)
	One iteration of a fast separable gaussian filter. More...

void	offset (ValueType offset, const MaskType *mask=NULL)
	Offset the level set by the specified (world) distance. More...

void	median (int width=1, const MaskType *mask=NULL)
	One iteration of median-value flow of the level set. More...

void	mean (int width=1, const MaskType *mask=NULL)
	One iteration of mean-value flow of the level set. More...

	BOOST_STATIC_ASSERT (boost::is_floating_point< ValueType >::value)

void	normalize ()
	Iterative normalization, i.e. solving the Eikonal equation. More...

void	track ()

void	prune ()
	Remove voxels that are outside the narrow band. (substep of track) More...

math::BiasedGradientScheme	getSpatialScheme () const

void	setSpatialScheme (math::BiasedGradientScheme scheme)
	Set the spatial finite difference scheme. More...

math::TemporalIntegrationScheme	getTemporalScheme () const

void	setTemporalScheme (math::TemporalIntegrationScheme scheme)
	Set the spatial finite difference scheme. More...

int	getNormCount () const

void	setNormCount (int n)
	Set the number of normalizations performed per track or normalize call. More...

int	getGrainSize () const

void	setGrainSize (int grainsize)
	Set the grain-size used for multi-threading. More...

ValueType	voxelSize () const

void	startInterrupter (const char *msg)

void	endInterrupter ()

bool	checkInterrupter ()

const GridType &	grid () const

LeafManagerType &	leafs ()

const LeafManagerType &	leafs () const

void	operator() (const RangeType &r) const
	Public functor called by tbb::parallel_for() More...

Detailed Description

template<typename GridT, typename MaskT = typename GridT::template ValueConverter<float>::Type, typename InterruptT = util::NullInterrupter>
class openvdb::v2_3_0::tools::LevelSetFilter< GridT, MaskT, InterruptT >

Filtering (e.g. diffusion) of narrow-band level sets. An optional scalar field can be used to produce a (smooth) alpha mask for the filtering.

Note: This class performs propper interface tracking which allows for unrestricted surface deformations

Member Typedef Documentation

typedef MaskType::ValueType AlphaType

typedef LevelSetTracker<GridT, InterruptT> BaseType

typedef LeafManagerType::BufferType BufferType

inherited

typedef GridT GridType

typedef tree::LeafManager<TreeType> LeafManagerType

inherited

typedef LeafManagerType::LeafRange LeafRange

inherited

typedef TreeType::LeafNodeType LeafType

inherited

typedef MaskT MaskType

typedef tree::LeafManager<TreeType>::LeafRange RangeType

typedef GridType::TreeType TreeType

typedef TreeType::ValueType ValueType

Constructor & Destructor Documentation

LevelSetFilter	(	GridType &	grid,
		InterruptT *	interrupt = `NULL`
	)

inline

Main constructor from a grid.

Parameters

grid	The level set to be filtered.
interrupt	Optional interrupter.

LevelSetFilter ( const LevelSetFilter< GridT, MaskT, InterruptT > & other )

inline

Shallow copy constructor called by tbb::parallel_for() threads during filtering.

Parameters

other The other LevelSetFilter from which to copy.

virtual ~LevelSetFilter ( )

inlinevirtual

Destructor.

Member Function Documentation

BOOST_STATIC_ASSERT ( boost::is_floating_point< AlphaType >::value )

BOOST_STATIC_ASSERT ( boost::is_floating_point< ValueType >::value )

inherited

bool checkInterrupter ( )

inlineinherited

Returns: false if the process was interrupted

void endInterrupter ( )

inlineinherited

void gaussian	(	int	width = `1`,
		const MaskType *	mask = `NULL`
	)

inline

One iteration of a fast separable gaussian filter.

Parameters

width	Width of the gaussian kernel in voxel units.
mask	Optional alpha mask.

Note: This is approximated as 4 iterations of a separable mean filter which typically leads an approximation that's better than 95%!

int getGrainSize ( ) const

inlineinherited

Returns: the grain-size used for multi-threading

int getNormCount ( ) const

inlineinherited

Returns: The number of normalizations performed per track or normalize call.

math::BiasedGradientScheme getSpatialScheme ( ) const

inlineinherited

Returns: the spatial finite difference scheme

math::TemporalIntegrationScheme getTemporalScheme ( ) const

inlineinherited

Returns: the temporal integration scheme

const GridType& grid ( ) const

inlineinherited

void invertMask ( bool invert = true )

inline

Invert the optional mask, i.e. min->max in the original mask maps to 1->0 in the inverted alpha mask.

bool isMaskInverted ( ) const

inline

Return true if the mask is inverted, i.e. min->max in the original mask maps to 1->0 in the inverted alpha mask.

void laplacian ( const MaskType * mask = NULL )

inline

One iteration of laplacian flow of the level set.

Parameters

mask	Optional alpha mask.

LeafManagerType& leafs ( )

inlineinherited

const LeafManagerType& leafs ( ) const

inlineinherited

AlphaType maxMask ( ) const

inline

Return the maximum value of the mask to be used for the derivation of a smooth alpha value.

void mean	(	int	width = `1`,
		const MaskType *	mask = `NULL`
	)

inline

One iteration of mean-value flow of the level set.

Parameters

width	Width of the mean-value kernel in voxel units.
mask	Optional alpha mask.

Note: This filter is separable so it's fast!

void meanCurvature ( const MaskType * mask = NULL )

inline

One iteration of mean-curvature flow of the level set.

Parameters

mask	Optional alpha mask.

void median	(	int	width = `1`,
		const MaskType *	mask = `NULL`
	)

inline

One iteration of median-value flow of the level set.

Parameters

width	Width of the median-value kernel in voxel units.
mask	Optional alpha mask.

Warning: This filter is not separable and is hence relatively slow!

AlphaType minMask ( ) const

inline

Return the minimum value of the mask to be used for the derivation of a smooth alpha value.

void normalize ( )

inlineinherited

Iterative normalization, i.e. solving the Eikonal equation.

void offset	(	ValueType	offset,
		const MaskType *	mask = `NULL`
	)

inline

Offset the level set by the specified (world) distance.

Parameters

offset	Value of the offset.
mask	Optional alpha mask.

void operator() ( const RangeType & range ) const

inline

Used internally by tbb::parallel_for().

Parameters

range The range over which to perform multi-threading.

Warning: Never call this method directly!

void operator() ( const RangeType & r ) const

inlineinherited

Public functor called by tbb::parallel_for()

Note: Never call this method directly

void prune ( )

inlineinherited

Remove voxels that are outside the narrow band. (substep of track)

void setGrainSize ( int grainsize )

inlineinherited

Set the grain-size used for multi-threading.

Note: A grainsize of 0 or less disables multi-threading!

void setMaskRange	(	AlphaType	min,
		AlphaType	max
	)

inline

Define the range for the (optional) scalar mask.

Parameters

min	Minimum value of the range.
max	Maximum value of the range.

Mask values outside the range maps to alpha values of respectfully zero and one, and values inside the range maps smoothly to 0->1 (unless of course the mask is inverted).

Exceptions

ValueError if min is not smaller then max.

void setNormCount ( int n )

inlineinherited

Set the number of normalizations performed per track or normalize call.

void setSpatialScheme ( math::BiasedGradientScheme scheme )

inlineinherited

Set the spatial finite difference scheme.

void setTemporalScheme ( math::TemporalIntegrationScheme scheme )

inlineinherited

Set the spatial finite difference scheme.

void startInterrupter ( const char * msg )

inlineinherited

void track ( )

inlineinherited

Track the level set interface, i.e. rebuild and normalize the narrow band of the level set.

ValueType voxelSize ( ) const

inlineinherited

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

LevelSetFilter.h

Public Types

Public Member Functions

Detailed Description

template<typename GridT, typename MaskT = typename GridT::template ValueConverter<float>::Type, typename InterruptT = util::NullInterrupter> class openvdb::v2_3_0::tools::LevelSetFilter< GridT, MaskT, InterruptT >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<typename GridT, typename MaskT = typename GridT::template ValueConverter<float>::Type, typename InterruptT = util::NullInterrupter>
class openvdb::v2_3_0::tools::LevelSetFilter< GridT, MaskT, InterruptT >