OpenVDB 10.0.1
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | Friends | List of all members
BoxStencil< GridT > Class Template Reference

#include <nanovdb/util/Stencils.h>

Inheritance diagram for BoxStencil< GridT >:
BaseStencil< BoxStencil< GridT >, 8, GridT >

Public Types

using GridType = GridT
 
using TreeType = typename GridT::TreeType
 
using ValueType = typename GridT::ValueType
 
using AccessorType = typename GridT::AccessorType
 

Public Member Functions

 BoxStencil (const GridType &grid)
 
template<int i, int j, int k>
unsigned int pos () const
 Return linear offset for the specified stencil point relative to its center.
 
bool intersects (ValueType isoValue=ValueType(0)) const
 Return true if the center of the stencil intersects the.
 
ValueType interpolation (const Vec3< ValueType > &xyz) const
 Return the trilinear interpolation at the normalized position.
 
Vec3< ValueTypegradient (const Vec3< ValueType > &xyz) const
 Return the gradient in world space of the trilinear interpolation kernel.
 
void moveTo (const Coord &ijk)
 Initialize the stencil buffer with the values of voxel (i, j, k) and its neighbors.
 
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.
 
void moveTo (const IterType &iter)
 Initialize the stencil buffer with the values of voxel (x, y, z) and its neighbors.
 
void moveTo (const Vec3< RealType > &xyz)
 Initialize the stencil buffer with the values of voxel (x, y, z) and its neighbors.
 
const ValueTypegetValue (unsigned int pos=0) const
 Return the value from the stencil buffer with linear offset pos.
 
const ValueTypegetValue () const
 Return the value at the specified location relative to the center of the stencil.
 
void setValue (const ValueType &value)
 Set the value at the specified location relative to the center of the stencil.
 
ValueType mean () const
 Return the mean value of the current stencil.
 
ValueType min () const
 Return the smallest value in the stencil buffer.
 
ValueType max () const
 Return the largest value in the stencil buffer.
 
const CoordgetCenterCoord () const
 Return the coordinates of the center point of the stencil.
 
const ValueTypegetCenterValue () const
 Return the value at the center of the stencil.
 
bool intersects (const ValueType &isoValue=ValueType(0)) const
 Return true if the center of the stencil intersects the iso-contour specified by the isoValue.
 
Mask intersectionMask (ValueType isoValue=ValueType(0)) const
 Return true a bit-mask where the 6 lower bits indicates if the center of the stencil intersects the iso-contour specified by the isoValue.
 
const GridTypegrid () const
 Return a const reference to the grid from which this stencil was constructed.
 
const AccessorTypeaccessor () const
 Return a const reference to the ValueAccessor associated with this Stencil.
 

Static Public Member Functions

static int size ()
 Return the size of the stencil buffer.
 

Static Public Attributes

static constexpr int SIZE = 8
 

Protected Attributes

const GridTypemGrid
 

Friends

template<typename , int , typename >
class BaseStencil
 

Member Typedef Documentation

◆ AccessorType

using AccessorType = typename GridT::AccessorType
inherited

◆ GridType

template<typename GridT >
using GridType = GridT

◆ TreeType

template<typename GridT >
using TreeType = typename GridT::TreeType

◆ ValueType

template<typename GridT >
using ValueType = typename GridT::ValueType

Constructor & Destructor Documentation

◆ BoxStencil()

template<typename GridT >
BoxStencil ( const GridType grid)
inline

Member Function Documentation

◆ accessor()

const AccessorType & accessor ( ) const
inlineinherited

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

◆ getCenterCoord()

const Coord & getCenterCoord ( ) const
inlineinherited

Return the coordinates of the center point of the stencil.

◆ getCenterValue()

const ValueType & getCenterValue ( ) const
inlineinherited

Return the value at the center of the stencil.

◆ getValue() [1/2]

const ValueType & getValue ( ) const
inlineinherited

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

◆ getValue() [2/2]

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.

◆ gradient()

template<typename GridT >
Vec3< ValueType > gradient ( const Vec3< ValueType > &  xyz) const
inline

Return the gradient in world space of the trilinear interpolation kernel.

Parameters
xyzFloating point coordinate position.
Warning
It is assumed that the stencil has already been moved to the relevant voxel position, e.g. using moveTo(xyz).
Note
Computed as partial derivatives of the trilinear interpolation kernel: v000 (1-u)(1-v)(1-w) + v001 (1-u)(1-v)w + v010 (1-u)v(1-w) + v011 (1-u)vw
  • v100 u(1-v)(1-w) + v101 u(1-v)w + v110 uv(1-w) + v111 uvw

◆ grid()

const GridType & grid ( ) const
inlineinherited

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

◆ interpolation()

template<typename GridT >
ValueType interpolation ( const Vec3< ValueType > &  xyz) const
inline

Return the trilinear interpolation at the normalized position.

Parameters
xyzFloating point coordinate position. Index space and NOT world space.
Warning
It is assumed that the stencil has already been moved to the relevant voxel position, e.g. using moveTo(xyz).
Note
Trilinear interpolation kernal reads as: v000 (1-u)(1-v)(1-w) + v001 (1-u)(1-v)w + v010 (1-u)v(1-w) + v011 (1-u)vw
  • v100 u(1-v)(1-w) + v101 u(1-v)w + v110 uv(1-w) + v111 uvw

◆ intersectionMask()

Mask intersectionMask ( ValueType  isoValue = ValueType(0)) const
inlineinherited

Return true a bit-mask where the 6 lower 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 & (1u<<2)) where mask is ther return value from this function. To check if there are any intersections use mask!=0u, and for no intersections use mask==0u. To count the number of intersections use __builtin_popcount(mask).

◆ intersects() [1/2]

bool intersects ( const ValueType isoValue = ValueType(0)) const
inlineinherited

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

◆ intersects() [2/2]

template<typename GridT >
bool intersects ( ValueType  isoValue = ValueType(0)) const
inline

Return true if the center of the stencil intersects the.

iso-contour specified by the isoValue

◆ max()

ValueType max ( ) const
inlineinherited

Return the largest value in the stencil buffer.

◆ mean()

ValueType mean ( ) const
inlineinherited

Return the mean value of the current stencil.

◆ min()

ValueType min ( ) const
inlineinherited

Return the smallest value in the stencil buffer.

◆ moveTo() [1/4]

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

◆ moveTo() [2/4]

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 stencil center
centerValueValue of the center element of the stencil

◆ moveTo() [3/4]

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.

◆ moveTo() [4/4]

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.

◆ pos()

template<typename GridT >
template<int i, int j, int k>
unsigned int pos ( ) const
inline

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

◆ setValue()

void setValue ( const ValueType value)
inlineinherited

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

◆ size()

static int size ( )
inlinestaticinherited

Return the size of the stencil buffer.

Friends And Related Symbol Documentation

◆ BaseStencil

template<typename GridT >
template<typename , int , typename >
friend class BaseStencil
friend

Member Data Documentation

◆ mGrid

const GridType* mGrid
protectedinherited

◆ SIZE

template<typename GridT >
constexpr int SIZE = 8
staticconstexpr