OpenVDB  1.2.0
Public Types | Public Member Functions | Static Public Attributes | Protected Attributes | Friends | List of all members
CurvatureStencil< GridType > Class Template Reference

#include <Stencils.h>

Inherits BaseStencil< GridType, CurvatureStencil< GridType > >.

Public Types

typedef BaseStencil< GridType,
CurvatureStencil< GridType > > 
BaseType
 
typedef GridType::ValueType ValueType
 
typedef GridType GridType
 
typedef GridType::TreeType TreeType
 
typedef std::vector< ValueTypeBufferType
 
typedef BufferType::iterator IterType
 

Public Member Functions

 CurvatureStencil (const GridType &grid)
 
 CurvatureStencil (const GridType &grid, Real dx)
 
ValueType meanCurvature ()
 Return the mean curvature at the previously buffered location. More...
 
ValueType meanCurvatureNormGrad ()
 
ValueType laplacian () const
 
math::Vec3< ValueTypegradient ()
 
void moveTo (const Coord &ijk)
 Initialize the stencil buffer with the values of voxel (x, y, z) and its neighbors. More...
 
void moveTo (const IterType &iter)
 Initialize the stencil buffer with the values of voxel (x, y, z) and its neighbors. More...
 
ValueType getValue (unsigned int pos=0) const
 Return the value from the stencil buffer with linear offset pos. More...
 
const ValueTypegetValue () const
 Return the value at the specified location relative to the center of the stencil. More...
 
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...
 

Static Public Attributes

static const int SIZE = 19
 

Protected Attributes

GridType::ConstAccessor mCache
 
BufferType mStencil
 
Coord mCenter
 

Friends

template<typename , typename >
class BaseStencil
 

Member Typedef Documentation

typedef std::vector<ValueType> BufferType
inherited
typedef GridType GridType
inherited
typedef BufferType::iterator IterType
inherited
typedef GridType::TreeType TreeType
inherited
typedef GridType::ValueType ValueType

Constructor & Destructor Documentation

CurvatureStencil ( const GridType grid)
inline
CurvatureStencil ( const GridType grid,
Real  dx 
)
inline

Member Function Documentation

const Coord& getCenterCoord ( ) const
inlineinherited

Return the coordinates of the center point of the stencil.

const ValueType& getCenterValue ( ) const
inlineinherited

Return the value at the center of the stencil.

ValueType getValue ( unsigned int  pos = 0) const
inlineinherited

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
inlineinherited

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

math::Vec3<ValueType> gradient ( )
inline

Return the gradient computed at the previously buffered location by second-order central differencing.

Note
This method should not be called until the stencil buffer has been populated via a call to moveTo(ijk).
bool intersects ( const ValueType isoValue = zeroVal<ValueType>()) const
inlineinherited

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

ValueType laplacian ( ) const
inline

Return the Laplacian computed at the previously buffered location by second-order central differencing.

Note
This method should not be called until the stencil buffer has been populated via a call to moveTo(ijk).
ValueType max ( ) const
inlineinherited

Return the largest value in the stencil buffer.

ValueType mean ( ) const
inlineinherited

Return the mean value of the current stencil.

ValueType meanCurvature ( )
inline

Return the mean curvature at the previously buffered location.

Note
This method should not be called until the stencil buffer has been populated via a call to moveTo(ijk).
ValueType meanCurvatureNormGrad ( )
inline

Return the mean curvature multiplied by the norm of the central-difference gradient. This method is very useful for mean-curvature flow of level sets!

Note
This method should not be called until the stencil buffer has been populated via a call to moveTo(ijk).
ValueType median ( ) const
inlineinherited

Return the median value of the current stencil.

ValueType min ( ) const
inlineinherited

Return the smallest value in the stencil buffer.

void moveTo ( const Coord ijk)
inlineinherited

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

void moveTo ( const IterType iter)
inlineinherited

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 setValue ( const ValueType value)
inlineinherited

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

int size ( )
inlineinherited

Return the size of the stencil buffer.

Friends And Related Function Documentation

friend class BaseStencil
friend

Member Data Documentation

GridType::ConstAccessor mCache
protectedinherited
Coord mCenter
protectedinherited
BufferType mStencil
protectedinherited
const int SIZE = 19
static

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