Loading...
Searching...
No Matches
Dense.h
Go to the documentation of this file.
// Copyright Contributors to the OpenVDB Project
// SPDX-License-Identifier: MPL-2.0
/// @file Dense.h
///
/// @brief This file defines a simple dense grid and efficient
/// converters to and from VDB grids.
#ifndef OPENVDB_TOOLS_DENSE_HAS_BEEN_INCLUDED
#define OPENVDB_TOOLS_DENSE_HAS_BEEN_INCLUDED
#include <openvdb/Types.h>
#include <openvdb/Grid.h>
#include <openvdb/tree/ValueAccessor.h>
#include <openvdb/Exceptions.h>
#include <openvdb/util/Formats.h>
#include "Prune.h"
#include <tbb/parallel_for.h>
#include <iostream>
#include <memory>
#include <string>
#include <utility> // for std::pair
#include <vector>
namespace openvdb {
OPENVDB_USE_VERSION_NAMESPACE
namespace OPENVDB_VERSION_NAME {
namespace tools {
/// @brief Populate a dense grid with the values of voxels from a sparse grid,
/// where the sparse grid intersects the dense grid.
/// @param sparse an OpenVDB grid or tree from which to copy values
/// @param dense the dense grid into which to copy values
/// @param serial if false, process voxels in parallel
template<typename DenseT, typename GridOrTreeT>
void
copyToDense(
const GridOrTreeT& sparse,
DenseT& dense,
bool serial = false);
/// @brief Populate a sparse grid with the values of all of the voxels of a dense grid.
/// @param dense the dense grid from which to copy values
/// @param sparse an OpenVDB grid or tree into which to copy values
/// @param tolerance values in the dense grid that are within this tolerance of the sparse
/// grid's background value become inactive background voxels or tiles in the sparse grid
/// @param serial if false, process voxels in parallel
template<typename DenseT, typename GridOrTreeT>
void
copyFromDense(
const DenseT& dense,
GridOrTreeT& sparse,
const typename GridOrTreeT::ValueType& tolerance,
bool serial = false);
////////////////////////////////////////
/// We currently support the following two 3D memory layouts for dense
/// volumes: XYZ, i.e. x is the fastest moving index, and ZYX, i.e. z
/// is the fastest moving index. The ZYX memory layout leads to nested
/// for-loops of the order x, y, z, which we find to be the most
/// intuitive. Hence, ZYX is the layout used throughout VDB. However,
/// other data structures, e.g. Houdini and Maya, employ the XYZ
/// layout. Clearly a dense volume with the ZYX layout converts more
/// efficiently to a VDB, but we support both for convenience.
enum MemoryLayout { LayoutXYZ, LayoutZYX };
/// @brief Base class for Dense which is defined below.
/// @note The constructor of this class is protected to prevent direct
/// instantiation.
template<typename ValueT, MemoryLayout Layout> class DenseBase;
/// @brief Partial template specialization of DenseBase.
/// @note ZYX is the memory-layout in VDB. It leads to nested
/// for-loops of the order x, y, z which we find to be the most intuitive.
template<typename ValueT>
class DenseBase<ValueT, LayoutZYX>
{
public:
/// @brief Return the linear offset into this grid's value array given by
/// unsigned coordinates (i, j, k), i.e., coordinates relative to
/// the origin of this grid's bounding box.
///
/// @warning The input coordinates are assume to be relative to
/// the grid's origin, i.e. minimum of its index bounding box!
inline size_t coordToOffset(size_t i, size_t j, size_t k) const { return i*mX + j*mY + k; }
/// @brief Return the local coordinate corresponding to the specified linear offset.
///
/// @warning The returned coordinate is relative to the origin of this
/// grid's bounding box so add dense.origin() to get absolute coordinates.
inline Coord offsetToLocalCoord(size_t n) const
{
const size_t x = n / mX;
n -= mX*x;
const size_t y = n / mY;
return Coord(Coord::ValueType(x), Coord::ValueType(y), Coord::ValueType(n - mY*y));
}
/// @brief Return the stride of the array in the x direction ( = dimY*dimZ).
/// @note This method is required by both CopyToDense and CopyFromDense.
inline size_t xStride() const { return mX; }
/// @brief Return the stride of the array in the y direction ( = dimZ).
/// @note This method is required by both CopyToDense and CopyFromDense.
inline size_t yStride() const { return mY; }
/// @brief Return the stride of the array in the z direction ( = 1).
/// @note This method is required by both CopyToDense and CopyFromDense.
static size_t zStride() { return 1; }
protected:
/// Protected constructor so as to prevent direct instantiation
DenseBase(const CoordBBox& bbox) : mBBox(bbox), mY(bbox.dim()[2]), mX(mY*bbox.dim()[1]) {}
const CoordBBox mBBox;//signed coordinates of the domain represented by the grid
const size_t mY, mX;//strides in the y and x direction
};// end of DenseBase<ValueT, LayoutZYX>
/// @brief Partial template specialization of DenseBase.
/// @note This is the memory-layout employed in Houdini and Maya. It leads
/// to nested for-loops of the order z, y, x.
template<typename ValueT>
class DenseBase<ValueT, LayoutXYZ>
{
public:
/// @brief Return the linear offset into this grid's value array given by
/// unsigned coordinates (i, j, k), i.e., coordinates relative to
/// the origin of this grid's bounding box.
///
/// @warning The input coordinates are assume to be relative to
/// the grid's origin, i.e. minimum of its index bounding box!
inline size_t coordToOffset(size_t i, size_t j, size_t k) const { return i + j*mY + k*mZ; }
/// @brief Return the index coordinate corresponding to the specified linear offset.
///
/// @warning The returned coordinate is relative to the origin of this
/// grid's bounding box so add dense.origin() to get absolute coordinates.
inline Coord offsetToLocalCoord(size_t n) const
{
const size_t z = n / mZ;
n -= mZ*z;
const size_t y = n / mY;
return Coord(Coord::ValueType(n - mY*y), Coord::ValueType(y), Coord::ValueType(z));
}
/// @brief Return the stride of the array in the x direction ( = 1).
/// @note This method is required by both CopyToDense and CopyFromDense.
static size_t xStride() { return 1; }
/// @brief Return the stride of the array in the y direction ( = dimX).
/// @note This method is required by both CopyToDense and CopyFromDense.
inline size_t yStride() const { return mY; }
/// @brief Return the stride of the array in the y direction ( = dimX*dimY).
/// @note This method is required by both CopyToDense and CopyFromDense.
inline size_t zStride() const { return mZ; }
protected:
/// Protected constructor so as to prevent direct instantiation
DenseBase(const CoordBBox& bbox) : mBBox(bbox), mY(bbox.dim()[0]), mZ(mY*bbox.dim()[1]) {}
const CoordBBox mBBox;//signed coordinates of the domain represented by the grid
const size_t mY, mZ;//strides in the y and z direction
};// end of DenseBase<ValueT, LayoutXYZ>
/// @brief Dense is a simple dense grid API used by the CopyToDense and
/// CopyFromDense classes defined below.
/// @details Use the Dense class to efficiently produce a dense in-memory
/// representation of an OpenVDB grid. However, be aware that a dense grid
/// could have a memory footprint that is orders of magnitude larger than
/// the sparse grid from which it originates.
///
/// @note This class can be used as a simple wrapper for existing dense grid
/// classes if they provide access to the raw data array.
/// @note This implementation allows for the 3D memory layout to be
/// defined by the MemoryLayout template parameter (see above for definition).
/// The default memory layout is ZYX since that's the layout used by OpenVDB grids.
template<typename ValueT, MemoryLayout Layout = LayoutZYX>
class Dense : public DenseBase<ValueT, Layout>
{
public:
using ValueType = ValueT;
using BaseT = DenseBase<ValueT, Layout>;
using Ptr = SharedPtr<Dense>;
using ConstPtr = SharedPtr<const Dense>;
/// @brief Construct a dense grid with a given range of coordinates.
///
/// @param bbox the bounding box of the (signed) coordinate range of this grid
/// @throw ValueError if the bounding box is empty.
/// @note The min and max coordinates of the bounding box are inclusive.
Dense(const CoordBBox& bbox) : BaseT(bbox) { this->init(); }
/// @brief Construct a dense grid with a given range of coordinates and initial value
///
/// @param bbox the bounding box of the (signed) coordinate range of this grid
/// @param value the initial value of the grid.
/// @throw ValueError if the bounding box is empty.
/// @note The min and max coordinates of the bounding box are inclusive.
Dense(const CoordBBox& bbox, const ValueT& value) : BaseT(bbox)
{
this->init();
this->fill(value);
}
/// @brief Construct a dense grid that wraps an external array.
///
/// @param bbox the bounding box of the (signed) coordinate range of this grid
/// @param data a raw C-style array whose size is commensurate with
/// the coordinate domain of @a bbox
///
/// @note The data array is assumed to have a stride of one in the @e z direction.
/// @throw ValueError if the bounding box is empty.
/// @note The min and max coordinates of the bounding box are inclusive.
Dense(const CoordBBox& bbox, ValueT* data) : BaseT(bbox), mData(data)
{
if (BaseT::mBBox.empty()) {
OPENVDB_THROW(ValueError, "can't construct a dense grid with an empty bounding box");
}
}
/// @brief Construct a dense grid with a given origin and dimensions.
///
/// @param dim the desired dimensions of the grid
/// @param min the signed coordinates of the first voxel in the dense grid
/// @throw ValueError if any of the dimensions are zero.
/// @note The @a min coordinate is inclusive, and the max coordinate will be
/// @a min + @a dim - 1.
Dense(const Coord& dim, const Coord& min = Coord(0))
: BaseT(CoordBBox(min, min+dim.offsetBy(-1)))
{
this->init();
}
/// @brief Return the memory layout for this grid (see above for definitions).
static MemoryLayout memoryLayout() { return Layout; }
/// @brief Return a raw pointer to this grid's value array.
/// @note This method is required by CopyToDense.
inline ValueT* data() { return mData; }
/// @brief Return a raw pointer to this grid's value array.
/// @note This method is required by CopyFromDense.
inline const ValueT* data() const { return mData; }
/// @brief Return the bounding box of the signed index domain of this grid.
/// @note This method is required by both CopyToDense and CopyFromDense.
inline const CoordBBox& bbox() const { return BaseT::mBBox; }
/// Return the grid's origin in index coordinates.
inline const Coord& origin() const { return BaseT::mBBox.min(); }
/// @brief Return the number of voxels contained in this grid.
inline Index64 valueCount() const { return BaseT::mBBox.volume(); }
/// @brief Set the value of the voxel at the given array offset.
inline void setValue(size_t offset, const ValueT& value) { mData[offset] = value; }
/// @brief Return a const reference to the value of the voxel at the given array offset.
const ValueT& getValue(size_t offset) const { return mData[offset]; }
/// @brief Return a non-const reference to the value of the voxel at the given array offset.
ValueT& getValue(size_t offset) { return mData[offset]; }
/// @brief Set the value of the voxel at unsigned index coordinates (i, j, k).
/// @note This is somewhat slower than using an array offset.
inline void setValue(size_t i, size_t j, size_t k, const ValueT& value)
{
mData[BaseT::coordToOffset(i,j,k)] = value;
}
/// @brief Return a const reference to the value of the voxel
/// at unsigned index coordinates (i, j, k).
/// @note This is somewhat slower than using an array offset.
inline const ValueT& getValue(size_t i, size_t j, size_t k) const
{
return mData[BaseT::coordToOffset(i,j,k)];
}
/// @brief Return a non-const reference to the value of the voxel
/// at unsigned index coordinates (i, j, k).
/// @note This is somewhat slower than using an array offset.
inline ValueT& getValue(size_t i, size_t j, size_t k)
{
return mData[BaseT::coordToOffset(i,j,k)];
}
/// @brief Set the value of the voxel at the given signed coordinates.
/// @note This is slower than using either an array offset or unsigned index coordinates.
inline void setValue(const Coord& xyz, const ValueT& value)
{
mData[this->coordToOffset(xyz)] = value;
}
/// @brief Return a const reference to the value of the voxel at the given signed coordinates.
/// @note This is slower than using either an array offset or unsigned index coordinates.
inline const ValueT& getValue(const Coord& xyz) const
{
return mData[this->coordToOffset(xyz)];
}
/// @brief Return a non-const reference to the value of the voxel
/// at the given signed coordinates.
/// @note This is slower than using either an array offset or unsigned index coordinates.
inline ValueT& getValue(const Coord& xyz)
{
return mData[this->coordToOffset(xyz)];
}
/// @brief Fill this grid with a constant value.
inline void fill(const ValueT& value)
{
size_t size = this->valueCount();
ValueT* a = mData;
while(size--) *a++ = value;
}
/// @brief Return the linear offset into this grid's value array given by
/// the specified signed coordinates, i.e., coordinates in the space of
/// this grid's bounding box.
///
/// @note This method reflects the fact that we assume the same
/// layout of values as an OpenVDB grid, i.e., the fastest coordinate is @e z.
inline size_t coordToOffset(const Coord& xyz) const
{
assert(BaseT::mBBox.isInside(xyz));
return BaseT::coordToOffset(size_t(xyz[0]-BaseT::mBBox.min()[0]),
size_t(xyz[1]-BaseT::mBBox.min()[1]),
size_t(xyz[2]-BaseT::mBBox.min()[2]));
}
/// @brief Return the global coordinate corresponding to the specified linear offset.
inline Coord offsetToCoord(size_t n) const
{
return this->offsetToLocalCoord(n) + BaseT::mBBox.min();
}
/// @brief Return the memory footprint of this Dense grid in bytes.
inline Index64 memUsage() const
{
return sizeof(*this) + BaseT::mBBox.volume() * sizeof(ValueType);
}
/// @brief Output a human-readable description of this grid to the
/// specified stream.
void print(const std::string& name = "", std::ostream& os = std::cout) const
{
const Coord dim = BaseT::mBBox.dim();
os << "Dense Grid";
if (!name.empty()) os << " \"" << name << "\"";
util::printBytes(os, this->memUsage(), ":\n Memory footprint: ");
os << " Dimensions of grid : " << dim[0] << " x " << dim[1] << " x " << dim[2] << "\n";
os << " Number of voxels: " << util::formattedInt(this->valueCount()) << "\n";
os << " Bounding box of voxels: " << BaseT::mBBox << "\n";
os << " Memory layout: " << (Layout == LayoutZYX ? "ZYX (" : "XYZ (dis")
<< "similar to VDB)\n";
}
private:
/// @brief Private method to initialize the dense value array.
void init()
{
if (BaseT::mBBox.empty()) {
OPENVDB_THROW(ValueError, "can't construct a dense grid with an empty bounding box");
}
mArray.reset(new ValueT[BaseT::mBBox.volume()]);
mData = mArray.get();
}
std::unique_ptr<ValueT[]> mArray;
ValueT* mData;//raw c-style pointer to values
};// end of Dense
////////////////////////////////////////
/// @brief Copy an OpenVDB tree into an existing dense grid.
///
/// @note Only voxels that intersect the dense grid's bounding box are copied
/// from the OpenVDB tree. But both active and inactive voxels are copied,
/// so all existing values in the dense grid are overwritten, regardless of
/// the OpenVDB tree's topology.
template<typename _TreeT, typename _DenseT = Dense<typename _TreeT::ValueType> >
class CopyToDense
{
public:
using DenseT = _DenseT;
using TreeT = _TreeT;
using ValueT = typename TreeT::ValueType;
CopyToDense(const TreeT& tree, DenseT& dense)
: mRoot(&(tree.root())), mDense(&dense) {}
void copy(bool serial = false) const
{
if (serial) {
mRoot->copyToDense(mDense->bbox(), *mDense);
} else {
tbb::parallel_for(mDense->bbox(), *this);
}
}
/// @brief Public method called by tbb::parallel_for
void operator()(const CoordBBox& bbox) const
{
mRoot->copyToDense(bbox, *mDense);
}
private:
const typename TreeT::RootNodeType* mRoot;
DenseT* mDense;
};// CopyToDense
// Convenient wrapper function for the CopyToDense class
template<typename DenseT, typename GridOrTreeT>
void
copyToDense(const GridOrTreeT& sparse, DenseT& dense, bool serial)
{
using Adapter = TreeAdapter<GridOrTreeT>;
using TreeT = typename Adapter::TreeType;
CopyToDense<TreeT, DenseT> op(Adapter::constTree(sparse), dense);
op.copy(serial);
}
////////////////////////////////////////
/// @brief Copy the values from a dense grid into an OpenVDB tree.
///
/// @details Values in the dense grid that are within a tolerance of
/// the background value are truncated to inactive background voxels or tiles.
/// This allows the tree to form a sparse representation of the dense grid.
///
/// @note Since this class allocates leaf nodes concurrently it is recommended
/// to use a scalable implementation of @c new like the one provided by TBB,
/// rather than the mutex-protected standard library @c new.
template<typename _TreeT, typename _DenseT = Dense<typename _TreeT::ValueType> >
class CopyFromDense
{
public:
using DenseT = _DenseT;
using TreeT = _TreeT;
using ValueT = typename TreeT::ValueType;
using LeafT = typename TreeT::LeafNodeType;
using AccessorT = tree::ValueAccessor<TreeT>;
CopyFromDense(const DenseT& dense, TreeT& tree, const ValueT& tolerance)
: mDense(&dense),
mTree(&tree),
mBlocks(nullptr),
mTolerance(tolerance),
mAccessor(tree.empty() ? nullptr : new AccessorT(tree))
{
}
CopyFromDense(const CopyFromDense& other)
: mDense(other.mDense),
mTree(other.mTree),
mBlocks(other.mBlocks),
mTolerance(other.mTolerance),
mAccessor(other.mAccessor.get() == nullptr ? nullptr : new AccessorT(*mTree))
{
}
/// @brief Copy values from the dense grid to the sparse tree.
void copy(bool serial = false)
{
mBlocks = new std::vector<Block>();
const CoordBBox& bbox = mDense->bbox();
// Pre-process: Construct a list of blocks aligned with (potential) leaf nodes
for (CoordBBox sub=bbox; sub.min()[0] <= bbox.max()[0]; sub.min()[0] = sub.max()[0] + 1) {
for (sub.min()[1] = bbox.min()[1]; sub.min()[1] <= bbox.max()[1];
sub.min()[1] = sub.max()[1] + 1)
{
for (sub.min()[2] = bbox.min()[2]; sub.min()[2] <= bbox.max()[2];
sub.min()[2] = sub.max()[2] + 1)
{
sub.max() = Coord::minComponent(bbox.max(),
(sub.min()&(~(LeafT::DIM-1u))).offsetBy(LeafT::DIM-1u));
mBlocks->push_back(Block(sub));
}
}
}
// Multi-threaded process: Convert dense grid into leaf nodes and tiles
if (serial) {
(*this)(tbb::blocked_range<size_t>(0, mBlocks->size()));
} else {
tbb::parallel_for(tbb::blocked_range<size_t>(0, mBlocks->size()), *this);
}
// Post-process: Insert leaf nodes and tiles into the tree, and prune the tiles only!
tree::ValueAccessor<TreeT> acc(*mTree);
for (size_t m=0, size = mBlocks->size(); m<size; ++m) {
Block& block = (*mBlocks)[m];
if (block.leaf) {
acc.addLeaf(block.leaf);
} else if (block.tile.second) {//only background tiles are inactive
acc.addTile(1, block.bbox.min(), block.tile.first, true);//leaf tile
}
}
delete mBlocks;
mBlocks = nullptr;
tools::pruneTiles(*mTree, mTolerance);//multi-threaded
}
/// @brief Public method called by tbb::parallel_for
/// @warning Never call this method directly!
void operator()(const tbb::blocked_range<size_t> &r) const
{
assert(mBlocks);
LeafT* leaf = new LeafT();
for (size_t m=r.begin(), n=0, end = r.end(); m != end; ++m, ++n) {
Block& block = (*mBlocks)[m];
const CoordBBox &bbox = block.bbox;
if (mAccessor.get() == nullptr) {//i.e. empty target tree
leaf->fill(mTree->background(), false);
} else {//account for existing leaf nodes in the target tree
if (const LeafT* target = mAccessor->probeConstLeaf(bbox.min())) {
(*leaf) = (*target);
} else {
ValueT value = zeroVal<ValueT>();
bool state = mAccessor->probeValue(bbox.min(), value);
leaf->fill(value, state);
}
}
leaf->copyFromDense(bbox, *mDense, mTree->background(), mTolerance);
if (!leaf->isConstant(block.tile.first, block.tile.second, mTolerance)) {
leaf->setOrigin(bbox.min() & (~(LeafT::DIM - 1)));
block.leaf = leaf;
leaf = new LeafT();
}
}// loop over blocks
delete leaf;
}
private:
struct Block {
CoordBBox bbox;
LeafT* leaf;
std::pair<ValueT, bool> tile;
Block(const CoordBBox& b) : bbox(b), leaf(nullptr) {}
};
const DenseT* mDense;
TreeT* mTree;
std::vector<Block>* mBlocks;
ValueT mTolerance;
std::unique_ptr<AccessorT> mAccessor;
};// CopyFromDense
// Convenient wrapper function for the CopyFromDense class
template<typename DenseT, typename GridOrTreeT>
void
copyFromDense(const DenseT& dense, GridOrTreeT& sparse,
const typename GridOrTreeT::ValueType& tolerance, bool serial)
{
using Adapter = TreeAdapter<GridOrTreeT>;
using TreeT = typename Adapter::TreeType;
CopyFromDense<TreeT, DenseT> op(dense, Adapter::tree(sparse), tolerance);
op.copy(serial);
}
} // namespace tools
} // namespace OPENVDB_VERSION_NAME
} // namespace openvdb
#endif // OPENVDB_TOOLS_DENSE_HAS_BEEN_INCLUDED
Formats.h
Utility routines to output nicely-formatted numeric values.
value
ValueT value
Definition GridBuilder.h:1290
Grid.h
Prune.h
Defined various multi-threaded utility functions for trees.
ValueAccessor.h
openvdb::v10_0::Coord::ValueType
Int32 ValueType
Definition Coord.h:32
openvdb::v10_0::Coord::minComponent
void minComponent(const Coord &other)
Perform a component-wise minimum with the other Coord.
Definition Coord.h:175
openvdb::v10_0::ValueError
Definition Exceptions.h:65
openvdb::v10_0::math::CoordBBox
Axis-aligned bounding box of signed integer coordinates.
Definition Coord.h:249
openvdb::v10_0::math::CoordBBox::min
const Coord & min() const
Definition Coord.h:321
openvdb::v10_0::math::CoordBBox::max
const Coord & max() const
Definition Coord.h:322
openvdb::v10_0::math::Coord
Signed (x, y, z) 32-bit integer coordinates.
Definition Coord.h:25
openvdb::v10_0::math::Coord::offsetBy
Coord offsetBy(Int32 dx, Int32 dy, Int32 dz) const
Definition Coord.h:91
openvdb::v10_0::math::Coord::min
static Coord min()
Return the smallest possible coordinate.
Definition Coord.h:43
openvdb::v10_0::math::Coord::max
static Coord max()
Return the largest possible coordinate.
Definition Coord.h:46
openvdb::v10_0::tools::CopyFromDense
Copy the values from a dense grid into an OpenVDB tree.
Definition Dense.h:445
openvdb::v10_0::tools::CopyFromDense::CopyFromDense
CopyFromDense(const DenseT &dense, TreeT &tree, const ValueT &tolerance)
Definition Dense.h:453
openvdb::v10_0::tools::CopyFromDense::copy
void copy(bool serial=false)
Copy values from the dense grid to the sparse tree.
Definition Dense.h:471
openvdb::v10_0::tools::CopyFromDense::LeafT
typename TreeT::LeafNodeType LeafT
Definition Dense.h:450
openvdb::v10_0::tools::CopyFromDense::AccessorT
tree::ValueAccessor< TreeT > AccessorT
Definition Dense.h:451
openvdb::v10_0::tools::CopyFromDense::CopyFromDense
CopyFromDense(const CopyFromDense &other)
Definition Dense.h:461
openvdb::v10_0::tools::CopyFromDense::operator()
void operator()(const tbb::blocked_range< size_t > &r) const
Public method called by tbb::parallel_for.
Definition Dense.h:515
openvdb::v10_0::tools::CopyFromDense::ValueT
typename TreeT::ValueType ValueT
Definition Dense.h:449
openvdb::v10_0::tools::CopyFromDense::TreeT
_TreeT TreeT
Definition Dense.h:448
openvdb::v10_0::tools::CopyFromDense::DenseT
_DenseT DenseT
Definition Dense.h:447
openvdb::v10_0::tools::CopyToDense
Copy an OpenVDB tree into an existing dense grid.
Definition Dense.h:388
openvdb::v10_0::tools::CopyToDense::copy
void copy(bool serial=false) const
Definition Dense.h:397
openvdb::v10_0::tools::CopyToDense::CopyToDense
CopyToDense(const TreeT &tree, DenseT &dense)
Definition Dense.h:394
openvdb::v10_0::tools::CopyToDense::operator()
void operator()(const CoordBBox &bbox) const
Public method called by tbb::parallel_for.
Definition Dense.h:407
openvdb::v10_0::tools::CopyToDense::ValueT
typename TreeT::ValueType ValueT
Definition Dense.h:392
openvdb::v10_0::tools::CopyToDense::TreeT
_TreeT TreeT
Definition Dense.h:391
openvdb::v10_0::tools::CopyToDense::DenseT
_DenseT DenseT
Definition Dense.h:390
openvdb::v10_0::tools::DenseBase< ValueT, LayoutXYZ >::coordToOffset
size_t coordToOffset(size_t i, size_t j, size_t k) const
Return the linear offset into this grid's value array given by unsigned coordinates (i,...
Definition Dense.h:135
openvdb::v10_0::tools::DenseBase< ValueT, LayoutXYZ >::offsetToLocalCoord
Coord offsetToLocalCoord(size_t n) const
Return the index coordinate corresponding to the specified linear offset.
Definition Dense.h:141
openvdb::v10_0::tools::DenseBase< ValueT, LayoutXYZ >::DenseBase
DenseBase(const CoordBBox &bbox)
Protected constructor so as to prevent direct instantiation.
Definition Dense.h:163
openvdb::v10_0::tools::DenseBase< ValueT, LayoutXYZ >::mZ
const size_t mZ
Definition Dense.h:166
openvdb::v10_0::tools::DenseBase< ValueT, LayoutXYZ >::mBBox
const CoordBBox mBBox
Definition Dense.h:165
openvdb::v10_0::tools::DenseBase< ValueT, LayoutXYZ >::zStride
size_t zStride() const
Return the stride of the array in the y direction ( = dimX*dimY).
Definition Dense.h:159
openvdb::v10_0::tools::DenseBase< ValueT, LayoutXYZ >::xStride
static size_t xStride()
Return the stride of the array in the x direction ( = 1).
Definition Dense.h:151
openvdb::v10_0::tools::DenseBase< ValueT, LayoutXYZ >::yStride
size_t yStride() const
Return the stride of the array in the y direction ( = dimX).
Definition Dense.h:155
openvdb::v10_0::tools::DenseBase< ValueT, LayoutXYZ >::mY
const size_t mY
Definition Dense.h:166
openvdb::v10_0::tools::DenseBase< ValueT, LayoutZYX >::coordToOffset
size_t coordToOffset(size_t i, size_t j, size_t k) const
Return the linear offset into this grid's value array given by unsigned coordinates (i,...
Definition Dense.h:88
openvdb::v10_0::tools::DenseBase< ValueT, LayoutZYX >::offsetToLocalCoord
Coord offsetToLocalCoord(size_t n) const
Return the local coordinate corresponding to the specified linear offset.
Definition Dense.h:94
openvdb::v10_0::tools::DenseBase< ValueT, LayoutZYX >::DenseBase
DenseBase(const CoordBBox &bbox)
Protected constructor so as to prevent direct instantiation.
Definition Dense.h:116
openvdb::v10_0::tools::DenseBase< ValueT, LayoutZYX >::mBBox
const CoordBBox mBBox
Definition Dense.h:118
openvdb::v10_0::tools::DenseBase< ValueT, LayoutZYX >::zStride
static size_t zStride()
Return the stride of the array in the z direction ( = 1).
Definition Dense.h:112
openvdb::v10_0::tools::DenseBase< ValueT, LayoutZYX >::yStride
size_t yStride() const
Return the stride of the array in the y direction ( = dimZ).
Definition Dense.h:108
openvdb::v10_0::tools::DenseBase< ValueT, LayoutZYX >::mY
const size_t mY
Definition Dense.h:119
openvdb::v10_0::tools::DenseBase< ValueT, LayoutZYX >::mX
const size_t mX
Definition Dense.h:119
openvdb::v10_0::tools::DenseBase< ValueT, LayoutZYX >::xStride
size_t xStride() const
Return the stride of the array in the x direction ( = dimY*dimZ).
Definition Dense.h:104
openvdb::v10_0::tools::DenseBase
Base class for Dense which is defined below.
Definition Dense.h:73
openvdb::v10_0::tools::Dense::Dense
Dense(const Coord &dim, const Coord &min=Coord(0))
Construct a dense grid with a given origin and dimensions.
Definition Dense.h:232
openvdb::v10_0::tools::Dense::getValue
const ValueT & getValue(const Coord &xyz) const
Return a const reference to the value of the voxel at the given signed coordinates.
Definition Dense.h:300
openvdb::v10_0::tools::Dense::BaseT
DenseBase< ValueT, Layout > BaseT
Definition Dense.h:186
openvdb::v10_0::tools::Dense::Dense
Dense(const CoordBBox &bbox, const ValueT &value)
Construct a dense grid with a given range of coordinates and initial value.
Definition Dense.h:203
openvdb::v10_0::tools::Dense::Ptr
SharedPtr< Dense > Ptr
Definition Dense.h:187
openvdb::v10_0::tools::Dense::getValue
ValueT & getValue(const Coord &xyz)
Return a non-const reference to the value of the voxel at the given signed coordinates.
Definition Dense.h:308
openvdb::v10_0::tools::Dense::origin
const Coord & origin() const
Return the grid's origin in index coordinates.
Definition Dense.h:254
openvdb::v10_0::tools::Dense::valueCount
Index64 valueCount() const
Return the number of voxels contained in this grid.
Definition Dense.h:257
openvdb::v10_0::tools::Dense::Dense
Dense(const CoordBBox &bbox)
Construct a dense grid with a given range of coordinates.
Definition Dense.h:195
openvdb::v10_0::tools::Dense::Dense
Dense(const CoordBBox &bbox, ValueT *data)
Construct a dense grid that wraps an external array.
Definition Dense.h:218
openvdb::v10_0::tools::Dense::getValue
const ValueT & getValue(size_t offset) const
Return a const reference to the value of the voxel at the given array offset.
Definition Dense.h:263
openvdb::v10_0::tools::Dense::ValueType
ValueT ValueType
Definition Dense.h:185
openvdb::v10_0::tools::Dense< ValueT, openvdb::tools::LayoutZYX >::fill
void fill(const ValueT &value)
Definition Dense.h:314
openvdb::v10_0::tools::Dense::setValue
void setValue(size_t offset, const ValueT &value)
Set the value of the voxel at the given array offset.
Definition Dense.h:260
openvdb::v10_0::tools::Dense::setValue
void setValue(const Coord &xyz, const ValueT &value)
Set the value of the voxel at the given signed coordinates.
Definition Dense.h:293
openvdb::v10_0::tools::Dense::data
const ValueT * data() const
Return a raw pointer to this grid's value array.
Definition Dense.h:247
openvdb::v10_0::tools::Dense::getValue
ValueT & getValue(size_t i, size_t j, size_t k)
Return a non-const reference to the value of the voxel at unsigned index coordinates (i,...
Definition Dense.h:286
openvdb::v10_0::tools::Dense::memoryLayout
static MemoryLayout memoryLayout()
Return the memory layout for this grid (see above for definitions).
Definition Dense.h:239
openvdb::v10_0::tools::Dense::setValue
void setValue(size_t i, size_t j, size_t k, const ValueT &value)
Set the value of the voxel at unsigned index coordinates (i, j, k).
Definition Dense.h:270
openvdb::v10_0::tools::Dense< ValueT, openvdb::tools::LayoutZYX >::data
ValueT * data()
Definition Dense.h:243
openvdb::v10_0::tools::Dense::getValue
const ValueT & getValue(size_t i, size_t j, size_t k) const
Return a const reference to the value of the voxel at unsigned index coordinates (i,...
Definition Dense.h:278
openvdb::v10_0::tools::Dense::ConstPtr
SharedPtr< const Dense > ConstPtr
Definition Dense.h:188
openvdb::v10_0::tools::Dense::getValue
ValueT & getValue(size_t offset)
Return a non-const reference to the value of the voxel at the given array offset.
Definition Dense.h:266
openvdb::v10_0::tools::Dense< ValueT, openvdb::tools::LayoutZYX >::bbox
const CoordBBox & bbox() const
Definition Dense.h:251
openvdb::v10_0::tools::Dense::memUsage
Index64 memUsage() const
Return the memory footprint of this Dense grid in bytes.
Definition Dense.h:342
openvdb::v10_0::tools::Dense::print
void print(const std::string &name="", std::ostream &os=std::cout) const
Output a human-readable description of this grid to the specified stream.
Definition Dense.h:349
openvdb::v10_0::tools::Dense::offsetToCoord
Coord offsetToCoord(size_t n) const
Return the global coordinate corresponding to the specified linear offset.
Definition Dense.h:336
openvdb::v10_0::tools::Dense< ValueT, openvdb::tools::LayoutZYX >::coordToOffset
size_t coordToOffset(const Coord &xyz) const
Definition Dense.h:327
openvdb::v10_0::tree::ValueAccessor
Definition ValueAccessor.h:191
openvdb::v10_0::tree::ValueAccessor::addLeaf
void addLeaf(LeafNodeT *leaf)
Add the specified leaf to this tree, possibly creating a child branch in the process....
Definition ValueAccessor.h:345
openvdb::v10_0::tree::ValueAccessor::addTile
void addTile(Index level, const Coord &xyz, const ValueType &value, bool state)
Add a tile at the specified tree level that contains voxel (x, y, z), possibly deleting existing node...
Definition ValueAccessor.h:353
openvdb::v10_0::tools::copyFromDense
void copyFromDense(const DenseT &dense, GridOrTreeT &sparse, const typename GridOrTreeT::ValueType &tolerance, bool serial=false)
Populate a sparse grid with the values of all of the voxels of a dense grid.
Definition Dense.h:568
openvdb::v10_0::tools::MemoryLayout
MemoryLayout
Definition Dense.h:68
openvdb::v10_0::tools::LayoutXYZ
@ LayoutXYZ
Definition Dense.h:68
openvdb::v10_0::tools::LayoutZYX
@ LayoutZYX
Definition Dense.h:68
openvdb::v10_0::tools::pruneTiles
void pruneTiles(TreeT &tree, typename TreeT::ValueType tolerance=zeroVal< typename TreeT::ValueType >(), bool threaded=true, size_t grainSize=1)
Reduce the memory footprint of a tree by replacing with tiles any non-leaf nodes whose values are all...
Definition Prune.h:345
openvdb::v10_0::tools::copyToDense
void copyToDense(const GridOrTreeT &sparse, DenseT &dense, bool serial=false)
Populate a dense grid with the values of voxels from a sparse grid, where the sparse grid intersects ...
Definition Dense.h:421
openvdb::v10_0::tree
Definition PointDataGrid.h:169
openvdb::v10_0::util::formattedInt
FormattedInt< IntT > formattedInt(IntT n)
Definition Formats.h:118
openvdb::v10_0::util::printBytes
OPENVDB_API int printBytes(std::ostream &os, uint64_t bytes, const std::string &head="", const std::string &tail="\n", bool exact=false, int width=8, int precision=3)
openvdb::v10_0::zeroVal
T zeroVal()
Return the value of type T that corresponds to zero.
Definition Math.h:70
openvdb::v10_0::Index64
uint64_t Index64
Definition Types.h:53
openvdb::v10_0::SharedPtr
std::shared_ptr< T > SharedPtr
Definition Types.h:114
openvdb
Definition Exceptions.h:13
Exceptions.h
OPENVDB_THROW
#define OPENVDB_THROW(exception, message)
Definition Exceptions.h:74
Types.h
openvdb::v10_0::TreeAdapter
This adapter allows code that is templated on a Tree type to accept either a Tree type or a Grid type...
Definition Grid.h:1060
OPENVDB_VERSION_NAME
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition version.h.in:121
OPENVDB_USE_VERSION_NAMESPACE
#define OPENVDB_USE_VERSION_NAMESPACE
Definition version.h.in:212