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

#include <Stencils.h>

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

Public Types

typedef GridT GridType
 
typedef GridT::TreeType TreeType
 
typedef GridType::ValueType ValueType
 
- Public Types inherited from openvdb::OPENVDB_VERSION_NAME::math::BaseStencil< GradStencil< 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
 

Public Member Functions

 GradStencil (const GridType &grid)
 
 GradStencil (const GridType &grid, Real dx)
 
ValueType normSqGrad () const
 Return the norm square of the single-sided upwind gradient (computed via Godunov's scheme) at the previously buffered location. More...
 
math::Vec3< ValueTypegradient () const
 Return the gradient computed at the previously buffered location by second order central differencing. More...
 
math::Vec3< ValueTypegradient (const math::Vec3< ValueType > &V) const
 Return the first-order upwind gradient corresponding to the direction V. More...
 
ValueType laplacian () const
 
bool zeroCrossing () const
 
math::Vec3< ValueTypecpt ()
 Compute the closest-point transform to a level set. More...
 
template<int i, int j, int k>
unsigned int pos () const
 Return linear offset for the specified stencil point relative to its center. More...
 
- Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::math::BaseStencil< GradStencil< 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 = 7
 

Friends

template<typename , typename , bool >
class BaseStencil
 

Additional Inherited Members

- Protected Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::math::BaseStencil< GradStencil< GridT, IsSafe >, GridT, IsSafe >
 BaseStencil (const GridType &grid, int size)
 
- Protected Attributes inherited from openvdb::OPENVDB_VERSION_NAME::math::BaseStencil< GradStencil< 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::GradStencil< GridT, IsSafe >

This is a simple 7-point nearest neighbor stencil that supports gradient by second-order central differencing, first-order upwinding, Laplacian, closest-point transform and zero-crossing test.

Note
For optimal random access performance this class includes its own grid accessor.

Definition at line 1231 of file Stencils.h.

Member Typedef Documentation

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

Definition at line 1236 of file Stencils.h.

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

Definition at line 1237 of file Stencils.h.

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

Definition at line 1238 of file Stencils.h.

Constructor & Destructor Documentation

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

Definition at line 1242 of file Stencils.h.

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

Definition at line 1249 of file Stencils.h.

Member Function Documentation

template<typename GridT, bool IsSafe = true>
math::Vec3<ValueType> openvdb::OPENVDB_VERSION_NAME::math::GradStencil< GridT, IsSafe >::cpt ( )
inline

Compute the closest-point transform to a level set.

Returns
the closest point in index space to the surface from which the level set was derived.
Note
This method assumes that the grid represents a level set with distances in world units and a simple affine transfrom with uniform scaling.

Definition at line 1320 of file Stencils.h.

template<typename GridT, bool IsSafe = true>
math::Vec3<ValueType> openvdb::OPENVDB_VERSION_NAME::math::GradStencil< 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 1277 of file Stencils.h.

template<typename GridT, bool IsSafe = true>
math::Vec3<ValueType> openvdb::OPENVDB_VERSION_NAME::math::GradStencil< GridT, IsSafe >::gradient ( const math::Vec3< ValueType > &  V) const
inline

Return the first-order upwind gradient corresponding to the direction V.

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

Definition at line 1287 of file Stencils.h.

template<typename GridT, bool IsSafe = true>
ValueType openvdb::OPENVDB_VERSION_NAME::math::GradStencil< GridT, IsSafe >::laplacian ( ) const
inline

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

Definition at line 1297 of file Stencils.h.

template<typename GridT, bool IsSafe = true>
ValueType openvdb::OPENVDB_VERSION_NAME::math::GradStencil< GridT, IsSafe >::normSqGrad ( ) const
inline

Return the norm square of the single-sided upwind gradient (computed via Godunov's scheme) 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 1261 of file Stencils.h.

template<typename GridT, bool IsSafe = true>
template<int i, int j, int k>
unsigned int openvdb::OPENVDB_VERSION_NAME::math::GradStencil< GridT, IsSafe >::pos ( ) const
inline

Return linear offset for the specified stencil point relative to its center.

Definition at line 1334 of file Stencils.h.

template<typename GridT, bool IsSafe = true>
bool openvdb::OPENVDB_VERSION_NAME::math::GradStencil< GridT, IsSafe >::zeroCrossing ( ) const
inline

Return true if the sign of the value at the center point of the stencil is different from the signs of any of its six nearest neighbors.

Definition at line 1306 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 1350 of file Stencils.h.

Member Data Documentation

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

Definition at line 1240 of file Stencils.h.


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