Filter< GridT, InterruptT > Class Template Reference

Filtering of VDB volumes. More...

#include <Filter.h>

Public Types
typedef GridT	GridType
typedef GridType::TreeType	TreeType
typedef TreeType::LeafNodeType	LeafType
typedef LeafType::ValueType	ValueType
typedef tree::LeafManager < TreeType >	LeafManagerType
typedef LeafManagerType::LeafRange	RangeType
typedef LeafManagerType::BufferType	BufferType

Public Member Functions
	Filter (GridT &grid, InterruptT *interrupt=NULL)
void	mean (int width=1, int iterations=1, bool serial=false)
	One iteration of a fast separable mean-value (i.e. box) filter. More...
void	gaussian (int width=1, int iterations=1, bool serial=false)
	One iteration of a fast separable gaussian filter. More...
void	median (int width=1, int iterations=1, bool serial=false)
	One iteration of a median-value filter. More...
void	offset (float offset, bool serial=false)
void	operator() (const RangeType &range) const
	Used internally by tbb::parallel_for() More...

Detailed Description

template<typename GridT, typename InterruptT = util::NullInterrupter>
class openvdb::v2_0_0::tools::Filter< GridT, InterruptT >

Filtering of VDB volumes.

Note

Only the values in the grid are changed, not its topology!

Member Typedef Documentation

typedef LeafManagerType::BufferType BufferType

typedef GridT GridType

typedef tree::LeafManager<TreeType> LeafManagerType

typedef TreeType::LeafNodeType LeafType

typedef LeafManagerType::LeafRange RangeType

typedef GridType::TreeType TreeType

typedef LeafType::ValueType ValueType

Constructor & Destructor Documentation

Filter ( GridT &  grid, InterruptT *  interrupt = NULL  )

inline

Constructor

Parameters

grid	Grid to be filtered.
interrupt	Optional interrupter.

Member Function Documentation

void gaussian ( int  width = 1, int  iterations = 1, bool  serial = false  )

inline

One iteration of a fast separable gaussian filter.

Note

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

Parameters

width	The width of the mean-value filter is 2*width+1 voxels.
iterations	Numer of times the mean-value filter is applied.
serial	False if multi-threading is enabled.

void mean ( int  width = 1, int  iterations = 1, bool  serial = false  )

inline

One iteration of a fast separable mean-value (i.e. box) filter.

Parameters

width	The width of the mean-value filter is 2*width+1 voxels.
iterations	Number of times the mean-value filter is applied.
serial	False if multi-threading is enabled.

void median ( int  width = 1, int  iterations = 1, bool  serial = false  )

inline

One iteration of a median-value filter.

Note

This filter is not separable and is hence relatively slow!

Parameters

width	The width of the mean-value filter is 2*width+1 voxels.
iterations	Numer of times the mean-value filter is applied.
serial	False if multi-threading is enabled.

void offset ( float  offset, bool  serial = false  )

inline

Offsets (i.e. adds) a constant value to all active voxels.

Parameters

offset	Offset in world units
serial	False if multi-threading is enabled.

void operator() ( const RangeType &  range ) const

inline

Used internally by tbb::parallel_for()

Parameters

range

Range of LeafNodes over which to multi-thread.

Warning

Never call this method directly!

---

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

• Filter.h