#include <openvdb/math/Stencils.h>

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

Public Types
typedef GridT	GridType

typedef GridT::TreeType	TreeType

typedef GridType::ValueType	ValueType

typedef tree::ValueAccessor< const TreeType, IsSafe >	AccessorType

typedef std::vector< ValueType >	BufferType

typedef BufferType::iterator	IterType

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< ValueType >	gradient () const
	Return the gradient computed at the previously buffered location by second order central differencing. More...

math::Vec3< ValueType >	gradient (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< ValueType >	cpt ()
	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...

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 ValueType &	getValue (unsigned int pos=0) const
	Return the value from the stencil buffer with linear offset pos. More...

const ValueType &	getValue () 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 Coord &	getCenterCoord () const
	Return the coordinates of the center point of the stencil. More...

const ValueType &	getCenterValue () 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 GridType &	grid () const
	Return a const reference to the grid from which this stencil was constructed. More...

const AccessorType &	accessor () const
	Return a const reference to the ValueAccessor associated with this Stencil. More...

Static Public Attributes
static const int	SIZE = 7

Protected Attributes
const GridType *	mGrid

AccessorType	mAcc

BufferType	mValues

Coord	mCenter

Friends
template<typename , typename , bool >
class	BaseStencil

Detailed Description

template<typename GridT, bool IsSafe = true>
class openvdb::v9_0::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.

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 GridType::ValueType ValueType

Constructor & Destructor Documentation

GradStencil ( const GridType & grid )

inline

GradStencil	(	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.

math::Vec3<ValueType> 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.

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

math::Vec3<ValueType> 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).

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.

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

ijk	Index 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

ijk	Index coordinates of stnecil center
centerValue	Value 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

xyz	Floating 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.

ValueType 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).

unsigned int pos ( ) const

inline

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

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.

bool 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.

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 = 7

static

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Friends

Detailed Description

template<typename GridT, bool IsSafe = true> class openvdb::v9_0::math::GradStencil< GridT, IsSafe >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<typename GridT, bool IsSafe = true>
class openvdb::v9_0::math::GradStencil< GridT, IsSafe >