OpenVDB  5.2.0
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
BaseStencil< DerivedType, GridT, IsSafe > Class Template Reference

#include <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< ValueTypeBufferType
 
typedef BufferType::iterator IterType
 

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 ValueTypegetValue (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 ValueTypegetValue () 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 CoordgetCenterCoord () const
 Return the coordinates of the center point of the stencil. More...
 
const ValueTypegetCenterValue () 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...
 
const GridTypegrid () const
 Return a const reference to the grid from which this stencil was constructed. More...
 
const AccessorTypeaccessor () 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 GridTypemGrid
 
AccessorType mCache
 
BufferType mStencil
 
Coord mCenter
 

Member Typedef Documentation

typedef tree::ValueAccessor<const TreeType, IsSafe> AccessorType
typedef std::vector<ValueType> BufferType
typedef GridT GridType
typedef BufferType::iterator IterType
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.

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
ijkIndex 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
ijkIndex coordinates of stnecil center
centerValueValue 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
xyzFloating 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 mCache
protected
Coord mCenter
protected
const GridType* mGrid
protected
BufferType mStencil
protected

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