OpenVDB  0.104.0
Public Types | Public Member Functions | List of all members
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::RangeType RangeType
 
typedef LeafManagerType::BufferType BufferType
 

Public Member Functions

 Filter (GridT &grid, InterruptT *interrupt=NULL)
 Constructor. More...
 
 Filter (const Filter &other)
 Shallow copy constructor called by tbb::parallel_for() threads during filtering. More...
 
virtual ~Filter ()
 
void mean (int width=1, bool serial=false)
 One iteration of a fast separable mean-value (i.e. box) filter. More...
 
void gaussian (int width=1, bool serial=false)
 One iteration of a fast separable gaussian filter. More...
 
void median (int width=1, bool serial=false)
 One iteration of a median-value filter. More...
 
void offset (float offset, bool serial=false)
 Offsets (i.e. adds) a constant value to all active voxels. More...
 
void operator() (const RangeType &r) const
 Used internally by tbb::parallel_for() More...
 

Detailed Description

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

Filtering of VDB volumes.

Member Typedef Documentation

typedef GridT GridType
typedef TreeType::LeafNodeType LeafType
typedef GridType::TreeType TreeType
typedef LeafType::ValueType ValueType

Constructor & Destructor Documentation

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

Constructor.

Filter ( const Filter< GridT, InterruptT > &  other)
inline

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

virtual ~Filter ( )
inlinevirtual

Member Function Documentation

void gaussian ( int  width = 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%!
void mean ( int  width = 1,
bool  serial = false 
)
inline

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

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

One iteration of a median-value filter.

Note
This filter is not separable and is hence relatively slow!
void offset ( float  offset,
bool  serial = false 
)
inline

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

void operator() ( const RangeType r) const
inline

Used internally by tbb::parallel_for()

Note
Never call this method directly!

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