12 #ifndef OPENVDB_TOOLS_LEVEL_SET_TRACKER_HAS_BEEN_INCLUDED
13 #define OPENVDB_TOOLS_LEVEL_SET_TRACKER_HAS_BEEN_INCLUDED
15 #include <tbb/parallel_for.h>
30 #include <type_traits>
54 template<
typename Gr
idT,
typename InterruptT = util::NullInterrupter>
62 using LeafType =
typename TreeType::LeafNodeType;
65 using LeafRange =
typename LeafManagerType::LeafRange;
67 using MaskTreeType =
typename TreeType::template ValueConverter<ValueMask>::Type;
68 static_assert(std::is_floating_point<ValueType>::value,
69 "LevelSetTracker requires a level set grid with floating-point values");
76 : spatialScheme(s), temporalScheme(t), normCount(n), grainSize(g) {}
91 template <
typename MaskType>
95 void normalize() { this->normalize<MaskTreeType>(
nullptr); }
198 template<TrimMode Trimming>
203 void operator()(
const LeafRange& r)
const;
204 LevelSetTracker& mTracker;
214 using StencilT =
typename SchemeT::template ISStencil<GridType>::StencilType;
215 using MaskLeafT =
typename MaskT::LeafNodeType;
216 using MaskIterT =
typename MaskLeafT::ValueOnCIter;
217 using VoxelIterT =
typename LeafType::ValueOnCIter;
219 Normalizer(LevelSetTracker& tracker,
const MaskT* mask);
221 void operator()(
const LeafRange& r)
const {mTask(
const_cast<Normalizer*
>(
this), r);}
222 void cook(
const char* msg,
int swapBuffer=0);
223 template <
int Nominator,
int Denominator>
224 void euler(
const LeafRange& range,
Index phiBuffer,
Index resultBuffer);
225 inline void euler01(
const LeafRange& r) {this->euler<0,1>(r, 0, 1);}
226 inline void euler12(
const LeafRange& r) {this->euler<1,2>(r, 1, 1);}
227 inline void euler34(
const LeafRange& r) {this->euler<3,4>(r, 1, 2);}
228 inline void euler13(
const LeafRange& r) {this->euler<1,3>(r, 1, 2);}
229 template <
int Nominator,
int Denominator>
230 void eval(StencilT& stencil,
const ValueType* phi, ValueType* result,
Index n)
const;
231 LevelSetTracker& mTracker;
233 const ValueType mDt, mInvDx;
234 typename std::function<void (Normalizer*,
const LeafRange&)> mTask;
237 template<math::BiasedGradientScheme SpatialScheme,
typename MaskT>
238 void normalize1(
const MaskT* mask);
242 void normalize2(
const MaskT* mask);
249 LeafManagerType* mLeafs;
250 InterruptT* mInterrupter;
253 TrimMode mTrimMode = TrimMode::kAll;
256 template<
typename Gr
idT,
typename InterruptT>
261 mInterrupter(interrupt),
262 mDx(static_cast<
ValueType>(grid.voxelSize()[0])),
265 if ( !
grid.hasUniformVoxels() ) {
267 "The transform must have uniform scale for the LevelSetTracker to function");
271 "LevelSetTracker expected a level set, got a grid of class \""
272 +
grid.gridClassToString(
grid.getGridClass())
273 +
"\" [hint: Grid::setGridClass(openvdb::GRID_LEVEL_SET)]");
277 template<
typename Gr
idT,
typename InterruptT>
282 this->startInterrupter(
"Pruning Level Set");
286 case TrimMode::kNone:
break;
287 case TrimMode::kInterior: Trim<TrimMode::kInterior>(*this).trim();
break;
288 case TrimMode::kExterior: Trim<TrimMode::kExterior>(*this).trim();
break;
289 case TrimMode::kAll: Trim<TrimMode::kAll>(*this).trim();
break;
296 mLeafs->rebuildLeafArray();
297 this->endInterrupter();
300 template<
typename Gr
idT,
typename InterruptT>
315 template<
typename Gr
idT,
typename InterruptT>
320 if (this->getNormCount() == 0) {
321 for (
int i=0; i < iterations; ++i) {
326 for (
int i=0; i < iterations; ++i) {
331 mask.topologyDifference(mask0);
337 template<
typename Gr
idT,
typename InterruptT>
340 erode(
int iterations)
344 mLeafs->rebuildLeafArray();
349 template<
typename Gr
idT,
typename InterruptT>
354 const int wOld =
static_cast<int>(
math::RoundDown(this->getHalfWidth()));
355 const int wNew =
static_cast<int>(halfWidth);
357 this->dilate(wNew - wOld);
358 }
else if (wOld > wNew) {
359 this->erode(wOld - wNew);
364 template<
typename Gr
idT,
typename InterruptT>
369 if (mInterrupter) mInterrupter->start(msg);
372 template<
typename Gr
idT,
typename InterruptT>
377 if (mInterrupter) mInterrupter->end();
380 template<
typename Gr
idT,
typename InterruptT>
386 tbb::task::self().cancel_group_execution();
392 template<
typename Gr
idT,
typename InterruptT>
393 template<
typename MaskT>
398 switch (this->getSpatialScheme()) {
400 this->normalize1<math::FIRST_BIAS , MaskT>(mask);
break;
402 this->normalize1<math::SECOND_BIAS, MaskT>(mask);
break;
404 this->normalize1<math::THIRD_BIAS, MaskT>(mask);
break;
406 this->normalize1<math::WENO5_BIAS, MaskT>(mask);
break;
408 this->normalize1<math::HJWENO5_BIAS, MaskT>(mask);
break;
415 template<
typename Gr
idT,
typename InterruptT>
416 template<math::BiasedGradientScheme SpatialScheme,
typename MaskT>
421 switch (this->getTemporalScheme()) {
423 this->normalize2<SpatialScheme, math::TVD_RK1, MaskT>(mask);
break;
425 this->normalize2<SpatialScheme, math::TVD_RK2, MaskT>(mask);
break;
427 this->normalize2<SpatialScheme, math::TVD_RK3, MaskT>(mask);
break;
434 template<
typename Gr
idT,
typename InterruptT>
439 LevelSetTracker<GridT, InterruptT>::
440 normalize2(
const MaskT* mask)
442 Normalizer<SpatialScheme, TemporalScheme, MaskT> tmp(*
this, mask);
450 template<
typename Gr
idT,
typename InterruptT>
451 template<lstrack::TrimMode Trimming>
453 LevelSetTracker<GridT, InterruptT>::Trim<Trimming>::trim()
456 if (Trimming != TrimMode::kNone) {
457 const int grainSize = mTracker.getGrainSize();
458 const LeafRange range = mTracker.leafs().leafRange(grainSize);
461 tbb::parallel_for(range, *
this);
471 template<
typename Gr
idT,
typename InterruptT>
472 template<lstrack::TrimMode Trimming>
474 LevelSetTracker<GridT, InterruptT>::Trim<Trimming>::operator()(
const LeafRange& range)
const
476 mTracker.checkInterrupter();
477 const ValueType gamma = mTracker.mGrid->background();
480 for (
auto leafIter = range.begin(); leafIter; ++leafIter) {
481 auto& leaf = *leafIter;
482 for (
auto iter = leaf.beginValueOn(); iter; ++iter) {
483 const auto val = *iter;
485 case TrimMode::kNone:
487 case TrimMode::kInterior:
488 if (val <= -gamma) { leaf.setValueOff(iter.pos(), -gamma); }
490 case TrimMode::kExterior:
491 if (val >= gamma) { leaf.setValueOff(iter.pos(), gamma); }
495 leaf.setValueOff(iter.pos(), -gamma);
496 }
else if (val >= gamma) {
497 leaf.setValueOff(iter.pos(), gamma);
509 template<
typename Gr
idT,
typename InterruptT>
514 LevelSetTracker<GridT, InterruptT>::
515 Normalizer<SpatialScheme, TemporalScheme, MaskT>::
516 Normalizer(LevelSetTracker& tracker,
const MaskT* mask)
519 , mDt(tracker.voxelSize()*(TemporalScheme == math::
TVD_RK1 ? 0.3f :
520 TemporalScheme == math::
TVD_RK2 ? 0.9f : 1.0f))
521 , mInvDx(1.0f/tracker.voxelSize())
526 template<
typename Gr
idT,
typename InterruptT>
535 namespace ph = std::placeholders;
538 mTracker.mLeafs->rebuildAuxBuffers(TemporalScheme ==
math::TVD_RK3 ? 2 : 1);
540 for (
int n=0, e=mTracker.getNormCount(); n < e; ++n) {
543 switch(TemporalScheme) {
547 mTask = std::bind(&Normalizer::euler01, ph::_1, ph::_2);
550 this->cook(
"Normalizing level set using TVD_RK1", 1);
555 mTask = std::bind(&Normalizer::euler01, ph::_1, ph::_2);
558 this->cook(
"Normalizing level set using TVD_RK1 (step 1 of 2)", 1);
562 mTask = std::bind(&Normalizer::euler12, ph::_1, ph::_2);
565 this->cook(
"Normalizing level set using TVD_RK1 (step 2 of 2)", 1);
570 mTask = std::bind(&Normalizer::euler01, ph::_1, ph::_2);
573 this->cook(
"Normalizing level set using TVD_RK3 (step 1 of 3)", 1);
577 mTask = std::bind(&Normalizer::euler34, ph::_1, ph::_2);
580 this->cook(
"Normalizing level set using TVD_RK3 (step 2 of 3)", 2);
584 mTask = std::bind(&Normalizer::euler13, ph::_1, ph::_2);
587 this->cook(
"Normalizing level set using TVD_RK3 (step 3 of 3)", 2);
591 OPENVDB_THROW(ValueError,
"Temporal integration scheme not supported!");
595 mTracker.mLeafs->removeAuxBuffers();
600 template<
typename Gr
idT,
typename InterruptT>
605 LevelSetTracker<GridT, InterruptT>::
606 Normalizer<SpatialScheme, TemporalScheme, MaskT>::
607 cook(
const char* msg,
int swapBuffer)
609 mTracker.startInterrupter( msg );
611 const int grainSize = mTracker.getGrainSize();
612 const LeafRange range = mTracker.leafs().leafRange(grainSize);
614 grainSize>0 ? tbb::parallel_for(range, *
this) : (*this)(range);
616 mTracker.leafs().swapLeafBuffer(swapBuffer, grainSize==0);
618 mTracker.endInterrupter();
621 template<
typename Gr
idT,
typename InterruptT>
625 template <
int Nominator,
int Denominator>
627 LevelSetTracker<GridT, InterruptT>::
628 Normalizer<SpatialScheme, TemporalScheme, MaskT>::
629 eval(StencilT& stencil,
const ValueType* phi, ValueType* result,
Index n)
const
631 using GradientT =
typename math::ISGradientNormSqrd<SpatialScheme>;
632 static const ValueType alpha = ValueType(Nominator)/ValueType(Denominator);
633 static const ValueType beta = ValueType(1) - alpha;
635 const ValueType normSqGradPhi = GradientT::result(stencil);
636 const ValueType phi0 = stencil.getValue();
639 v = phi0 - mDt * v * (
math::Sqrt(normSqGradPhi) * mInvDx - 1.0f);
640 result[n] = Nominator ? alpha * phi[n] + beta * v : v;
643 template<
typename Gr
idT,
typename InterruptT>
647 template <
int Nominator,
int Denominator>
649 LevelSetTracker<GridT,InterruptT>::
650 Normalizer<SpatialScheme, TemporalScheme, MaskT>::
651 euler(
const LeafRange& range,
Index phiBuffer,
Index resultBuffer)
653 mTracker.checkInterrupter();
655 StencilT stencil(mTracker.grid());
657 for (
typename LeafRange::Iterator leafIter = range.begin(); leafIter; ++leafIter) {
658 const ValueType* phi = leafIter.buffer(phiBuffer).data();
659 ValueType* result = leafIter.buffer(resultBuffer).data();
660 if (mMask ==
nullptr) {
661 for (
auto iter = leafIter->cbeginValueOn(); iter; ++iter) {
662 stencil.moveTo(iter);
663 this->eval<Nominator, Denominator>(stencil, phi, result, iter.pos());
665 }
else if (
const MaskLeafT* mask = mMask->probeLeaf(leafIter->origin())) {
666 const ValueType* phi0 = leafIter->buffer().data();
667 for (MaskIterT iter = mask->cbeginValueOn(); iter; ++iter) {
668 const Index i = iter.pos();
669 stencil.moveTo(iter.getCoord(), phi0[i]);
670 this->eval<Nominator, Denominator>(stencil, phi, result, i);
Efficient multi-threaded replacement of the background values in tree.
A LeafManager manages a linear array of pointers to a given tree's leaf nodes, as well as optional au...
General-purpose arithmetic and comparison routines, most of which accept arbitrary value types (or at...
Implementation of morphological dilation and erosion.
Defined various multi-threaded utility functions for trees.
Defines various finite difference stencils by means of the "curiously recurring template pattern" on ...
Definition: openvdb/Exceptions.h:63
Tag dispatch class that distinguishes topology copy constructors from deep copy constructors.
Definition: openvdb/Types.h:560
Definition: openvdb/Exceptions.h:65
TemporalIntegrationScheme
Temporal integration schemes.
Definition: FiniteDifference.h:234
@ TVD_RK1
Definition: FiniteDifference.h:236
@ UNKNOWN_TIS
Definition: FiniteDifference.h:235
@ TVD_RK2
Definition: FiniteDifference.h:237
@ TVD_RK3
Definition: FiniteDifference.h:238
Type Pow2(Type x)
Return x2.
Definition: Math.h:551
float Sqrt(float x)
Return the square root of a floating-point value.
Definition: Math.h:764
float RoundDown(float x)
Return x rounded down to the nearest integer.
Definition: Math.h:806
BiasedGradientScheme
Biased Gradients are limited to non-centered differences.
Definition: FiniteDifference.h:165
@ FIRST_BIAS
Definition: FiniteDifference.h:167
@ THIRD_BIAS
Definition: FiniteDifference.h:169
@ WENO5_BIAS
Definition: FiniteDifference.h:170
@ UNKNOWN_BIAS
Definition: FiniteDifference.h:166
@ SECOND_BIAS
Definition: FiniteDifference.h:168
@ HJWENO5_BIAS
Definition: FiniteDifference.h:171
State
Definition: IndexIterator.h:40
bool wasInterrupted(T *i, int percent=-1)
Definition: NullInterrupter.h:49
static const Real LEVEL_SET_HALF_WIDTH
Definition: openvdb/Types.h:339
Index32 Index
Definition: openvdb/Types.h:50
@ GRID_LEVEL_SET
Definition: openvdb/Types.h:333
Definition: openvdb/Exceptions.h:13
#define OPENVDB_THROW(exception, message)
Definition: openvdb/Exceptions.h:74
Definition: Operators.h:126
static T value()
Definition: Math.h:147
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition: version.h.in:116
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h.in:178