BaseStencil< DerivedType, GridT, IsSafe > Class Template Reference

#include <openvdb/math/Stencils.h>

Public Types
typedef GridT	GridType
typedef GridT::TreeType	TreeType
typedef GridT::ValueType	ValueType
typedef tree::ValueAccessor< const TreeType, IsSafe >	AccessorType
typedef std::vector< ValueType >	BufferType

Public Member Functions
void	moveTo (const Coord &ijk)
	Initialize the stencil buffer with the values of voxel (i, j, k) and its neighbors. More...
void	moveTo (const Coord &ijk, const ValueType &centerValue)
	Initialize the stencil buffer with the values of voxel (i, j, k) and its neighbors. The method also takes a value of the center element of the stencil, assuming it is already known. More...
template<typename IterType >
void	moveTo (const IterType &iter)
	Initialize the stencil buffer with the values of voxel (x, y, z) and its neighbors. More...
template<typename RealType >
void	moveTo (const Vec3< RealType > &xyz)
	Initialize the stencil buffer with the values of voxel (x, y, z) and its neighbors. More...
const ValueType &	getValue (unsigned int pos=0) const
	Return the value from the stencil buffer with linear offset pos. More...
template<int i, int j, int k>
const ValueType &	getValue () const
	Return the value at the specified location relative to the center of the stencil. More...
template<int i, int j, int k>
void	setValue (const ValueType &value)
	Set the value at the specified location relative to the center of the stencil. More...
int	size ()
	Return the size of the stencil buffer. More...
ValueType	median () const
	Return the median value of the current stencil. More...
ValueType	mean () const
	Return the mean value of the current stencil. More...
ValueType	min () const
	Return the smallest value in the stencil buffer. More...
ValueType	max () const
	Return the largest value in the stencil buffer. More...
const Coord &	getCenterCoord () const
	Return the coordinates of the center point of the stencil. More...
const ValueType &	getCenterValue () const
	Return the value at the center of the stencil. More...
bool	intersects (const ValueType &isoValue=zeroVal< ValueType >()) const
	Return true if the center of the stencil intersects the iso-contour specified by the isoValue. More...
std::bitset< 6 >	intersectionMask (const ValueType &isoValue=zeroVal< ValueType >()) const
	Return true a bit-mask where the 6 bits indicates if the center of the stencil intersects the iso-contour specified by the isoValue. More...
const GridType &	grid () const
	Return a const reference to the grid from which this stencil was constructed. More...
const AccessorType &	accessor () const
	Return a const reference to the ValueAccessor associated with this Stencil. More...

Protected Member Functions
	BaseStencil (const GridType &grid, int size)

Protected Attributes
const GridType *	mGrid
AccessorType	mAcc
BufferType	mValues
Coord	mCenter

Member Typedef Documentation

typedef tree::ValueAccessor<const TreeType, IsSafe> AccessorType

typedef std::vector<ValueType> BufferType

typedef GridT GridType

typedef GridT::TreeType TreeType

typedef GridT::ValueType ValueType

Constructor & Destructor Documentation

BaseStencil ( const GridType &  grid, int  size  )

inlineprotected

Member Function Documentation

const AccessorType& accessor ( ) const

inline

Return a const reference to the ValueAccessor associated with this Stencil.

const Coord& getCenterCoord ( ) const

inline

Return the coordinates of the center point of the stencil.

const ValueType& getCenterValue ( ) const

inline

Return the value at the center of the stencil.

const ValueType& getValue ( unsigned int  pos = 0 ) const

inline

Return the value from the stencil buffer with linear offset pos.

Note

The default (pos = 0) corresponds to the first element which is typically the center point of the stencil.

const ValueType& getValue ( ) const

inline

Return the value at the specified location relative to the center of the stencil.

const GridType& grid ( ) const

inline

Return a const reference to the grid from which this stencil was constructed.

std::bitset<6> intersectionMask ( const ValueType &  isoValue = zeroVal<ValueType>() ) const

inline

Return true a bit-mask where the 6 bits indicates if the center of the stencil intersects the iso-contour specified by the isoValue.

Note

There are 2^6 = 64 different possible cases, including no intersections!

The ordering of bit mask is ( -x, +x, -y, +y, -z, +z ), so to check if there is an intersection in -y use mask.test(2) where mask is ther return value from this function. To check if there are any intersections use mask.any(), and for no intersections use mask.none(). To count the number of intersections use mask.count().

bool intersects ( const ValueType &  isoValue = zeroVal<ValueType>() ) const

inline

Return true if the center of the stencil intersects the iso-contour specified by the isoValue.

ValueType max ( ) const

inline

Return the largest value in the stencil buffer.

ValueType mean ( ) const

inline

Return the mean value of the current stencil.

ValueType median ( ) const

inline

Return the median value of the current stencil.

ValueType min ( ) const

inline

Return the smallest value in the stencil buffer.

void moveTo ( const Coord &  ijk )

inline

Initialize the stencil buffer with the values of voxel (i, j, k) and its neighbors.

Parameters

ijk	Index coordinates of stencil center

void moveTo ( const Coord &  ijk, const ValueType &  centerValue  )

inline

Initialize the stencil buffer with the values of voxel (i, j, k) and its neighbors. The method also takes a value of the center element of the stencil, assuming it is already known.

Parameters

ijk	Index coordinates of stnecil center
centerValue	Value of the center element of the stencil

void moveTo ( const IterType &  iter )

inline

Initialize the stencil buffer with the values of voxel (x, y, z) and its neighbors.

Note

This version is slightly faster than the one above, since the center voxel's value is read directly from the iterator.

void moveTo ( const Vec3< RealType > &  xyz )

inline

Initialize the stencil buffer with the values of voxel (x, y, z) and its neighbors.

Parameters

xyz	Floating point voxel coordinates of stencil center

This method will check to see if it is necessary to update the stencil based on the cached index coordinates of the center point.

void setValue ( const ValueType &  value )

inline

Set the value at the specified location relative to the center of the stencil.

int size ( )

inline

Return the size of the stencil buffer.

Member Data Documentation

AccessorType mAcc

protected

Coord mCenter

protected

const GridType* mGrid

protected

BufferType mValues

protected