openvdb::OPENVDB_VERSION_NAME::tools::GridSampler< tree::ValueAccessor< TreeT >, SamplerType > Class Template Reference

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

#include <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::Transform &	transform () 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. More...
ValueType	sampleVoxel (typename Coord::ValueType i, typename Coord::ValueType j, typename Coord::ValueType k) const
	Sample value in integer index space. More...
ValueType	isSample (const Coord &ijk) const
	Sample value in integer index space. More...
ValueType	isSample (const Vec3d &ispoint) const
	Sample in fractional index space. More...
ValueType	wsSample (const Vec3d &wspoint) const
	Sample in world space. More...

Detailed Description

template<typename TreeT, typename SamplerType>
class openvdb::OPENVDB_VERSION_NAME::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.

Definition at line 365 of file Interpolation.h.

Member Typedef Documentation

template<typename TreeT , typename SamplerType >

using openvdb::OPENVDB_VERSION_NAME::tools::GridSampler< tree::ValueAccessor< TreeT >, SamplerType >::AccessorType = typename tree::ValueAccessor<TreeT>

Definition at line 372 of file Interpolation.h.

template<typename TreeT , typename SamplerType >

using openvdb::OPENVDB_VERSION_NAME::tools::GridSampler< tree::ValueAccessor< TreeT >, SamplerType >::GridType = Grid<TreeType>

Definition at line 371 of file Interpolation.h.

template<typename TreeT , typename SamplerType >

using openvdb::OPENVDB_VERSION_NAME::tools::GridSampler< tree::ValueAccessor< TreeT >, SamplerType >::Ptr = SharedPtr<GridSampler>

Definition at line 368 of file Interpolation.h.

template<typename TreeT , typename SamplerType >

using openvdb::OPENVDB_VERSION_NAME::tools::GridSampler< tree::ValueAccessor< TreeT >, SamplerType >::TreeType = TreeT

Definition at line 370 of file Interpolation.h.

template<typename TreeT , typename SamplerType >

using openvdb::OPENVDB_VERSION_NAME::tools::GridSampler< tree::ValueAccessor< TreeT >, SamplerType >::ValueType = typename TreeT::ValueType

Definition at line 369 of file Interpolation.h.

Constructor & Destructor Documentation

template<typename TreeT , typename SamplerType >

openvdb::OPENVDB_VERSION_NAME::tools::GridSampler< tree::ValueAccessor< TreeT >, SamplerType >::GridSampler ( const AccessorType &  acc, const math::Transform &  transform  )

inline

Parameters

acc	a ValueAccessor to be sampled
transform	is used when sampling world space locations.

Definition at line 376 of file Interpolation.h.

Member Function Documentation

template<typename TreeT , typename SamplerType >

ValueType openvdb::OPENVDB_VERSION_NAME::tools::GridSampler< tree::ValueAccessor< TreeT >, SamplerType >::isSample ( const Coord &  ijk ) const

inline

Sample value in integer index space.

Parameters

ijk	the location in index space

Definition at line 405 of file Interpolation.h.

template<typename TreeT , typename SamplerType >

ValueType openvdb::OPENVDB_VERSION_NAME::tools::GridSampler< tree::ValueAccessor< TreeT >, SamplerType >::isSample ( const Vec3d &  ispoint ) const

inline

Sample in fractional index space.

Parameters

ispoint

the location in index space

Definition at line 409 of file Interpolation.h.

template<typename TreeT , typename SamplerType >

template<typename RealType >

ValueType openvdb::OPENVDB_VERSION_NAME::tools::GridSampler< tree::ValueAccessor< TreeT >, SamplerType >::sampleVoxel ( const RealType &  x, const RealType &  y, const RealType &  z  ) const

inline

Sample a point in index space in the grid.

Parameters

x	Fractional x-coordinate of point in index-coordinates of grid
y	Fractional y-coordinate of point in index-coordinates of grid
z	Fractional z-coordinate of point in index-coordinates of grid

Definition at line 387 of file Interpolation.h.

template<typename TreeT , typename SamplerType >

ValueType openvdb::OPENVDB_VERSION_NAME::tools::GridSampler< tree::ValueAccessor< TreeT >, SamplerType >::sampleVoxel ( typename Coord::ValueType  i, typename Coord::ValueType  j, typename Coord::ValueType  k  ) const

inline

Sample value in integer index space.

Parameters

i	Integer x-coordinate in index space
j	Integer y-coordinate in index space
k	Integer x-coordinate in index space

Definition at line 396 of file Interpolation.h.

template<typename TreeT , typename SamplerType >

const math::Transform& openvdb::OPENVDB_VERSION_NAME::tools::GridSampler< tree::ValueAccessor< TreeT >, SamplerType >::transform ( ) const

inline

Definition at line 380 of file Interpolation.h.

template<typename TreeT , typename SamplerType >

ValueType openvdb::OPENVDB_VERSION_NAME::tools::GridSampler< tree::ValueAccessor< TreeT >, SamplerType >::wsSample ( const Vec3d &  wspoint ) const

inline

Sample in world space.

Parameters

wspoint

the location in world space

Definition at line 418 of file Interpolation.h.

---

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

• openvdb/tools/Interpolation.h