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

#include <openvdb/math/Stencils.h>

Inheritance diagram for BoxStencil< GridT, IsSafe >:
BaseStencil< DerivedType, 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
 

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 (const ValueType &isoValue=zeroVal< ValueType >()) const
 Return true if the center of the stencil intersects the.
 
ValueType interpolation (const math::Vec3< ValueType > &xyz) const
 Return the trilinear interpolation at the normalized position.
 
math::Vec3< ValueTypegradient (const math::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.
 
template<typename IterType >
void moveTo (const IterType &iter)
 Initialize the stencil buffer with the values of voxel (x, y, z) and its neighbors.
 
template<typename RealType >
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.
 
template<int i, int j, int k>
const ValueTypegetValue () const
 Return the value at the specified location relative to the center of the stencil.
 
template<int i, int j, int k>
void setValue (const ValueType &value)
 Set the value at the specified location relative to the center of the stencil.
 
int size ()
 Return the size of the stencil buffer.
 
ValueType median () const
 Return the median value of the current 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.
 
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.
 
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 Attributes

static const int SIZE = 8
 

Protected Attributes

const GridTypemGrid
 
Coord mCenter
 

Friends

template<typename , typename , bool >
class BaseStencil
 

Member Typedef Documentation

◆ AccessorType

template<typename DerivedType , typename GridT , bool IsSafe>
typedef tree::ValueAccessor<const TreeType, IsSafe> AccessorType
inherited

◆ BufferType

template<typename DerivedType , typename GridT , bool IsSafe>
typedef std::vector<ValueType> BufferType
inherited

◆ GridType

template<typename GridT , bool IsSafe = true>
typedef GridT GridType

◆ TreeType

template<typename GridT , bool IsSafe = true>
typedef GridT::TreeType TreeType

◆ ValueType

template<typename GridT , bool IsSafe = true>
typedef GridT::ValueType ValueType

Constructor & Destructor Documentation

◆ BoxStencil()

template<typename GridT , bool IsSafe = true>
BoxStencil ( const GridType & grid)
inline

Member Function Documentation

◆ accessor()

template<typename DerivedType , typename GridT , bool IsSafe>
const AccessorType & accessor ( ) const
inlineinherited

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

◆ getCenterCoord()

template<typename DerivedType , typename GridT , bool IsSafe>
const Coord & getCenterCoord ( ) const
inlineinherited

Return the coordinates of the center point of the stencil.

◆ getCenterValue()

template<typename DerivedType , typename GridT , bool IsSafe>
const ValueType & getCenterValue ( ) const
inlineinherited

Return the value at the center of the stencil.

◆ getValue() [1/2]

template<typename DerivedType , typename GridT , bool IsSafe>
template<int i, int j, int k>
const ValueType & getValue ( ) const
inlineinherited

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

◆ getValue() [2/2]

template<typename DerivedType , typename GridT , bool IsSafe>
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 , bool IsSafe = true>
math::Vec3< ValueType > gradient ( const math::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()

template<typename DerivedType , typename GridT , bool IsSafe>
const GridType & grid ( ) const
inlineinherited

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

◆ interpolation()

template<typename GridT , bool IsSafe = true>
ValueType interpolation ( const math::Vec3< ValueType > & xyz) const
inline

Return the trilinear interpolation at the normalized position.

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
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()

template<typename DerivedType , typename GridT , bool IsSafe>
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().

◆ intersects()

template<typename GridT , bool IsSafe = true>
bool intersects ( const ValueType & isoValue = zeroVal<ValueType>()) const
inline

Return true if the center of the stencil intersects the.

iso-contour specified by the isoValue

◆ max()

template<typename DerivedType , typename GridT , bool IsSafe>
ValueType max ( ) const
inlineinherited

Return the largest value in the stencil buffer.

◆ mean()

template<typename DerivedType , typename GridT , bool IsSafe>
ValueType mean ( ) const
inlineinherited

Return the mean value of the current stencil.

◆ median()

template<typename DerivedType , typename GridT , bool IsSafe>
ValueType median ( ) const
inlineinherited

Return the median value of the current stencil.

◆ min()

template<typename DerivedType , typename GridT , bool IsSafe>
ValueType min ( ) const
inlineinherited

Return the smallest value in the stencil buffer.

◆ moveTo() [1/4]

template<typename DerivedType , typename GridT , bool IsSafe>
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]

template<typename DerivedType , typename GridT , bool IsSafe>
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

◆ moveTo() [3/4]

template<typename DerivedType , typename GridT , bool IsSafe>
template<typename IterType >
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]

template<typename DerivedType , typename GridT , bool IsSafe>
template<typename RealType >
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 , bool IsSafe = true>
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()

template<typename DerivedType , typename GridT , bool IsSafe>
template<int i, int j, int k>
void setValue ( const ValueType & value)
inlineinherited

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

◆ size()

template<typename DerivedType , typename GridT , bool IsSafe>
int size ( )
inlineinherited

Return the size of the stencil buffer.

Friends And Related Symbol Documentation

◆ BaseStencil

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

Member Data Documentation

◆ mCenter

template<typename DerivedType , typename GridT , bool IsSafe>
Coord mCenter
protectedinherited

◆ mGrid

template<typename DerivedType , typename GridT , bool IsSafe>
const GridType* mGrid
protectedinherited

◆ SIZE

template<typename GridT , bool IsSafe = true>
const int SIZE = 8
static