OpenVDB 11.0.0
Loading...
Searching...
No Matches
GridSampler< tree::ValueAccessor< TreeT >, SamplerType > Class Template Reference

Specialization of GridSampler for construction from a ValueAccessor type. More...

#include <openvdb/tools/Interpolation.h>

Public Types

using Ptr = SharedPtr<GridSampler>
 
using ValueType = typename TreeT::ValueType
 
using TreeType = TreeT
 
using GridType = Grid<TreeType>
 
using AccessorType = typename tree::ValueAccessor<TreeT>
 

Public Member Functions

 GridSampler (const AccessorType &acc, const math::Transform &transform)
 
const math::Transformtransform () const
 
template<typename RealType >
ValueType sampleVoxel (const RealType &x, const RealType &y, const RealType &z) const
 Sample a point in index space in the grid.
 
ValueType sampleVoxel (typename Coord::ValueType i, typename Coord::ValueType j, typename Coord::ValueType k) const
 Sample value in integer index space.
 
ValueType isSample (const Coord &ijk) const
 Sample value in integer index space.
 
ValueType isSample (const Vec3d &ispoint) const
 Sample in fractional index space.
 
ValueType wsSample (const Vec3d &wspoint) const
 Sample in world space.
 

Detailed Description

template<typename TreeT, typename SamplerType>
class openvdb::v11_0::tools::GridSampler< tree::ValueAccessor< TreeT >, SamplerType >

Specialization of GridSampler for construction from a ValueAccessor type.

Note
This version should normally be favored over the one above that takes a Grid or Tree. The reason is this version uses a ValueAccessor that performs fast (cached) access where the tree-based flavor performs slower (uncached) access.
Warning
Since this version stores a pointer to an (externally allocated) value accessor it is not threadsafe. Hence each thread should have its own instance of a GridSampler constructed from a local ValueAccessor. Alternatively the Grid/Tree-based GridSampler is threadsafe, but also slower.

Member Typedef Documentation

◆ AccessorType

template<typename TreeT , typename SamplerType >
using AccessorType = typename tree::ValueAccessor<TreeT>

◆ GridType

template<typename TreeT , typename SamplerType >
using GridType = Grid<TreeType>

◆ Ptr

template<typename TreeT , typename SamplerType >
using Ptr = SharedPtr<GridSampler>

◆ TreeType

template<typename TreeT , typename SamplerType >
using TreeType = TreeT

◆ ValueType

template<typename TreeT , typename SamplerType >
using ValueType = typename TreeT::ValueType

Constructor & Destructor Documentation

◆ GridSampler()

template<typename TreeT , typename SamplerType >
GridSampler ( const AccessorType & acc,
const math::Transform & transform )
inline
Parameters
acca ValueAccessor to be sampled
transformis used when sampling world space locations.

Member Function Documentation

◆ isSample() [1/2]

template<typename TreeT , typename SamplerType >
ValueType isSample ( const Coord & ijk) const
inline

Sample value in integer index space.

Parameters
ijkthe location in index space

◆ isSample() [2/2]

template<typename TreeT , typename SamplerType >
ValueType isSample ( const Vec3d & ispoint) const
inline

Sample in fractional index space.

Parameters
ispointthe location in index space

◆ sampleVoxel() [1/2]

template<typename TreeT , typename SamplerType >
template<typename RealType >
ValueType sampleVoxel ( const RealType & x,
const RealType & y,
const RealType & z ) const
inline

Sample a point in index space in the grid.

Parameters
xFractional x-coordinate of point in index-coordinates of grid
yFractional y-coordinate of point in index-coordinates of grid
zFractional z-coordinate of point in index-coordinates of grid

◆ sampleVoxel() [2/2]

template<typename TreeT , typename SamplerType >
ValueType sampleVoxel ( typename Coord::ValueType i,
typename Coord::ValueType j,
typename Coord::ValueType k ) const
inline

Sample value in integer index space.

Parameters
iInteger x-coordinate in index space
jInteger y-coordinate in index space
kInteger x-coordinate in index space

◆ transform()

template<typename TreeT , typename SamplerType >
const math::Transform & transform ( ) const
inline

◆ wsSample()

template<typename TreeT , typename SamplerType >
ValueType wsSample ( const Vec3d & wspoint) const
inline

Sample in world space.

Parameters
wspointthe location in world space