Loading...
Searching...
No Matches
LevelSetTracker.h
Go to the documentation of this file.
// Copyright Contributors to the OpenVDB Project
// SPDX-License-Identifier: MPL-2.0
/// @author Ken Museth
///
/// @file tools/LevelSetTracker.h
///
/// @brief Performs multi-threaded interface tracking of narrow band
/// level sets. This is the building-block for most level set
/// computations that involve dynamic topology, e.g. advection.
#ifndef OPENVDB_TOOLS_LEVEL_SET_TRACKER_HAS_BEEN_INCLUDED
#define OPENVDB_TOOLS_LEVEL_SET_TRACKER_HAS_BEEN_INCLUDED
#include <openvdb/Types.h>
#include <openvdb/Grid.h>
#include <openvdb/math/Math.h>
#include <openvdb/math/FiniteDifference.h>
#include <openvdb/math/Operators.h>
#include <openvdb/math/Stencils.h>
#include <openvdb/math/Transform.h>
#include <openvdb/util/NullInterrupter.h>
#include <openvdb/thread/Threading.h>
#include <openvdb/tree/ValueAccessor.h>
#include <openvdb/tree/LeafManager.h>
#include "ChangeBackground.h"// for changeLevelSetBackground
#include "Morphology.h"//for dilateActiveValues
#include "Prune.h"// for pruneLevelSet
#include <tbb/parallel_for.h>
#include <functional>
#include <type_traits>
namespace openvdb {
OPENVDB_USE_VERSION_NAMESPACE
namespace OPENVDB_VERSION_NAME {
namespace tools {
namespace lstrack {
/// @brief How to handle voxels that fall outside the narrow band
/// @sa @link LevelSetTracker::trimming() trimming@endlink,
/// @link LevelSetTracker::setTrimming() setTrimming@endlink
enum class TrimMode {
kNone, ///< Leave out-of-band voxels intact
kInterior, ///< Set out-of-band interior voxels to the background value
kExterior, ///< Set out-of-band exterior voxels to the background value
kAll ///< Set all out-of-band voxels to the background value
};
} // namespace lstrack
/// @brief Performs multi-threaded interface tracking of narrow band level sets
template<typename GridT, typename InterruptT = util::NullInterrupter>
class LevelSetTracker
{
public:
using TrimMode = lstrack::TrimMode;
using GridType = GridT;
using TreeType = typename GridT::TreeType;
using LeafType = typename TreeType::LeafNodeType;
using ValueType = typename TreeType::ValueType;
using LeafManagerType = typename tree::LeafManager<TreeType>; // leafs + buffers
using LeafRange = typename LeafManagerType::LeafRange;
using BufferType = typename LeafManagerType::BufferType;
using MaskTreeType = typename TreeType::template ValueConverter<ValueMask>::Type;
static_assert(std::is_floating_point<ValueType>::value,
"LevelSetTracker requires a level set grid with floating-point values");
/// Lightweight struct that stores the state of the LevelSetTracker
struct State {
State(math::BiasedGradientScheme s = math::HJWENO5_BIAS,
math::TemporalIntegrationScheme t = math::TVD_RK1,
int n = static_cast<int>(LEVEL_SET_HALF_WIDTH), int g = 1)
: spatialScheme(s), temporalScheme(t), normCount(n), grainSize(g) {}
math::BiasedGradientScheme spatialScheme;
math::TemporalIntegrationScheme temporalScheme;
int normCount;// Number of iterations of normalization
int grainSize;
};
/// @brief Main constructor
/// @throw RuntimeError if the grid is not a level set
LevelSetTracker(GridT& grid, InterruptT* interrupt = nullptr);
virtual ~LevelSetTracker() { delete mLeafs; }
/// @brief Iterative normalization, i.e. solving the Eikonal equation
/// @note The mask it optional and by default it is ignored.
template <typename MaskType>
void normalize(const MaskType* mask);
/// @brief Iterative normalization, i.e. solving the Eikonal equation
void normalize() { this->normalize<MaskTreeType>(nullptr); }
/// @brief Track the level set interface, i.e. rebuild and normalize the
/// narrow band of the level set.
void track();
/// @brief Set voxels that are outside the narrow band to the background value
/// (if trimming is enabled) and prune the grid.
/// @details Pruning is done automatically as a step in tracking.
/// @sa @link setTrimming() setTrimming@endlink, @link trimming() trimming@endlink
void prune();
/// @brief Fast but approximate dilation of the narrow band - one
/// layer at a time. Normally we recommend using the resize method below
/// which internally calls dilate (or erode) with the correct
/// number of @a iterations to achieve the desired half voxel width
/// of the narrow band (3 is recommended for most level set applications).
///
/// @note Since many level set applications perform
/// interface-tracking, which in turn rebuilds the narrow-band
/// accurately, this dilate method can often be used with a
/// single iterations of low-order re-normalization. This
/// effectively allows very narrow bands to be created from points
/// or polygons (e.g. with a half voxel width of 1), followed by a
/// fast but approximate dilation (typically with a half voxel
/// width of 3). This can be significantly faster than generating
/// the final width of the narrow band from points or polygons.
void dilate(int iterations = 1);
/// @brief Erodes the width of the narrow-band and update the background values
/// @throw ValueError if @a iterations is larger than the current half-width.
void erode(int iterations = 1);
/// @brief Resize the width of the narrow band, i.e. perform
/// dilation and renormalization or erosion as required.
bool resize(Index halfWidth = static_cast< Index >(LEVEL_SET_HALF_WIDTH));
/// @brief Return the half width of the narrow band in floating-point voxel units.
ValueType getHalfWidth() const { return mGrid->background()/mDx; }
/// @brief Return the state of the tracker (see struct defined above)
State getState() const { return mState; }
/// @brief Set the state of the tracker (see struct defined above)
void setState(const State& s) { mState = s; }
/// @return the spatial finite difference scheme
math::BiasedGradientScheme getSpatialScheme() const { return mState.spatialScheme; }
/// @brief Set the spatial finite difference scheme
void setSpatialScheme(math::BiasedGradientScheme s) { mState.spatialScheme = s; }
/// @return the temporal integration scheme
math::TemporalIntegrationScheme getTemporalScheme() const { return mState.temporalScheme; }
/// @brief Set the spatial finite difference scheme
void setTemporalScheme(math::TemporalIntegrationScheme s) { mState.temporalScheme = s;}
/// @return The number of normalizations performed per track or
/// normalize call.
int getNormCount() const { return mState.normCount; }
/// @brief Set the number of normalizations performed per track or
/// normalize call.
void setNormCount(int n) { mState.normCount = n; }
/// @return the grain-size used for multi-threading
int getGrainSize() const { return mState.grainSize; }
/// @brief Set the grain-size used for multi-threading.
/// @note A grainsize of 0 or less disables multi-threading!
void setGrainSize(int grainsize) { mState.grainSize = grainsize; }
/// @brief Return the trimming mode for voxels outside the narrow band.
/// @details Trimming is enabled by default and is applied automatically prior to pruning.
/// @sa @link setTrimming() setTrimming@endlink, @link prune() prune@endlink
TrimMode trimming() const { return mTrimMode; }
/// @brief Specify whether to trim voxels outside the narrow band prior to pruning.
/// @sa @link trimming() trimming@endlink, @link prune() prune@endlink
void setTrimming(TrimMode mode) { mTrimMode = mode; }
ValueType voxelSize() const { return mDx; }
void startInterrupter(const char* msg);
void endInterrupter();
/// @return false if the process was interrupted
bool checkInterrupter();
const GridType& grid() const { return *mGrid; }
LeafManagerType& leafs() { return *mLeafs; }
const LeafManagerType& leafs() const { return *mLeafs; }
private:
// disallow copy construction and copy by assignment!
LevelSetTracker(const LevelSetTracker&);// not implemented
LevelSetTracker& operator=(const LevelSetTracker&);// not implemented
// Private class to perform multi-threaded trimming of
// voxels that are too far away from the zero-crossing.
template<TrimMode Trimming>
struct Trim
{
Trim(LevelSetTracker& tracker) : mTracker(tracker) {}
void trim();
void operator()(const LeafRange& r) const;
LevelSetTracker& mTracker;
};// Trim
// Private struct to perform multi-threaded normalization
template<math::BiasedGradientScheme SpatialScheme,
math::TemporalIntegrationScheme TemporalScheme,
typename MaskT>
struct Normalizer
{
using SchemeT = math::BIAS_SCHEME<SpatialScheme>;
using StencilT = typename SchemeT::template ISStencil<GridType>::StencilType;
using MaskLeafT = typename MaskT::LeafNodeType;
using MaskIterT = typename MaskLeafT::ValueOnCIter;
using VoxelIterT = typename LeafType::ValueOnCIter;
Normalizer(LevelSetTracker& tracker, const MaskT* mask);
void normalize();
void operator()(const LeafRange& r) const {mTask(const_cast<Normalizer*>(this), r);}
void cook(const char* msg, int swapBuffer=0);
template <int Nominator, int Denominator>
void euler(const LeafRange& range, Index phiBuffer, Index resultBuffer);
inline void euler01(const LeafRange& r) {this->euler<0,1>(r, 0, 1);}
inline void euler12(const LeafRange& r) {this->euler<1,2>(r, 1, 1);}
inline void euler34(const LeafRange& r) {this->euler<3,4>(r, 1, 2);}
inline void euler13(const LeafRange& r) {this->euler<1,3>(r, 1, 2);}
template <int Nominator, int Denominator>
void eval(StencilT& stencil, const ValueType* phi, ValueType* result, Index n) const;
LevelSetTracker& mTracker;
const MaskT* mMask;
const ValueType mDt, mInvDx;
typename std::function<void (Normalizer*, const LeafRange&)> mTask;
}; // Normalizer struct
template<math::BiasedGradientScheme SpatialScheme, typename MaskT>
void normalize1(const MaskT* mask);
template<math::BiasedGradientScheme SpatialScheme,
math::TemporalIntegrationScheme TemporalScheme, typename MaskT>
void normalize2(const MaskT* mask);
// Throughout the methods below mLeafs is always assumed to contain
// a list of the current LeafNodes! The auxiliary buffers on the
// other hand always have to be allocated locally, since some
// methods need them and others don't!
GridType* mGrid;
LeafManagerType* mLeafs;
InterruptT* mInterrupter;
const ValueType mDx;
State mState;
TrimMode mTrimMode = TrimMode::kAll;
}; // end of LevelSetTracker class
template<typename GridT, typename InterruptT>
LevelSetTracker<GridT, InterruptT>::
LevelSetTracker(GridT& grid, InterruptT* interrupt):
mGrid(&grid),
mLeafs(new LeafManagerType(grid.tree())),
mInterrupter(interrupt),
mDx(static_cast<ValueType>(grid.voxelSize()[0])),
mState()
{
if ( !grid.hasUniformVoxels() ) {
OPENVDB_THROW(RuntimeError,
"The transform must have uniform scale for the LevelSetTracker to function");
}
if ( grid.getGridClass() != GRID_LEVEL_SET) {
OPENVDB_THROW(RuntimeError,
"LevelSetTracker expected a level set, got a grid of class \""
+ grid.gridClassToString(grid.getGridClass())
+ "\" [hint: Grid::setGridClass(openvdb::GRID_LEVEL_SET)]");
}
}
template<typename GridT, typename InterruptT>
void
LevelSetTracker<GridT, InterruptT>::
prune()
{
this->startInterrupter("Pruning Level Set");
// Set voxels that are too far away from the zero crossing to the background value.
switch (mTrimMode) {
case TrimMode::kNone: break;
case TrimMode::kInterior: Trim<TrimMode::kInterior>(*this).trim(); break;
case TrimMode::kExterior: Trim<TrimMode::kExterior>(*this).trim(); break;
case TrimMode::kAll: Trim<TrimMode::kAll>(*this).trim(); break;
}
// Remove inactive nodes from tree
tools::pruneLevelSet(mGrid->tree());
// The tree topology has changes so rebuild the list of leafs
mLeafs->rebuildLeafArray();
this->endInterrupter();
}
template<typename GridT, typename InterruptT>
void
LevelSetTracker<GridT, InterruptT>::
track()
{
// Dilate narrow-band (this also rebuilds the leaf array!)
tools::dilateActiveValues( *mLeafs, 1, tools::NN_FACE, tools::IGNORE_TILES);
// Compute signed distances in dilated narrow-band
this->normalize();
// Remove voxels that are outside the narrow band
this->prune();
}
template<typename GridT, typename InterruptT>
void
LevelSetTracker<GridT, InterruptT>::
dilate(int iterations)
{
if (this->getNormCount() == 0) {
for (int i=0; i < iterations; ++i) {
tools::dilateActiveValues( *mLeafs, 1, tools::NN_FACE, tools::IGNORE_TILES);
tools::changeLevelSetBackground(this->leafs(), mDx + mGrid->background());
}
} else {
for (int i=0; i < iterations; ++i) {
MaskTreeType mask0(mGrid->tree(), false, TopologyCopy());
tools::dilateActiveValues( *mLeafs, 1, tools::NN_FACE, tools::IGNORE_TILES);
tools::changeLevelSetBackground(this->leafs(), mDx + mGrid->background());
MaskTreeType mask(mGrid->tree(), false, TopologyCopy());
mask.topologyDifference(mask0);
this->normalize(&mask);
}
}
}
template<typename GridT, typename InterruptT>
void
LevelSetTracker<GridT, InterruptT>::
erode(int iterations)
{
tools::erodeActiveValues(*mLeafs, iterations, tools::NN_FACE, tools::IGNORE_TILES);
tools::pruneLevelSet(mLeafs->tree());
mLeafs->rebuildLeafArray();
const ValueType background = mGrid->background() - ValueType(iterations) * mDx;
tools::changeLevelSetBackground(this->leafs(), background);
}
template<typename GridT, typename InterruptT>
bool
LevelSetTracker<GridT, InterruptT>::
resize(Index halfWidth)
{
const int wOld = static_cast<int>(math::RoundDown(this->getHalfWidth()));
const int wNew = static_cast<int>(halfWidth);
if (wOld < wNew) {
this->dilate(wNew - wOld);
} else if (wOld > wNew) {
this->erode(wOld - wNew);
}
return wOld != wNew;
}
template<typename GridT, typename InterruptT>
inline void
LevelSetTracker<GridT, InterruptT>::
startInterrupter(const char* msg)
{
if (mInterrupter) mInterrupter->start(msg);
}
template<typename GridT, typename InterruptT>
inline void
LevelSetTracker<GridT, InterruptT>::
endInterrupter()
{
if (mInterrupter) mInterrupter->end();
}
template<typename GridT, typename InterruptT>
inline bool
LevelSetTracker<GridT, InterruptT>::
checkInterrupter()
{
if (util::wasInterrupted(mInterrupter)) {
thread::cancelGroupExecution();
return false;
}
return true;
}
template<typename GridT, typename InterruptT>
template<typename MaskT>
void
LevelSetTracker<GridT, InterruptT>::
normalize(const MaskT* mask)
{
switch (this->getSpatialScheme()) {
case math::FIRST_BIAS:
this->normalize1<math::FIRST_BIAS , MaskT>(mask); break;
case math::SECOND_BIAS:
this->normalize1<math::SECOND_BIAS, MaskT>(mask); break;
case math::THIRD_BIAS:
this->normalize1<math::THIRD_BIAS, MaskT>(mask); break;
case math::WENO5_BIAS:
this->normalize1<math::WENO5_BIAS, MaskT>(mask); break;
case math::HJWENO5_BIAS:
this->normalize1<math::HJWENO5_BIAS, MaskT>(mask); break;
case math::UNKNOWN_BIAS:
default:
OPENVDB_THROW(ValueError, "Spatial difference scheme not supported!");
}
}
template<typename GridT, typename InterruptT>
template<math::BiasedGradientScheme SpatialScheme, typename MaskT>
void
LevelSetTracker<GridT, InterruptT>::
normalize1(const MaskT* mask)
{
switch (this->getTemporalScheme()) {
case math::TVD_RK1:
this->normalize2<SpatialScheme, math::TVD_RK1, MaskT>(mask); break;
case math::TVD_RK2:
this->normalize2<SpatialScheme, math::TVD_RK2, MaskT>(mask); break;
case math::TVD_RK3:
this->normalize2<SpatialScheme, math::TVD_RK3, MaskT>(mask); break;
case math::UNKNOWN_TIS:
default:
OPENVDB_THROW(ValueError, "Temporal integration scheme not supported!");
}
}
template<typename GridT, typename InterruptT>
template<math::BiasedGradientScheme SpatialScheme,
math::TemporalIntegrationScheme TemporalScheme,
typename MaskT>
void
LevelSetTracker<GridT, InterruptT>::
normalize2(const MaskT* mask)
{
Normalizer<SpatialScheme, TemporalScheme, MaskT> tmp(*this, mask);
tmp.normalize();
}
////////////////////////////////////////////////////////////////////////////
template<typename GridT, typename InterruptT>
template<lstrack::TrimMode Trimming>
void
LevelSetTracker<GridT, InterruptT>::Trim<Trimming>::trim()
{
OPENVDB_NO_UNREACHABLE_CODE_WARNING_BEGIN
if (Trimming != TrimMode::kNone) {
const int grainSize = mTracker.getGrainSize();
const LeafRange range = mTracker.leafs().leafRange(grainSize);
if (grainSize>0) {
tbb::parallel_for(range, *this);
} else {
(*this)(range);
}
}
OPENVDB_NO_UNREACHABLE_CODE_WARNING_END
}
/// Trim away voxels that have moved outside the narrow band
template<typename GridT, typename InterruptT>
template<lstrack::TrimMode Trimming>
inline void
LevelSetTracker<GridT, InterruptT>::Trim<Trimming>::operator()(const LeafRange& range) const
{
mTracker.checkInterrupter();
const ValueType gamma = mTracker.mGrid->background();
OPENVDB_NO_UNREACHABLE_CODE_WARNING_BEGIN
for (auto leafIter = range.begin(); leafIter; ++leafIter) {
auto& leaf = *leafIter;
for (auto iter = leaf.beginValueOn(); iter; ++iter) {
const auto val = *iter;
switch (Trimming) { // resolved at compile time
case TrimMode::kNone:
break;
case TrimMode::kInterior:
if (val <= -gamma) { leaf.setValueOff(iter.pos(), -gamma); }
break;
case TrimMode::kExterior:
if (val >= gamma) { leaf.setValueOff(iter.pos(), gamma); }
break;
case TrimMode::kAll:
if (val <= -gamma) {
leaf.setValueOff(iter.pos(), -gamma);
} else if (val >= gamma) {
leaf.setValueOff(iter.pos(), gamma);
}
break;
}
}
}
OPENVDB_NO_UNREACHABLE_CODE_WARNING_END
}
////////////////////////////////////////////////////////////////////////////
template<typename GridT, typename InterruptT>
template<math::BiasedGradientScheme SpatialScheme,
math::TemporalIntegrationScheme TemporalScheme,
typename MaskT>
inline
LevelSetTracker<GridT, InterruptT>::
Normalizer<SpatialScheme, TemporalScheme, MaskT>::
Normalizer(LevelSetTracker& tracker, const MaskT* mask)
: mTracker(tracker)
, mMask(mask)
, mDt(tracker.voxelSize()*(TemporalScheme == math::TVD_RK1 ? 0.3f :
TemporalScheme == math::TVD_RK2 ? 0.9f : 1.0f))
, mInvDx(1.0f/tracker.voxelSize())
, mTask(nullptr)
{
}
template<typename GridT, typename InterruptT>
template<math::BiasedGradientScheme SpatialScheme,
math::TemporalIntegrationScheme TemporalScheme,
typename MaskT>
inline void
LevelSetTracker<GridT, InterruptT>::
Normalizer<SpatialScheme, TemporalScheme, MaskT>::
normalize()
{
namespace ph = std::placeholders;
/// Make sure we have enough temporal auxiliary buffers
mTracker.mLeafs->rebuildAuxBuffers(TemporalScheme == math::TVD_RK3 ? 2 : 1);
for (int n=0, e=mTracker.getNormCount(); n < e; ++n) {
OPENVDB_NO_UNREACHABLE_CODE_WARNING_BEGIN
switch(TemporalScheme) {//switch is resolved at compile-time
case math::TVD_RK1:
// Perform one explicit Euler step: t1 = t0 + dt
// Phi_t1(0) = Phi_t0(0) - dt * VdotG_t0(1)
mTask = std::bind(&Normalizer::euler01, ph::_1, ph::_2);
// Cook and swap buffer 0 and 1 such that Phi_t1(0) and Phi_t0(1)
this->cook("Normalizing level set using TVD_RK1", 1);
break;
case math::TVD_RK2:
// Perform one explicit Euler step: t1 = t0 + dt
// Phi_t1(1) = Phi_t0(0) - dt * VdotG_t0(1)
mTask = std::bind(&Normalizer::euler01, ph::_1, ph::_2);
// Cook and swap buffer 0 and 1 such that Phi_t1(0) and Phi_t0(1)
this->cook("Normalizing level set using TVD_RK1 (step 1 of 2)", 1);
// Convex combine explicit Euler step: t2 = t0 + dt
// Phi_t2(1) = 1/2 * Phi_t0(1) + 1/2 * (Phi_t1(0) - dt * V.Grad_t1(0))
mTask = std::bind(&Normalizer::euler12, ph::_1, ph::_2);
// Cook and swap buffer 0 and 1 such that Phi_t2(0) and Phi_t1(1)
this->cook("Normalizing level set using TVD_RK1 (step 2 of 2)", 1);
break;
case math::TVD_RK3:
// Perform one explicit Euler step: t1 = t0 + dt
// Phi_t1(1) = Phi_t0(0) - dt * VdotG_t0(1)
mTask = std::bind(&Normalizer::euler01, ph::_1, ph::_2);
// Cook and swap buffer 0 and 1 such that Phi_t1(0) and Phi_t0(1)
this->cook("Normalizing level set using TVD_RK3 (step 1 of 3)", 1);
// Convex combine explicit Euler step: t2 = t0 + dt/2
// Phi_t2(2) = 3/4 * Phi_t0(1) + 1/4 * (Phi_t1(0) - dt * V.Grad_t1(0))
mTask = std::bind(&Normalizer::euler34, ph::_1, ph::_2);
// Cook and swap buffer 0 and 2 such that Phi_t2(0) and Phi_t1(2)
this->cook("Normalizing level set using TVD_RK3 (step 2 of 3)", 2);
// Convex combine explicit Euler step: t3 = t0 + dt
// Phi_t3(2) = 1/3 * Phi_t0(1) + 2/3 * (Phi_t2(0) - dt * V.Grad_t2(0)
mTask = std::bind(&Normalizer::euler13, ph::_1, ph::_2);
// Cook and swap buffer 0 and 2 such that Phi_t3(0) and Phi_t2(2)
this->cook("Normalizing level set using TVD_RK3 (step 3 of 3)", 2);
break;
case math::UNKNOWN_TIS:
default:
OPENVDB_THROW(ValueError, "Temporal integration scheme not supported!");
}
OPENVDB_NO_UNREACHABLE_CODE_WARNING_END
}
mTracker.mLeafs->removeAuxBuffers();
}
/// Private method to perform the task (serial or threaded) and
/// subsequently swap the leaf buffers.
template<typename GridT, typename InterruptT>
template<math::BiasedGradientScheme SpatialScheme,
math::TemporalIntegrationScheme TemporalScheme,
typename MaskT>
inline void
LevelSetTracker<GridT, InterruptT>::
Normalizer<SpatialScheme, TemporalScheme, MaskT>::
cook(const char* msg, int swapBuffer)
{
mTracker.startInterrupter( msg );
const int grainSize = mTracker.getGrainSize();
const LeafRange range = mTracker.leafs().leafRange(grainSize);
grainSize>0 ? tbb::parallel_for(range, *this) : (*this)(range);
mTracker.leafs().swapLeafBuffer(swapBuffer, grainSize==0);
mTracker.endInterrupter();
}
template<typename GridT, typename InterruptT>
template<math::BiasedGradientScheme SpatialScheme,
math::TemporalIntegrationScheme TemporalScheme,
typename MaskT>
template <int Nominator, int Denominator>
inline void
LevelSetTracker<GridT, InterruptT>::
Normalizer<SpatialScheme, TemporalScheme, MaskT>::
eval(StencilT& stencil, const ValueType* phi, ValueType* result, Index n) const
{
using GradientT = typename math::ISGradientNormSqrd<SpatialScheme>;
static const ValueType alpha = ValueType(Nominator)/ValueType(Denominator);
static const ValueType beta = ValueType(1) - alpha;
const ValueType normSqGradPhi = GradientT::result(stencil);
const ValueType phi0 = stencil.getValue();
ValueType v = phi0 / ( math::Sqrt(math::Pow2(phi0) + normSqGradPhi) +
math::Tolerance<ValueType>::value() );
v = phi0 - mDt * v * (math::Sqrt(normSqGradPhi) * mInvDx - 1.0f);
result[n] = Nominator ? alpha * phi[n] + beta * v : v;
}
template<typename GridT, typename InterruptT>
template<math::BiasedGradientScheme SpatialScheme,
math::TemporalIntegrationScheme TemporalScheme,
typename MaskT>
template <int Nominator, int Denominator>
inline void
LevelSetTracker<GridT,InterruptT>::
Normalizer<SpatialScheme, TemporalScheme, MaskT>::
euler(const LeafRange& range, Index phiBuffer, Index resultBuffer)
{
mTracker.checkInterrupter();
StencilT stencil(mTracker.grid());
for (typename LeafRange::Iterator leafIter = range.begin(); leafIter; ++leafIter) {
const ValueType* phi = leafIter.buffer(phiBuffer).data();
ValueType* result = leafIter.buffer(resultBuffer).data();
if (mMask == nullptr) {
for (auto iter = leafIter->cbeginValueOn(); iter; ++iter) {
stencil.moveTo(iter);
this->eval<Nominator, Denominator>(stencil, phi, result, iter.pos());
}//loop over active voxels in the leaf of the level set
} else if (const MaskLeafT* mask = mMask->probeLeaf(leafIter->origin())) {
const ValueType* phi0 = leafIter->buffer().data();
for (MaskIterT iter = mask->cbeginValueOn(); iter; ++iter) {
const Index i = iter.pos();
stencil.moveTo(iter.getCoord(), phi0[i]);
this->eval<Nominator, Denominator>(stencil, phi, result, i);
}//loop over active voxels in the leaf of the mask
}
}//loop over leafs of the level set
}
////////////////////////////////////////
// Explicit Template Instantiation
#ifdef OPENVDB_USE_EXPLICIT_INSTANTIATION
#ifdef OPENVDB_INSTANTIATE_LEVELSETTRACKER
#include <openvdb/util/ExplicitInstantiation.h>
#endif
OPENVDB_INSTANTIATE_CLASS LevelSetTracker<FloatGrid, util::NullInterrupter>;
OPENVDB_INSTANTIATE_CLASS LevelSetTracker<DoubleGrid, util::NullInterrupter>;
#endif // OPENVDB_USE_EXPLICIT_INSTANTIATION
} // namespace tools
} // namespace OPENVDB_VERSION_NAME
} // namespace openvdb
#endif // OPENVDB_TOOLS_LEVEL_SET_TRACKER_HAS_BEEN_INCLUDED
ChangeBackground.h
Efficient multi-threaded replacement of the background values in tree.
OPENVDB_THROW
#define OPENVDB_THROW(exception, message)
Definition Exceptions.h:74
ExplicitInstantiation.h
FiniteDifference.h
Grid.h
LeafManager.h
A LeafManager manages a linear array of pointers to a given tree's leaf nodes, as well as optional au...
Math.h
General-purpose arithmetic and comparison routines, most of which accept arbitrary value types (or at...
Morphology.h
Implementation of morphological dilation and erosion.
NullInterrupter.h
Operators.h
OPENVDB_NO_UNREACHABLE_CODE_WARNING_END
#define OPENVDB_NO_UNREACHABLE_CODE_WARNING_END
Definition Platform.h:141
OPENVDB_NO_UNREACHABLE_CODE_WARNING_BEGIN
#define OPENVDB_NO_UNREACHABLE_CODE_WARNING_BEGIN
Definition Platform.h:140
Prune.h
Defined various multi-threaded utility functions for trees.
Transform.h
Types.h
ValueAccessor.h
ValueAccessors are designed to help accelerate accesses into the OpenVDB Tree structures by storing c...
openvdb::v11_0::RuntimeError
Definition Exceptions.h:63
openvdb::v11_0::TopologyCopy
Tag dispatch class that distinguishes topology copy constructors from deep copy constructors.
Definition Types.h:683
openvdb::v11_0::ValueError
Definition Exceptions.h:65
openvdb::v11_0::tools::LevelSetTracker
Performs multi-threaded interface tracking of narrow band level sets.
Definition LevelSetTracker.h:58
openvdb::v11_0::tools::LevelSetTracker::checkInterrupter
bool checkInterrupter()
Definition LevelSetTracker.h:385
openvdb::v11_0::tools::LevelSetTracker::getHalfWidth
ValueType getHalfWidth() const
Return the half width of the narrow band in floating-point voxel units.
Definition LevelSetTracker.h:135
openvdb::v11_0::tools::LevelSetTracker::ValueType
typename TreeType::ValueType ValueType
Definition LevelSetTracker.h:65
openvdb::v11_0::tools::LevelSetTracker::setTemporalScheme
void setTemporalScheme(math::TemporalIntegrationScheme s)
Set the spatial finite difference scheme.
Definition LevelSetTracker.h:153
openvdb::v11_0::tools::LevelSetTracker::voxelSize
ValueType voxelSize() const
Definition LevelSetTracker.h:178
openvdb::v11_0::tools::LevelSetTracker::erode
void erode(int iterations=1)
Erodes the width of the narrow-band and update the background values.
Definition LevelSetTracker.h:342
openvdb::v11_0::tools::LevelSetTracker::leafs
const LeafManagerType & leafs() const
Definition LevelSetTracker.h:191
openvdb::v11_0::tools::LevelSetTracker::setState
void setState(const State &s)
Set the state of the tracker (see struct defined above)
Definition LevelSetTracker.h:141
openvdb::v11_0::tools::LevelSetTracker::LevelSetTracker
LevelSetTracker(GridT &grid, InterruptT *interrupt=nullptr)
Main constructor.
Definition LevelSetTracker.h:260
openvdb::v11_0::tools::LevelSetTracker::getTemporalScheme
math::TemporalIntegrationScheme getTemporalScheme() const
Definition LevelSetTracker.h:150
openvdb::v11_0::tools::LevelSetTracker::LeafManagerType
typename tree::LeafManager< TreeType > LeafManagerType
Definition LevelSetTracker.h:66
openvdb::v11_0::tools::LevelSetTracker::prune
void prune()
Set voxels that are outside the narrow band to the background value (if trimming is enabled) and prun...
Definition LevelSetTracker.h:282
openvdb::v11_0::tools::LevelSetTracker::getSpatialScheme
math::BiasedGradientScheme getSpatialScheme() const
Definition LevelSetTracker.h:144
openvdb::v11_0::tools::LevelSetTracker::endInterrupter
void endInterrupter()
Definition LevelSetTracker.h:377
openvdb::v11_0::tools::LevelSetTracker::normalize
void normalize(const MaskType *mask)
Iterative normalization, i.e. solving the Eikonal equation.
openvdb::v11_0::tools::LevelSetTracker::setGrainSize
void setGrainSize(int grainsize)
Set the grain-size used for multi-threading.
Definition LevelSetTracker.h:168
openvdb::v11_0::tools::LevelSetTracker::setSpatialScheme
void setSpatialScheme(math::BiasedGradientScheme s)
Set the spatial finite difference scheme.
Definition LevelSetTracker.h:147
openvdb::v11_0::tools::LevelSetTracker::trimming
TrimMode trimming() const
Return the trimming mode for voxels outside the narrow band.
Definition LevelSetTracker.h:173
openvdb::v11_0::tools::LevelSetTracker::getGrainSize
int getGrainSize() const
Definition LevelSetTracker.h:164
openvdb::v11_0::tools::LevelSetTracker::setNormCount
void setNormCount(int n)
Set the number of normalizations performed per track or normalize call.
Definition LevelSetTracker.h:161
openvdb::v11_0::tools::LevelSetTracker::getState
State getState() const
Return the state of the tracker (see struct defined above)
Definition LevelSetTracker.h:138
openvdb::v11_0::tools::LevelSetTracker::startInterrupter
void startInterrupter(const char *msg)
Definition LevelSetTracker.h:369
openvdb::v11_0::tools::LevelSetTracker::MaskTreeType
typename TreeType::template ValueConverter< ValueMask >::Type MaskTreeType
Definition LevelSetTracker.h:69
openvdb::v11_0::tools::LevelSetTracker::LeafRange
typename LeafManagerType::LeafRange LeafRange
Definition LevelSetTracker.h:67
openvdb::v11_0::tools::LevelSetTracker::TreeType
typename GridT::TreeType TreeType
Definition LevelSetTracker.h:63
openvdb::v11_0::tools::LevelSetTracker::resize
bool resize(Index halfWidth=static_cast< Index >(LEVEL_SET_HALF_WIDTH))
Resize the width of the narrow band, i.e. perform dilation and renormalization or erosion as required...
Definition LevelSetTracker.h:354
openvdb::v11_0::tools::LevelSetTracker::BufferType
typename LeafManagerType::BufferType BufferType
Definition LevelSetTracker.h:68
openvdb::v11_0::tools::LevelSetTracker::grid
const GridType & grid() const
Definition LevelSetTracker.h:187
openvdb::v11_0::tools::LevelSetTracker::setTrimming
void setTrimming(TrimMode mode)
Specify whether to trim voxels outside the narrow band prior to pruning.
Definition LevelSetTracker.h:176
openvdb::v11_0::tools::LevelSetTracker::normalize
void normalize()
Iterative normalization, i.e. solving the Eikonal equation.
Definition LevelSetTracker.h:97
openvdb::v11_0::tools::LevelSetTracker::leafs
LeafManagerType & leafs()
Definition LevelSetTracker.h:189
openvdb::v11_0::tools::LevelSetTracker::dilate
void dilate(int iterations=1)
Fast but approximate dilation of the narrow band - one layer at a time. Normally we recommend using t...
Definition LevelSetTracker.h:320
openvdb::v11_0::tools::LevelSetTracker::LeafType
typename TreeType::LeafNodeType LeafType
Definition LevelSetTracker.h:64
openvdb::v11_0::tools::LevelSetTracker::GridType
GridT GridType
Definition LevelSetTracker.h:62
openvdb::v11_0::tools::LevelSetTracker::getNormCount
int getNormCount() const
Definition LevelSetTracker.h:157
openvdb::v11_0::tools::LevelSetTracker::~LevelSetTracker
virtual ~LevelSetTracker()
Definition LevelSetTracker.h:89
openvdb::v11_0::tools::LevelSetTracker::track
void track()
Track the level set interface, i.e. rebuild and normalize the narrow band of the level set.
Definition LevelSetTracker.h:305
openvdb::v11_0::tree::LeafManager
This class manages a linear array of pointers to a given tree's leaf nodes, as well as optional auxil...
Definition LeafManager.h:85
nanovdb::GridType
GridType
List of types that are currently supported by NanoVDB.
Definition NanoVDB.h:317
openvdb::v11_0::math::TemporalIntegrationScheme
TemporalIntegrationScheme
Temporal integration schemes.
Definition FiniteDifference.h:233
openvdb::v11_0::math::TVD_RK1
@ TVD_RK1
Definition FiniteDifference.h:235
openvdb::v11_0::math::UNKNOWN_TIS
@ UNKNOWN_TIS
Definition FiniteDifference.h:234
openvdb::v11_0::math::TVD_RK2
@ TVD_RK2
Definition FiniteDifference.h:236
openvdb::v11_0::math::TVD_RK3
@ TVD_RK3
Definition FiniteDifference.h:237
openvdb::v11_0::math::Sqrt
float Sqrt(float x)
Return the square root of a floating-point value.
Definition Math.h:761
openvdb::v11_0::math::BiasedGradientScheme
BiasedGradientScheme
Biased Gradients are limited to non-centered differences.
Definition FiniteDifference.h:164
openvdb::v11_0::math::FIRST_BIAS
@ FIRST_BIAS
Definition FiniteDifference.h:166
openvdb::v11_0::math::THIRD_BIAS
@ THIRD_BIAS
Definition FiniteDifference.h:168
openvdb::v11_0::math::WENO5_BIAS
@ WENO5_BIAS
Definition FiniteDifference.h:169
openvdb::v11_0::math::UNKNOWN_BIAS
@ UNKNOWN_BIAS
Definition FiniteDifference.h:165
openvdb::v11_0::math::SECOND_BIAS
@ SECOND_BIAS
Definition FiniteDifference.h:167
openvdb::v11_0::math::HJWENO5_BIAS
@ HJWENO5_BIAS
Definition FiniteDifference.h:170
openvdb::v11_0::math::RoundDown
float RoundDown(float x)
Return x rounded down to the nearest integer.
Definition Math.h:803
openvdb::v11_0::math::Pow2
Type Pow2(Type x)
Return x2.
Definition Math.h:548
openvdb::v11_0::points::index::State
State
Definition IndexIterator.h:40
openvdb::v11_0::tools::lstrack::TrimMode
TrimMode
How to handle voxels that fall outside the narrow band.
Definition LevelSetTracker.h:45
openvdb::v11_0::tools::lstrack::TrimMode::kInterior
@ kInterior
Set out-of-band interior voxels to the background value.
openvdb::v11_0::tools::lstrack::TrimMode::kAll
@ kAll
Set all out-of-band voxels to the background value.
openvdb::v11_0::tools::lstrack::TrimMode::kNone
@ kNone
Leave out-of-band voxels intact.
openvdb::v11_0::tools::lstrack::TrimMode::kExterior
@ kExterior
Set out-of-band exterior voxels to the background value.
openvdb::v11_0::tools::NN_FACE
@ NN_FACE
Definition Morphology.h:59
openvdb::v11_0::tools::pruneLevelSet
void pruneLevelSet(TreeT &tree, bool threaded=true, size_t grainSize=1)
Reduce the memory footprint of a tree by replacing nodes whose values are all inactive with inactive ...
Definition Prune.h:390
openvdb::v11_0::tools::erodeActiveValues
void erodeActiveValues(TreeOrLeafManagerT &tree, const int iterations=1, const NearestNeighbors nn=NN_FACE, const TilePolicy mode=PRESERVE_TILES, const bool threaded=true)
Topologically erode all active values (i.e. both voxels and tiles) in a tree using one of three neare...
Definition Morphology.h:1133
openvdb::v11_0::tools::dilateActiveValues
void dilateActiveValues(TreeOrLeafManagerT &tree, const int iterations=1, const NearestNeighbors nn=NN_FACE, const TilePolicy mode=PRESERVE_TILES, const bool threaded=true)
Topologically dilate all active values (i.e. both voxels and tiles) in a tree using one of three near...
Definition Morphology.h:1056
openvdb::v11_0::tools::prune
void prune(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 nodes whose values are all the same...
Definition Prune.h:335
openvdb::v11_0::tools::IGNORE_TILES
@ IGNORE_TILES
Definition Morphology.h:81
openvdb::v11_0::tools::changeLevelSetBackground
void changeLevelSetBackground(TreeOrLeafManagerT &tree, const typename TreeOrLeafManagerT::ValueType &halfWidth, bool threaded=true, size_t grainSize=32)
Replace the background value in all the nodes of a floating-point tree containing a symmetric narrow-...
Definition ChangeBackground.h:234
openvdb::v11_0::tools::normalize
GridType::Ptr normalize(const GridType &grid, bool threaded, InterruptT *interrupt)
Normalize the vectors of the given vector-valued grid.
Definition GridOperators.h:1069
openvdb::v11_0::util::wasInterrupted
bool wasInterrupted(T *i, int percent=-1)
Definition NullInterrupter.h:49
openvdb::v11_0::Index
Index32 Index
Definition Types.h:54
openvdb::v11_0::GRID_LEVEL_SET
@ GRID_LEVEL_SET
Definition Types.h:455
openvdb
Definition Exceptions.h:13
Stencils.h
Defines various finite difference stencils by means of the "curiously recurring template pattern" on ...
openvdb::v11_0::math::BIAS_SCHEME
Definition Operators.h:129
openvdb::v11_0::math::Tolerance::value
static T value()
Definition Math.h:148
openvdb::v11_0::tools::LevelSetTracker::State
Lightweight struct that stores the state of the LevelSetTracker.
Definition LevelSetTracker.h:74
openvdb::v11_0::tools::LevelSetTracker::State::spatialScheme
math::BiasedGradientScheme spatialScheme
Definition LevelSetTracker.h:79
openvdb::v11_0::tools::LevelSetTracker::State::grainSize
int grainSize
Definition LevelSetTracker.h:82
openvdb::v11_0::tools::LevelSetTracker::State::temporalScheme
math::TemporalIntegrationScheme temporalScheme
Definition LevelSetTracker.h:80
openvdb::v11_0::tools::LevelSetTracker::State::normCount
int normCount
Definition LevelSetTracker.h:81
openvdb::v11_0::tools::LevelSetTracker::State::State
State(math::BiasedGradientScheme s=math::HJWENO5_BIAS, math::TemporalIntegrationScheme t=math::TVD_RK1, int n=static_cast< int >(LEVEL_SET_HALF_WIDTH), int g=1)
Definition LevelSetTracker.h:75
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
OPENVDB_INSTANTIATE_CLASS
#define OPENVDB_INSTANTIATE_CLASS
Definition version.h.in:153