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

Dense stencil of a given width. More...

#include <Stencils.h>

+ Inheritance diagram for openvdb::OPENVDB_VERSION_NAME::math::DenseStencil< 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< DenseStencil< 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
 
typedef BufferType::iterator IterType
 

Public Member Functions

 DenseStencil (const GridType &grid, int halfWidth)
 
const ValueTypegetCenterValue () const
 
void moveTo (const Coord &ijk)
 Initialize the stencil buffer with the values of voxel (x, y, z) and its neighbors. More...
 
template<typename IterType >
void moveTo (const IterType &iter)
 Initialize the stencil buffer with the values of voxel (x, y, z) and its neighbors. More...
 
- Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::math::BaseStencil< DenseStencil< 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...
 
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...
 

Friends

template<typename , typename , bool >
class BaseStencil
 

Additional Inherited Members

- Protected Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::math::BaseStencil< DenseStencil< GridT, IsSafe >, GridT, IsSafe >
 BaseStencil (const GridType &grid, int size)
 
- Protected Attributes inherited from openvdb::OPENVDB_VERSION_NAME::math::BaseStencil< DenseStencil< GridT, IsSafe >, GridT, IsSafe >
const GridTypemGrid
 
AccessorType mCache
 
BufferType mStencil
 
Coord mCenter
 

Detailed Description

template<typename GridT, bool IsSafe = true>
class openvdb::OPENVDB_VERSION_NAME::math::DenseStencil< GridT, IsSafe >

Dense stencil of a given width.

Definition at line 1617 of file Stencils.h.

Member Typedef Documentation

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

Definition at line 1622 of file Stencils.h.

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

Definition at line 1623 of file Stencils.h.

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

Definition at line 1624 of file Stencils.h.

Constructor & Destructor Documentation

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

Definition at line 1626 of file Stencils.h.

Member Function Documentation

template<typename GridT , bool IsSafe = true>
const ValueType& openvdb::OPENVDB_VERSION_NAME::math::DenseStencil< GridT, IsSafe >::getCenterValue ( ) const
inline

Definition at line 1633 of file Stencils.h.

template<typename GridT , bool IsSafe = true>
void openvdb::OPENVDB_VERSION_NAME::math::DenseStencil< GridT, IsSafe >::moveTo ( const Coord ijk)
inline

Initialize the stencil buffer with the values of voxel (x, y, z) and its neighbors.

Definition at line 1637 of file Stencils.h.

template<typename GridT , bool IsSafe = true>
template<typename IterType >
void openvdb::OPENVDB_VERSION_NAME::math::DenseStencil< GridT, IsSafe >::moveTo ( const IterType iter)
inline

Initialize the stencil buffer with the values of voxel (x, y, z) and its neighbors.

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


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