#include <Stencils.h>

Inheritance diagram for nanovdb::GradStencil< GridT >:

Public Types
using	GridType = GridT

using	TreeType = typename GridT::TreeType

using	ValueType = typename GridT::ValueType

Public Types inherited from nanovdb::BaseStencil< GradStencil< GridT >, 7, GridT >
using	ValueType = typename GridT::ValueType

using	GridType = GridT

using	TreeType = typename GridT::TreeType

using	AccessorType = typename GridT::AccessorType

Public Member Functions
__hostdev__	GradStencil (const GridType &grid)

__hostdev__	GradStencil (const GridType &grid, double dx)

__hostdev__ ValueType	normSqGrad () const
	Return the norm square of the single-sided upwind gradient (computed via Godunov's scheme) at the previously buffered location. More...

__hostdev__ Vec3< ValueType >	gradient () const
	Return the gradient computed at the previously buffered location by second order central differencing. More...

__hostdev__ Vec3< ValueType >	gradient (const Vec3< ValueType > &V) const
	Return the first-order upwind gradient corresponding to the direction V. More...

__hostdev__ ValueType	laplacian () const

__hostdev__ bool	zeroCrossing () const

__hostdev__ Vec3< ValueType >	cpt ()
	Compute the closest-point transform to a level set. More...

template<int i, int j, int k>
__hostdev__ unsigned int	pos () const
	Return linear offset for the specified stencil point relative to its center. More...

Public Member Functions inherited from nanovdb::BaseStencil< GradStencil< GridT >, 7, GridT >
__hostdev__ void	moveTo (const Coord &ijk)
	Initialize the stencil buffer with the values of voxel (i, j, k) and its neighbors. More...

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

__hostdev__ void	moveTo (const IterType &iter)
	Initialize the stencil buffer with the values of voxel (x, y, z) and its neighbors. More...

__hostdev__ void	moveTo (const Vec3< RealType > &xyz)
	Initialize the stencil buffer with the values of voxel (x, y, z) and its neighbors. More...

__hostdev__ const ValueType &	getValue (unsigned int pos=0) const
	Return the value from the stencil buffer with linear offset pos. More...

__hostdev__ const ValueType &	getValue () const
	Return the value at the specified location relative to the center of the stencil. More...

__hostdev__ void	setValue (const ValueType &value)
	Set the value at the specified location relative to the center of the stencil. More...

__hostdev__ ValueType	mean () const
	Return the mean value of the current stencil. More...

__hostdev__ ValueType	min () const
	Return the smallest value in the stencil buffer. More...

__hostdev__ ValueType	max () const
	Return the largest value in the stencil buffer. More...

__hostdev__ const Coord &	getCenterCoord () const
	Return the coordinates of the center point of the stencil. More...

__hostdev__ const ValueType &	getCenterValue () const
	Return the value at the center of the stencil. More...

__hostdev__ bool	intersects (const ValueType &isoValue=ValueType(0)) const
	Return true if the center of the stencil intersects the iso-contour specified by the isoValue. More...

__hostdev__ 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. More...

__hostdev__ const GridType &	grid () const
	Return a const reference to the grid from which this stencil was constructed. More...

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

Static Public Attributes
static constexpr int	SIZE = 7

Friends
template<typename , int , typename >
class	BaseStencil

Additional Inherited Members
Static Public Member Functions inherited from nanovdb::BaseStencil< GradStencil< GridT >, 7, GridT >
static __hostdev__ int	size ()
	Return the size of the stencil buffer. More...

Protected Member Functions inherited from nanovdb::BaseStencil< GradStencil< GridT >, 7, GridT >
__hostdev__	BaseStencil (const GridType &grid)

Protected Attributes inherited from nanovdb::BaseStencil< GradStencil< GridT >, 7, GridT >
const GridType *	mGrid

AccessorType	mAcc

ValueType	mValues [SIZE]

Coord	mCenter

Detailed Description

template<typename GridT>
class nanovdb::GradStencil< GridT >

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 454 of file Stencils.h.

Member Typedef Documentation

template<typename GridT >

using nanovdb::GradStencil< GridT >::GridType = GridT

Definition at line 459 of file Stencils.h.

template<typename GridT >

using nanovdb::GradStencil< GridT >::TreeType = typename GridT::TreeType

Definition at line 460 of file Stencils.h.

template<typename GridT >

using nanovdb::GradStencil< GridT >::ValueType = typename GridT::ValueType

Definition at line 461 of file Stencils.h.

Constructor & Destructor Documentation

template<typename GridT >

__hostdev__ nanovdb::GradStencil< GridT >::GradStencil ( const GridType & grid )

inline

Definition at line 465 of file Stencils.h.

template<typename GridT >

__hostdev__ nanovdb::GradStencil< GridT >::GradStencil	(	const GridType &	grid,
		double	dx
	)

inline

Definition at line 472 of file Stencils.h.

Member Function Documentation

template<typename GridT >

__hostdev__ Vec3<ValueType> nanovdb::GradStencil< GridT >::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 542 of file Stencils.h.

template<typename GridT >

__hostdev__ Vec3<ValueType> nanovdb::GradStencil< GridT >::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 500 of file Stencils.h.

template<typename GridT >

__hostdev__ Vec3<ValueType> nanovdb::GradStencil< GridT >::gradient ( const 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 510 of file Stencils.h.

template<typename GridT >

__hostdev__ ValueType nanovdb::GradStencil< GridT >::laplacian ( ) const

inline

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

Definition at line 520 of file Stencils.h.

template<typename GridT >

__hostdev__ ValueType nanovdb::GradStencil< GridT >::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 484 of file Stencils.h.

template<typename GridT >

template<int i, int j, int k>

__hostdev__ unsigned int nanovdb::GradStencil< GridT >::pos ( ) const

inline

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

Definition at line 554 of file Stencils.h.

template<typename GridT >

__hostdev__ bool nanovdb::GradStencil< GridT >::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 529 of file Stencils.h.

Friends And Related Function Documentation

template<typename GridT >

template<typename , int , typename >

friend class BaseStencil

friend

Definition at line 570 of file Stencils.h.

Member Data Documentation

template<typename GridT >

constexpr int nanovdb::GradStencil< GridT >::SIZE = 7

static

Definition at line 463 of file Stencils.h.

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

nanovdb/util/Stencils.h

Public Types

Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

template<typename GridT> class nanovdb::GradStencil< GridT >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<typename GridT>
class nanovdb::GradStencil< GridT >