OpenVDB  7.1.0
Public Types | Public Member Functions | Static Public Attributes | Protected Attributes | Friends | List of all members
CurvatureStencil< GridT, IsSafe > Class Template Reference

#include <Stencils.h>

Inherits BaseStencil< CurvatureStencil< GridT, IsSafe >, GridT, IsSafe >.

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

 CurvatureStencil (const GridType &grid)
 
 CurvatureStencil (const GridType &grid, Real dx)
 
ValueType meanCurvature () const
 Return the mean curvature at the previously buffered location. More...
 
ValueType gaussianCurvature () const
 Return the Gaussian curvature at the previously buffered location. More...
 
void curvatures (ValueType &mean, ValueType &gauss) const
 Return both the mean and the Gaussian curvature at the previously buffered location. More...
 
ValueType meanCurvatureNormGrad () const
 
ValueType gaussianCurvatureNormGrad () const
 
void curvaturesNormGrad (ValueType &mean, ValueType &gauss) const
 Return both the mean and the Gaussian curvature at the previously buffered location. More...
 
std::pair< ValueType, ValueTypeprincipalCurvatures () const
 Return the pair (minimum, maximum) principal curvature at the previously buffered location. More...
 
ValueType laplacian () const
 
math::Vec3< ValueTypegradient () const
 
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...
 
void moveTo (const IterType &iter)
 Initialize the stencil buffer with the values of voxel (x, y, z) and its neighbors. More...
 
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...
 
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...
 
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 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...
 

Static Public Attributes

static const int SIZE = 19
 

Protected Attributes

const GridTypemGrid
 
AccessorType mAcc
 
BufferType mValues
 
Coord mCenter
 

Friends

template<typename , typename , bool >
class BaseStencil
 

Member Typedef Documentation

typedef tree::ValueAccessor<const TreeType, IsSafe> AccessorType
inherited
typedef std::vector<ValueType> BufferType
inherited
typedef GridT GridType
typedef BufferType::iterator IterType
inherited
typedef GridT::TreeType TreeType
typedef GridT::ValueType ValueType

Constructor & Destructor Documentation

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

Member Function Documentation

const AccessorType& accessor ( ) const
inlineinherited

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

void curvatures ( ValueType mean,
ValueType gauss 
) const
inline

Return both the mean and the Gaussian 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).
void curvaturesNormGrad ( ValueType mean,
ValueType gauss 
) const
inline

Return both the mean and the Gaussian 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 gaussianCurvature ( ) const
inline

Return the Gaussian 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 gaussianCurvatureNormGrad ( ) const
inline

Return the mean Gaussian multiplied by the norm of the central-difference gradient.

Note
This method should not be called until the stencil buffer has been populated via a call to moveTo(ijk).
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.

const 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 ( ) const
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).
const GridType& grid ( ) const
inlineinherited

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

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

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
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 ( ) const
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 ( ) const
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 (i, j, k) and its neighbors.

Parameters
ijkIndex coordinates of stencil center
void moveTo ( const Coord ijk,
const ValueType centerValue 
)
inlineinherited

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)
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 moveTo ( const Vec3< RealType > &  xyz)
inlineinherited

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.

std::pair<ValueType, ValueType> principalCurvatures ( ) const
inline

Return the pair (minimum, maximum) principal 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).
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

AccessorType mAcc
protectedinherited
Coord mCenter
protectedinherited
const GridType* mGrid
protectedinherited
BufferType mValues
protectedinherited
const int SIZE = 19
static

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