HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
openvdb::OPENVDB_VERSION_NAME::math::CurvatureStencil< GridT, IsSafe > Class Template Reference

#include <Stencils.h>

+ Inheritance diagram for openvdb::OPENVDB_VERSION_NAME::math::CurvatureStencil< GridT, IsSafe >:

Public Types

typedef GridT GridType
 
typedef GridT::TreeType TreeType
 
typedef GridT::ValueType ValueType
 
- Public Types inherited from openvdb::OPENVDB_VERSION_NAME::math::BaseStencil< CurvatureStencil< GridT, IsSafe >, GridT, IsSafe >
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
 
- Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::math::BaseStencil< CurvatureStencil< GridT, IsSafe >, GridT, IsSafe >
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
 

Friends

template<typename , typename , bool >
class BaseStencil
 

Additional Inherited Members

- Protected Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::math::BaseStencil< CurvatureStencil< GridT, IsSafe >, GridT, IsSafe >
 BaseStencil (const GridType &grid, int size)
 
- Protected Attributes inherited from openvdb::OPENVDB_VERSION_NAME::math::BaseStencil< CurvatureStencil< GridT, IsSafe >, GridT, IsSafe >
const GridTypemGrid
 
AccessorType mAcc
 
BufferType mValues
 
Coord mCenter
 

Detailed Description

template<typename GridT, bool IsSafe = true>
class openvdb::OPENVDB_VERSION_NAME::math::CurvatureStencil< GridT, IsSafe >

Definition at line 1515 of file Stencils.h.

Member Typedef Documentation

template<typename GridT, bool IsSafe = true>
typedef GridT openvdb::OPENVDB_VERSION_NAME::math::CurvatureStencil< GridT, IsSafe >::GridType

Definition at line 1520 of file Stencils.h.

template<typename GridT, bool IsSafe = true>
typedef GridT::TreeType openvdb::OPENVDB_VERSION_NAME::math::CurvatureStencil< GridT, IsSafe >::TreeType

Definition at line 1521 of file Stencils.h.

template<typename GridT, bool IsSafe = true>
typedef GridT::ValueType openvdb::OPENVDB_VERSION_NAME::math::CurvatureStencil< GridT, IsSafe >::ValueType

Definition at line 1522 of file Stencils.h.

Constructor & Destructor Documentation

template<typename GridT, bool IsSafe = true>
openvdb::OPENVDB_VERSION_NAME::math::CurvatureStencil< GridT, IsSafe >::CurvatureStencil ( const GridType grid)
inline

Definition at line 1526 of file Stencils.h.

template<typename GridT, bool IsSafe = true>
openvdb::OPENVDB_VERSION_NAME::math::CurvatureStencil< GridT, IsSafe >::CurvatureStencil ( const GridType grid,
Real  dx 
)
inline

Definition at line 1533 of file Stencils.h.

Member Function Documentation

template<typename GridT, bool IsSafe = true>
void openvdb::OPENVDB_VERSION_NAME::math::CurvatureStencil< GridT, IsSafe >::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).

Definition at line 1567 of file Stencils.h.

template<typename GridT, bool IsSafe = true>
void openvdb::OPENVDB_VERSION_NAME::math::CurvatureStencil< GridT, IsSafe >::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).

Definition at line 1608 of file Stencils.h.

template<typename GridT, bool IsSafe = true>
ValueType openvdb::OPENVDB_VERSION_NAME::math::CurvatureStencil< GridT, IsSafe >::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).

Definition at line 1555 of file Stencils.h.

template<typename GridT, bool IsSafe = true>
ValueType openvdb::OPENVDB_VERSION_NAME::math::CurvatureStencil< GridT, IsSafe >::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).

Definition at line 1596 of file Stencils.h.

template<typename GridT, bool IsSafe = true>
math::Vec3<ValueType> openvdb::OPENVDB_VERSION_NAME::math::CurvatureStencil< GridT, IsSafe >::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).

Definition at line 1655 of file Stencils.h.

template<typename GridT, bool IsSafe = true>
ValueType openvdb::OPENVDB_VERSION_NAME::math::CurvatureStencil< GridT, IsSafe >::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).

Definition at line 1642 of file Stencils.h.

template<typename GridT, bool IsSafe = true>
ValueType openvdb::OPENVDB_VERSION_NAME::math::CurvatureStencil< GridT, IsSafe >::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).

Definition at line 1544 of file Stencils.h.

template<typename GridT, bool IsSafe = true>
ValueType openvdb::OPENVDB_VERSION_NAME::math::CurvatureStencil< GridT, IsSafe >::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).

Definition at line 1584 of file Stencils.h.

template<typename GridT, bool IsSafe = true>
std::pair<ValueType, ValueType> openvdb::OPENVDB_VERSION_NAME::math::CurvatureStencil< GridT, IsSafe >::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).

Definition at line 1624 of file Stencils.h.

Friends And Related Function Documentation

template<typename GridT, bool IsSafe = true>
template<typename , typename , bool >
friend class BaseStencil
friend

Definition at line 1752 of file Stencils.h.

Member Data Documentation

template<typename GridT, bool IsSafe = true>
const int openvdb::OPENVDB_VERSION_NAME::math::CurvatureStencil< GridT, IsSafe >::SIZE = 19
static

Definition at line 1524 of file Stencils.h.


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