HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
LevelSetTracker.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////
2 //
3 // Copyright (c) 2012-2017 DreamWorks Animation LLC
4 //
5 // All rights reserved. This software is distributed under the
6 // Mozilla Public License 2.0 ( http://www.mozilla.org/MPL/2.0/ )
7 //
8 // Redistributions of source code must retain the above copyright
9 // and license notice and the following restrictions and disclaimer.
10 //
11 // * Neither the name of DreamWorks Animation nor the names of
12 // its contributors may be used to endorse or promote products derived
13 // from this software without specific prior written permission.
14 //
15 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY INDIRECT, INCIDENTAL,
20 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 // IN NO EVENT SHALL THE COPYRIGHT HOLDERS' AND CONTRIBUTORS' AGGREGATE
27 // LIABILITY FOR ALL CLAIMS REGARDLESS OF THEIR BASIS EXCEED US$250.00.
28 //
29 ///////////////////////////////////////////////////////////////////////////
30 
31 /// @author Ken Museth
32 ///
33 /// @file LevelSetTracker.h
34 ///
35 /// @brief Performs multi-threaded interface tracking of narrow band
36 /// level sets. This is the building-block for most level set
37 /// computations that involve dynamic topology, e.g. advection.
38 
39 #ifndef OPENVDB_TOOLS_LEVEL_SET_TRACKER_HAS_BEEN_INCLUDED
40 #define OPENVDB_TOOLS_LEVEL_SET_TRACKER_HAS_BEEN_INCLUDED
41 
42 #include <tbb/parallel_for.h>
43 #include <hboost/bind.hpp>
44 #include <hboost/function.hpp>
45 #include <type_traits>
46 #include <openvdb/Types.h>
47 #include <openvdb/math/Math.h>
49 #include <openvdb/math/Operators.h>
50 #include <openvdb/math/Stencils.h>
51 #include <openvdb/math/Transform.h>
52 #include <openvdb/Grid.h>
56 #include "ChangeBackground.h"// for changeLevelSetBackground
57 #include "Morphology.h"//for dilateActiveValues
58 #include "Prune.h"// for pruneLevelSet
59 
60 namespace openvdb {
62 namespace OPENVDB_VERSION_NAME {
63 namespace tools {
64 
65 /// @brief Performs multi-threaded interface tracking of narrow band level sets
66 template<typename GridT, typename InterruptT = util::NullInterrupter>
68 {
69 public:
70  typedef GridT GridType;
71  typedef typename GridT::TreeType TreeType;
72  typedef typename TreeType::LeafNodeType LeafType;
73  typedef typename TreeType::ValueType ValueType;
74  typedef typename tree::LeafManager<TreeType> LeafManagerType; // leafs + buffers
77  typedef typename TreeType::template ValueConverter<ValueMask>::Type MaskTreeType;
79  "LevelSetTracker requires a level set grid with floating-point values");
80 
81  /// Lightweight struct that stores the state of the LevelSetTracker
82  struct State {
85  int n = static_cast<int>(LEVEL_SET_HALF_WIDTH), int g = 1)
89  int normCount;// Number of iterations of normalization
90  int grainSize;
91  };
92 
93  /// @brief Main constructor
94  /// @throw RuntimeError if the grid is not a level set
95  LevelSetTracker(GridT& grid, InterruptT* interrupt = nullptr);
96 
97  virtual ~LevelSetTracker() { delete mLeafs; }
98 
99  /// @brief Iterative normalization, i.e. solving the Eikonal equation
100  /// @note The mask it optional and by default it is ignored.
101  template <typename MaskType>
102  void normalize(const MaskType* mask);
103 
104  /// @brief Iterative normalization, i.e. solving the Eikonal equation
105  void normalize() { this->normalize<MaskTreeType>(nullptr); }
106 
107  /// @brief Track the level set interface, i.e. rebuild and normalize the
108  /// narrow band of the level set.
109  void track();
110 
111  /// @brief Remove voxels that are outside the narrow band. (substep of track)
112  void prune();
113 
114  /// @brief Fast but approximate dilation of the narrow band - one
115  /// layer at a time. Normally we recommend using the resize method below
116  /// which internally calls dilate (or erode) with the correct
117  /// number of @a iterations to achieve the desired half voxel width
118  /// of the narrow band (3 is recomended for most level set applications).
119  ///
120  /// @note Since many level set applications perform
121  /// interface-tracking, which in turn rebuilds the narrow-band
122  /// accurately, this dilate method can often be used with a
123  /// single iterations of low-order re-normalization. This
124  /// effectively allows very narrow bands to be created from points
125  /// or polygons (e.g. with a half voxel width of 1), followed by a
126  /// fast but approximate dilation (typically with a half voxel
127  /// width of 3). This can be significantly faster than generating
128  /// the final width of the narrow band from points or polygons.
129  void dilate(int iterations = 1);
130 
131  /// @brief Erodes the width of the narrow-band and update the background values
132  /// @throw ValueError if @a iterations is larger than the current half-width.
133  void erode(int iterations = 1);
134 
135  /// @brief Resize the width of the narrow band, i.e. perform
136  /// dilation and renormalization or erosion as required.
137  bool resize(Index halfWidth = static_cast<Index>(LEVEL_SET_HALF_WIDTH));
138 
139  /// @brief Return the half width of the narrow band in floating-point voxel units.
140  ValueType getHalfWidth() const { return mGrid->background()/mDx; }
141 
142  /// @brief Return the state of the tracker (see struct defined above)
143  State getState() const { return mState; }
144 
145  /// @brief Set the state of the tracker (see struct defined above)
146  void setState(const State& s) { mState =s; }
147 
148  /// @return the spatial finite difference scheme
150 
151  /// @brief Set the spatial finite difference scheme
153 
154  /// @return the temporal integration scheme
156 
157  /// @brief Set the spatial finite difference scheme
159 
160  /// @return The number of normalizations performed per track or
161  /// normalize call.
162  int getNormCount() const { return mState.normCount; }
163 
164  /// @brief Set the number of normalizations performed per track or
165  /// normalize call.
166  void setNormCount(int n) { mState.normCount = n; }
167 
168  /// @return the grain-size used for multi-threading
169  int getGrainSize() const { return mState.grainSize; }
170 
171  /// @brief Set the grain-size used for multi-threading.
172  /// @note A grainsize of 0 or less disables multi-threading!
173  void setGrainSize(int grainsize) { mState.grainSize = grainsize; }
174 
175  ValueType voxelSize() const { return mDx; }
176 
177  void startInterrupter(const char* msg);
178 
179  void endInterrupter();
180 
181  /// @return false if the process was interrupted
182  bool checkInterrupter();
183 
184  const GridType& grid() const { return *mGrid; }
185 
186  LeafManagerType& leafs() { return *mLeafs; }
187 
188  const LeafManagerType& leafs() const { return *mLeafs; }
189 
190 private:
191 
192  // disallow copy construction and copy by assignment!
193  LevelSetTracker(const LevelSetTracker&);// not implemented
194  LevelSetTracker& operator=(const LevelSetTracker&);// not implemented
195 
196  // Private class to perform multi-threaded trimming of
197  // voxels that are too far away from the zero-crossing.
198  struct Trim
199  {
200  Trim(LevelSetTracker& tracker) : mTracker(tracker) {}
201  void trim();
202  void operator()(const LeafRange& r) const;
203  LevelSetTracker& mTracker;
204  };// Trim
205 
206  // Private struct to perform multi-threaded normalization
207  template<math::BiasedGradientScheme SpatialScheme,
208  math::TemporalIntegrationScheme TemporalScheme,
209  typename MaskT>
210  struct Normalizer
211  {
212  typedef math::BIAS_SCHEME<SpatialScheme> SchemeT;
213  typedef typename SchemeT::template ISStencil<GridType>::StencilType StencilT;
214  typedef typename MaskT::LeafNodeType MaskLeafT;
215  typedef typename MaskLeafT::ValueOnCIter MaskIterT;
216  typedef typename LeafType::ValueOnCIter VoxelIterT;
217  Normalizer(LevelSetTracker& tracker, const MaskT* mask);
218  void normalize();
219  void operator()(const LeafRange& r) const {mTask(const_cast<Normalizer*>(this), r);}
220  void cook(const char* msg, int swapBuffer=0);
221  template <int Nominator, int Denominator>
222  void euler(const LeafRange& range, Index phiBuffer, Index resultBuffer);
223  inline void euler01(const LeafRange& r) {this->euler<0,1>(r, 0, 1);}
224  inline void euler12(const LeafRange& r) {this->euler<1,2>(r, 1, 1);}
225  inline void euler34(const LeafRange& r) {this->euler<3,4>(r, 1, 2);}
226  inline void euler13(const LeafRange& r) {this->euler<1,3>(r, 1, 2);}
227  template <int Nominator, int Denominator>
228  void eval(StencilT& stencil, const ValueType* phi, ValueType* result, Index n) const;
229  LevelSetTracker& mTracker;
230  const MaskT* mMask;
231  const ValueType mDt, mInvDx;
232  typename hboost::function<void (Normalizer*, const LeafRange&)> mTask;
233  }; // Normalizer struct
234 
235  template<math::BiasedGradientScheme SpatialScheme, typename MaskT>
236  void normalize1(const MaskT* mask);
237 
238  template<math::BiasedGradientScheme SpatialScheme,
239  math::TemporalIntegrationScheme TemporalScheme, typename MaskT>
240  void normalize2(const MaskT* mask);
241 
242  // Throughout the methods below mLeafs is always assumed to contain
243  // a list of the current LeafNodes! The auxiliary buffers on the
244  // other hand always have to be allocated locally, since some
245  // methods need them and others don't!
246  GridType* mGrid;
247  LeafManagerType* mLeafs;
248  InterruptT* mInterrupter;
249  const ValueType mDx;
250  State mState;
251 }; // end of LevelSetTracker class
252 
253 template<typename GridT, typename InterruptT>
255 LevelSetTracker(GridT& grid, InterruptT* interrupt):
256  mGrid(&grid),
257  mLeafs(new LeafManagerType(grid.tree())),
258  mInterrupter(interrupt),
259  mDx(static_cast<ValueType>(grid.voxelSize()[0])),
260  mState()
261 {
262  if ( !grid.hasUniformVoxels() ) {
263  OPENVDB_THROW(RuntimeError,
264  "The transform must have uniform scale for the LevelSetTracker to function");
265  }
266  if ( grid.getGridClass() != GRID_LEVEL_SET) {
267  OPENVDB_THROW(RuntimeError,
268  "LevelSetTracker expected a level set, got a grid of class \""
269  + grid.gridClassToString(grid.getGridClass())
270  + "\" [hint: Grid::setGridClass(openvdb::GRID_LEVEL_SET)]");
271  }
272 }
273 
274 template<typename GridT, typename InterruptT>
275 inline void
278 {
279  this->startInterrupter("Pruning Level Set");
280 
281  // Prune voxels that are too far away from the zero-crossing
282  Trim t(*this);
283  t.trim();
284 
285  // Remove inactive nodes from tree
286  tools::pruneLevelSet(mGrid->tree());
287 
288  // The tree topology has changes so rebuild the list of leafs
289  mLeafs->rebuildLeafArray();
290  this->endInterrupter();
291 }
292 
293 template<typename GridT, typename InterruptT>
294 inline void
297 {
298  // Dilate narrow-band (this also rebuilds the leaf array!)
300 
301  // Compute signed distances in dilated narrow-band
302  this->normalize();
303 
304  // Remove voxels that are outside the narrow band
305  this->prune();
306 }
307 
308 template<typename GridT, typename InterruptT>
309 inline void
311 dilate(int iterations)
312 {
313  if (this->getNormCount() == 0) {
314  for (int i=0; i < iterations; ++i) {
316  tools::changeLevelSetBackground(this->leafs(), mDx + mGrid->background());
317  }
318  } else {
319  for (int i=0; i < iterations; ++i) {
320  MaskTreeType mask0(mGrid->tree(), false, TopologyCopy());
322  tools::changeLevelSetBackground(this->leafs(), mDx + mGrid->background());
323  MaskTreeType mask(mGrid->tree(), false, TopologyCopy());
324  mask.topologyDifference(mask0);
325  this->normalize(&mask);
326  }
327  }
328 }
329 
330 template<typename GridT, typename InterruptT>
331 inline void
333 erode(int iterations)
334 {
335  tools::erodeVoxels(*mLeafs, iterations);
336  mLeafs->rebuildLeafArray();
337  const ValueType background = mGrid->background() - iterations*mDx;
338  tools::changeLevelSetBackground(this->leafs(), background);
339 }
340 
341 template<typename GridT, typename InterruptT>
342 inline bool
344 resize(Index halfWidth)
345 {
346  const int wOld = static_cast<int>(math::RoundDown(this->getHalfWidth()));
347  const int wNew = static_cast<int>(halfWidth);
348  if (wOld < wNew) {
349  this->dilate(wNew - wOld);
350  } else if (wOld > wNew) {
351  this->erode(wOld - wNew);
352  }
353  return wOld != wNew;
354 }
355 
356 template<typename GridT, typename InterruptT>
357 inline void
359 startInterrupter(const char* msg)
360 {
361  if (mInterrupter) mInterrupter->start(msg);
362 }
363 
364 template<typename GridT, typename InterruptT>
365 inline void
368 {
369  if (mInterrupter) mInterrupter->end();
370 }
371 
372 template<typename GridT, typename InterruptT>
373 inline bool
376 {
377  if (util::wasInterrupted(mInterrupter)) {
378  tbb::task::self().cancel_group_execution();
379  return false;
380  }
381  return true;
382 }
383 
384 template<typename GridT, typename InterruptT>
385 template<typename MaskT>
386 inline void
388 normalize(const MaskT* mask)
389 {
390  switch (this->getSpatialScheme()) {
391  case math::FIRST_BIAS:
392  this->normalize1<math::FIRST_BIAS , MaskT>(mask); break;
393  case math::SECOND_BIAS:
394  this->normalize1<math::SECOND_BIAS, MaskT>(mask); break;
395  case math::THIRD_BIAS:
396  this->normalize1<math::THIRD_BIAS, MaskT>(mask); break;
397  case math::WENO5_BIAS:
398  this->normalize1<math::WENO5_BIAS, MaskT>(mask); break;
399  case math::HJWENO5_BIAS:
400  this->normalize1<math::HJWENO5_BIAS, MaskT>(mask); break;
401  case math::UNKNOWN_BIAS:
402  default:
403  OPENVDB_THROW(ValueError, "Spatial difference scheme not supported!");
404  }
405 }
406 
407 template<typename GridT, typename InterruptT>
408 template<math::BiasedGradientScheme SpatialScheme, typename MaskT>
409 inline void
411 normalize1(const MaskT* mask)
412 {
413  switch (this->getTemporalScheme()) {
414  case math::TVD_RK1:
415  this->normalize2<SpatialScheme, math::TVD_RK1, MaskT>(mask); break;
416  case math::TVD_RK2:
417  this->normalize2<SpatialScheme, math::TVD_RK2, MaskT>(mask); break;
418  case math::TVD_RK3:
419  this->normalize2<SpatialScheme, math::TVD_RK3, MaskT>(mask); break;
420  case math::UNKNOWN_TIS:
421  default:
422  OPENVDB_THROW(ValueError, "Temporal integration scheme not supported!");
423  }
424 }
425 
426 template<typename GridT, typename InterruptT>
427 template<math::BiasedGradientScheme SpatialScheme,
428  math::TemporalIntegrationScheme TemporalScheme,
429  typename MaskT>
430 inline void
431 LevelSetTracker<GridT, InterruptT>::
432 normalize2(const MaskT* mask)
433 {
434  Normalizer<SpatialScheme, TemporalScheme, MaskT> tmp(*this, mask);
435  tmp.normalize();
436 }
437 
438 ////////////////////////////////////////////////////////////////////////////
439 
440 template<typename GridT, typename InterruptT>
441 inline void
442 LevelSetTracker<GridT, InterruptT>::
443 Trim::trim()
444 {
445  const int grainSize = mTracker.getGrainSize();
446  const LeafRange range = mTracker.leafs().leafRange(grainSize);
447 
448  if (grainSize>0) {
449  tbb::parallel_for(range, *this);
450  } else {
451  (*this)(range);
452  }
453 }
454 
455 /// Prunes away voxels that have moved outside the narrow band
456 template<typename GridT, typename InterruptT>
457 inline void
458 LevelSetTracker<GridT, InterruptT>::
459 Trim::operator()(const LeafRange& range) const
460 {
461  typedef typename LeafType::ValueOnIter VoxelIterT;
462  mTracker.checkInterrupter();
463  const ValueType gamma = mTracker.mGrid->background();
464 
465  for (typename LeafRange::Iterator leafIter = range.begin(); leafIter; ++leafIter) {
466  LeafType &leaf = *leafIter;
467  for (VoxelIterT iter = leaf.beginValueOn(); iter; ++iter) {
468  const ValueType val = *iter;
469  if (val <= -gamma)
470  leaf.setValueOff(iter.pos(), -gamma);
471  else if (val >= gamma)
472  leaf.setValueOff(iter.pos(), gamma);
473  }
474  }
475 }
476 
477 ////////////////////////////////////////////////////////////////////////////
478 
479 template<typename GridT, typename InterruptT>
480 template<math::BiasedGradientScheme SpatialScheme,
481  math::TemporalIntegrationScheme TemporalScheme,
482  typename MaskT>
483 inline
484 LevelSetTracker<GridT, InterruptT>::
485 Normalizer<SpatialScheme, TemporalScheme, MaskT>::
486 Normalizer(LevelSetTracker& tracker, const MaskT* mask)
487  : mTracker(tracker)
488  , mMask(mask)
489  , mDt(tracker.voxelSize()*(TemporalScheme == math::TVD_RK1 ? 0.3f :
490  TemporalScheme == math::TVD_RK2 ? 0.9f : 1.0f))
491  , mInvDx(1.0f/tracker.voxelSize())
492  , mTask(0)
493 {
494 }
495 
496 template<typename GridT, typename InterruptT>
497 template<math::BiasedGradientScheme SpatialScheme,
498  math::TemporalIntegrationScheme TemporalScheme,
499  typename MaskT>
500 inline void
503 normalize()
504 {
505  /// Make sure we have enough temporal auxiliary buffers
506  mTracker.mLeafs->rebuildAuxBuffers(TemporalScheme == math::TVD_RK3 ? 2 : 1);
507 
508  for (int n=0, e=mTracker.getNormCount(); n < e; ++n) {
509 
511  switch(TemporalScheme) {//switch is resolved at compile-time
512  case math::TVD_RK1:
513  // Perform one explicit Euler step: t1 = t0 + dt
514  // Phi_t1(0) = Phi_t0(0) - dt * VdotG_t0(1)
515  mTask = hboost::bind(&Normalizer::euler01, hboost::placeholders::_1, hboost::placeholders::_2);
516 
517  // Cook and swap buffer 0 and 1 such that Phi_t1(0) and Phi_t0(1)
518  this->cook("Normalizing level set using TVD_RK1", 1);
519  break;
520  case math::TVD_RK2:
521  // Perform one explicit Euler step: t1 = t0 + dt
522  // Phi_t1(1) = Phi_t0(0) - dt * VdotG_t0(1)
523  mTask = hboost::bind(&Normalizer::euler01, hboost::placeholders::_1, hboost::placeholders::_2);
524 
525  // Cook and swap buffer 0 and 1 such that Phi_t1(0) and Phi_t0(1)
526  this->cook("Normalizing level set using TVD_RK1 (step 1 of 2)", 1);
527 
528  // Convex combine explicit Euler step: t2 = t0 + dt
529  // Phi_t2(1) = 1/2 * Phi_t0(1) + 1/2 * (Phi_t1(0) - dt * V.Grad_t1(0))
530  mTask = hboost::bind(&Normalizer::euler12, hboost::placeholders::_1, hboost::placeholders::_2);
531 
532  // Cook and swap buffer 0 and 1 such that Phi_t2(0) and Phi_t1(1)
533  this->cook("Normalizing level set using TVD_RK1 (step 2 of 2)", 1);
534  break;
535  case math::TVD_RK3:
536  // Perform one explicit Euler step: t1 = t0 + dt
537  // Phi_t1(1) = Phi_t0(0) - dt * VdotG_t0(1)
538  mTask = hboost::bind(&Normalizer::euler01, hboost::placeholders::_1, hboost::placeholders::_2);
539 
540  // Cook and swap buffer 0 and 1 such that Phi_t1(0) and Phi_t0(1)
541  this->cook("Normalizing level set using TVD_RK3 (step 1 of 3)", 1);
542 
543  // Convex combine explicit Euler step: t2 = t0 + dt/2
544  // Phi_t2(2) = 3/4 * Phi_t0(1) + 1/4 * (Phi_t1(0) - dt * V.Grad_t1(0))
545  mTask = hboost::bind(&Normalizer::euler34, hboost::placeholders::_1, hboost::placeholders::_2);
546 
547  // Cook and swap buffer 0 and 2 such that Phi_t2(0) and Phi_t1(2)
548  this->cook("Normalizing level set using TVD_RK3 (step 2 of 3)", 2);
549 
550  // Convex combine explicit Euler step: t3 = t0 + dt
551  // Phi_t3(2) = 1/3 * Phi_t0(1) + 2/3 * (Phi_t2(0) - dt * V.Grad_t2(0)
552  mTask = hboost::bind(&Normalizer::euler13, hboost::placeholders::_1, hboost::placeholders::_2);
553 
554  // Cook and swap buffer 0 and 2 such that Phi_t3(0) and Phi_t2(2)
555  this->cook("Normalizing level set using TVD_RK3 (step 3 of 3)", 2);
556  break;
557  case math::UNKNOWN_TIS:
558  default:
559  OPENVDB_THROW(ValueError, "Temporal integration scheme not supported!");
560  }
562  }
563  mTracker.mLeafs->removeAuxBuffers();
564 }
565 
566 /// Private method to perform the task (serial or threaded) and
567 /// subsequently swap the leaf buffers.
568 template<typename GridT, typename InterruptT>
569 template<math::BiasedGradientScheme SpatialScheme,
570  math::TemporalIntegrationScheme TemporalScheme,
571  typename MaskT>
572 inline void
573 LevelSetTracker<GridT, InterruptT>::
574 Normalizer<SpatialScheme, TemporalScheme, MaskT>::
575 cook(const char* msg, int swapBuffer)
576 {
577  mTracker.startInterrupter( msg );
578 
579  const int grainSize = mTracker.getGrainSize();
580  const LeafRange range = mTracker.leafs().leafRange(grainSize);
581 
582  grainSize>0 ? tbb::parallel_for(range, *this) : (*this)(range);
583 
584  mTracker.leafs().swapLeafBuffer(swapBuffer, grainSize==0);
585 
586  mTracker.endInterrupter();
587 }
588 
589 template<typename GridT, typename InterruptT>
590 template<math::BiasedGradientScheme SpatialScheme,
591  math::TemporalIntegrationScheme TemporalScheme,
592  typename MaskT>
593 template <int Nominator, int Denominator>
594 inline void
595 LevelSetTracker<GridT, InterruptT>::
596 Normalizer<SpatialScheme, TemporalScheme, MaskT>::
597 eval(StencilT& stencil, const ValueType* phi, ValueType* result, Index n) const
598 {
599  typedef typename math::ISGradientNormSqrd<SpatialScheme> GradientT;
600  static const ValueType alpha = ValueType(Nominator)/ValueType(Denominator);
601  static const ValueType beta = ValueType(1) - alpha;
602 
603  const ValueType normSqGradPhi = GradientT::result(stencil);
604  const ValueType phi0 = stencil.getValue();
605  ValueType v = phi0 / ( math::Sqrt(math::Pow2(phi0) + normSqGradPhi) +
607  v = phi0 - mDt * v * (math::Sqrt(normSqGradPhi) * mInvDx - 1.0f);
608  result[n] = Nominator ? alpha * phi[n] + beta * v : v;
609 }
610 
611 template<typename GridT, typename InterruptT>
612 template<math::BiasedGradientScheme SpatialScheme,
613  math::TemporalIntegrationScheme TemporalScheme,
614  typename MaskT>
615 template <int Nominator, int Denominator>
616 inline void
617 LevelSetTracker<GridT,InterruptT>::
618 Normalizer<SpatialScheme, TemporalScheme, MaskT>::
619 euler(const LeafRange& range, Index phiBuffer, Index resultBuffer)
620 {
621  typedef typename LeafType::ValueOnCIter VoxelIterT;
622 
623  mTracker.checkInterrupter();
624 
625  StencilT stencil(mTracker.grid());
626 
627  for (typename LeafRange::Iterator leafIter = range.begin(); leafIter; ++leafIter) {
628  const ValueType* phi = leafIter.buffer(phiBuffer).data();
629  ValueType* result = leafIter.buffer(resultBuffer).data();
630  if (mMask == nullptr) {
631  for (VoxelIterT iter = leafIter->cbeginValueOn(); iter; ++iter) {
632  stencil.moveTo(iter);
633  this->eval<Nominator, Denominator>(stencil, phi, result, iter.pos());
634  }//loop over active voxels in the leaf of the level set
635  } else if (const MaskLeafT* mask = mMask->probeLeaf(leafIter->origin())) {
636  const ValueType* phi0 = leafIter->buffer().data();
637  for (MaskIterT iter = mask->cbeginValueOn(); iter; ++iter) {
638  const Index i = iter.pos();
639  stencil.moveTo(iter.getCoord(), phi0[i]);
640  this->eval<Nominator, Denominator>(stencil, phi, result, i);
641  }//loop over active voxels in the leaf of the mask
642  }
643  }//loop over leafs of the level set
644 }
645 
646 } // namespace tools
647 } // namespace OPENVDB_VERSION_NAME
648 } // namespace openvdb
649 
650 #endif // OPENVDB_TOOLS_LEVEL_SET_TRACKER_HAS_BEEN_INCLUDED
651 
652 // Copyright (c) 2012-2017 DreamWorks Animation LLC
653 // All rights reserved. This software is distributed under the
654 // Mozilla Public License 2.0 ( http://www.mozilla.org/MPL/2.0/ )
TemporalIntegrationScheme
Temporal integration schemes.
GLenum GLint * range
Definition: glcorearb.h:1924
void prune()
Remove voxels that are outside the narrow band. (substep of track)
Type Pow2(Type x)
Return .
Definition: Math.h:514
const GLdouble * v
Definition: glcorearb.h:836
png_infop png_color_16p * background
Definition: png.h:2326
GLboolean GLboolean g
Definition: glcorearb.h:1221
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-...
void track()
Track the level set interface, i.e. rebuild and normalize the narrow band of the level set...
GLint GLuint mask
Definition: glcorearb.h:123
float RoundDown(float x)
Return x rounded down to the nearest integer.
Definition: Math.h:769
ValueType getHalfWidth() const
Return the half width of the narrow band in floating-point voxel units.
Performs multi-threaded interface tracking of narrow band level sets.
TreeType::template ValueConverter< ValueMask >::Type MaskTreeType
png_uint_32 i
Definition: png.h:2877
math::TemporalIntegrationScheme getTemporalScheme() const
BiasedGradientScheme
Biased Gradients are limited to non-centered differences.
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)
void setNormCount(int n)
Set the number of normalizations performed per track or normalize call.
Lightweight struct that stores the state of the LevelSetTracker.
void erode(int iterations=1)
Erodes the width of the narrow-band and update the background values.
GLdouble n
Definition: glcorearb.h:2007
GLfloat f
Definition: glcorearb.h:1925
math::BiasedGradientScheme getSpatialScheme() const
void setSpatialScheme(math::BiasedGradientScheme scheme)
Set the spatial finite difference scheme.
#define OPENVDB_VERSION_NAME
Definition: version.h:43
General-purpose arithmetic and comparison routines, most of which accept arbitrary value types (or at...
Efficient multi-threaded replacement of the background values in tree.
float Sqrt(float x)
Return the square root of a floating-point value.
Definition: Math.h:727
Defined various multi-threaded utility functions for trees.
This class manages a linear array of pointers to a given tree's leaf nodes, as well as optional auxil...
Definition: LeafManager.h:115
GLfloat GLfloat GLfloat alpha
Definition: glcorearb.h:111
LevelSetTracker(GridT &grid, InterruptT *interrupt=nullptr)
Main constructor.
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...
GridType::Ptr normalize(const GridType &grid, bool threaded, InterruptT *interrupt)
Normalize the vectors of the given vector-valued grid.
#define OPENVDB_NO_UNREACHABLE_CODE_WARNING_BEGIN
Definition: Platform.h:129
GLint GLfloat GLint stencil
Definition: glcorearb.h:1277
void setGrainSize(int grainsize)
Set the grain-size used for multi-threading.
OPENVDB_STATIC_SPECIALIZATION void erodeVoxels(TreeType &tree, int iterations=1, NearestNeighbors nn=NN_FACE)
Topologically erode all leaf-level active voxels in the given tree.
Definition: Morphology.h:875
GLsizei const GLfloat * value
Definition: glcorearb.h:823
State getState() const
Return the state of the tracker (see struct defined above)
GLuint GLfloat * val
Definition: glcorearb.h:1607
Implementation of morphological dilation and erosion.
Defines various finite difference stencils by means of the "curiously recurring template pattern" on ...
#define OPENVDB_NO_UNREACHABLE_CODE_WARNING_END
Definition: Platform.h:130
Tag dispatch class that distinguishes topology copy constructors from deep copy constructors.
Definition: Types.h:503
void setTemporalScheme(math::TemporalIntegrationScheme scheme)
Set the spatial finite difference scheme.
A LeafManager manages a linear array of pointers to a given tree's leaf nodes, as well as optional au...
GLboolean r
Definition: glcorearb.h:1221
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h:71
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:374
CopyConstness< TreeType, NonConstBufferType >::Type BufferType
Definition: LeafManager.h:126
void normalize()
Iterative normalization, i.e. solving the Eikonal equation.
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:429
void setState(const State &s)
Set the state of the tracker (see struct defined above)
bool wasInterrupted(T *i, int percent=-1)
OPENVDB_STATIC_SPECIALIZATION void dilateActiveValues(TreeType &tree, int iterations=1, NearestNeighbors nn=NN_FACE, TilePolicy mode=PRESERVE_TILES)
Topologically dilate all active values (i.e. both voxels and tiles) in a tree using one of three near...
Definition: Morphology.h:1074
void dilate(int iterations=1)
Fast but approximate dilation of the narrow band - one layer at a time. Normally we recommend using t...
#define OPENVDB_THROW(exception, message)
Definition: Exceptions.h:101