OpenVDB: openvdb/tools/GridOperators.h Source File

OpenVDB 11.0.0

Loading...
Searching...
No Matches
GridOperators.h
Go to the documentation of this file.
1// Copyright Contributors to the OpenVDB Project
2// SPDX-License-Identifier: MPL-2.0
3
4/// @file tools/GridOperators.h
5///
6/// @brief Apply an operator to an input grid to produce an output grid
7/// with the same active voxel topology but a potentially different value type.
8
9#ifndef OPENVDB_TOOLS_GRID_OPERATORS_HAS_BEEN_INCLUDED
10#define OPENVDB_TOOLS_GRID_OPERATORS_HAS_BEEN_INCLUDED
11
12#include <openvdb/openvdb.h>
13#include <openvdb/Grid.h>
14#include <openvdb/math/Operators.h>
15#include <openvdb/util/NullInterrupter.h>
16#include <openvdb/thread/Threading.h>
17#include <openvdb/tree/LeafManager.h>
18#include <openvdb/tree/ValueAccessor.h>
19
20#include "ValueTransformer.h" // for tools::foreach()
21
22#include <tbb/parallel_for.h>
23
24namespace openvdb {
25 OPENVDB_USE_VERSION_NAMESPACE
26namespace OPENVDB_VERSION_NAME {
27namespace tools {
28
29/// @brief VectorToScalarConverter<VectorGridType>::Type is the type of a grid
30/// having the same tree configuration as VectorGridType but a scalar value type, T,
31/// where T is the type of the original vector components.
32/// @details For example, VectorToScalarConverter<Vec3DGrid>::Type is equivalent to DoubleGrid.
33 template<typename VectorGridType> struct VectorToScalarConverter {
34 typedef typename VectorGridType::ValueType::value_type VecComponentValueT;
35 typedef typename VectorGridType::template ValueConverter<VecComponentValueT>::Type Type;
36};
37
38/// @brief ScalarToVectorConverter<ScalarGridType>::Type is the type of a grid
39/// having the same tree configuration as ScalarGridType but value type Vec3<T>
40/// where T is ScalarGridType::ValueType.
41/// @details For example, ScalarToVectorConverter<DoubleGrid>::Type is equivalent to Vec3DGrid.
42 template<typename ScalarGridType> struct ScalarToVectorConverter {
43 typedef math::Vec3<typename ScalarGridType::ValueType> VectorValueT;
44 typedef typename ScalarGridType::template ValueConverter<VectorValueT>::Type Type;
45};
46
47
48/// @brief Compute the Closest-Point Transform (CPT) from a distance field.
49/// @return a new vector-valued grid with the same numerical precision as the input grid
50/// (for example, if the input grid is a DoubleGrid, the output grid will be a Vec3DGrid)
51/// @details When a mask grid is specified, the solution is calculated only in
52/// the intersection of the mask active topology and the input active topology
53/// independent of the transforms associated with either grid.
54template<typename GridType, typename InterruptT>
55typename ScalarToVectorConverter<GridType>::Type::Ptr
56 cpt(const GridType& grid, bool threaded, InterruptT* interrupt);
57
58template<typename GridType, typename MaskT, typename InterruptT>
59typename ScalarToVectorConverter<GridType>::Type::Ptr
60 cpt(const GridType& grid, const MaskT& mask, bool threaded, InterruptT* interrupt);
61
62template<typename GridType>
63typename ScalarToVectorConverter<GridType>::Type::Ptr
64 cpt(const GridType& grid, bool threaded = true)
65{
66 return cpt<GridType, util::NullInterrupter>(grid, threaded, nullptr);
67}
68
69template<typename GridType, typename MaskT>
70typename ScalarToVectorConverter<GridType>::Type::Ptr
71 cpt(const GridType& grid, const MaskT& mask, bool threaded = true)
72{
73 return cpt<GridType, MaskT, util::NullInterrupter>(grid, mask, threaded, nullptr);
74}
75
76
77/// @brief Compute the curl of the given vector-valued grid.
78/// @return a new vector-valued grid
79/// @details When a mask grid is specified, the solution is calculated only in
80/// the intersection of the mask active topology and the input active topology
81/// independent of the transforms associated with either grid.
82template<typename GridType, typename InterruptT>
83typename GridType::Ptr
84curl(const GridType& grid, bool threaded, InterruptT* interrupt);
85
86template<typename GridType, typename MaskT, typename InterruptT>
87typename GridType::Ptr
88curl(const GridType& grid, const MaskT& mask, bool threaded, InterruptT* interrupt);
89
90template<typename GridType>
91typename GridType::Ptr
92 curl(const GridType& grid, bool threaded = true)
93{
94 return curl<GridType, util::NullInterrupter>(grid, threaded, nullptr);
95}
96
97template<typename GridType, typename MaskT>
98typename GridType::Ptr
99 curl(const GridType& grid, const MaskT& mask, bool threaded = true)
100{
101 return curl<GridType, MaskT, util::NullInterrupter>(grid, mask, threaded, nullptr);
102}
103
104
105/// @brief Compute the divergence of the given vector-valued grid.
106/// @return a new scalar-valued grid with the same numerical precision as the input grid
107/// (for example, if the input grid is a Vec3DGrid, the output grid will be a DoubleGrid)
108/// @details When a mask grid is specified, the solution is calculated only in
109/// the intersection of the mask active topology and the input active topology
110/// independent of the transforms associated with either grid.
111template<typename GridType, typename InterruptT>
112typename VectorToScalarConverter<GridType>::Type::Ptr
113divergence(const GridType& grid, bool threaded, InterruptT* interrupt);
114
115template<typename GridType, typename MaskT, typename InterruptT>
116typename VectorToScalarConverter<GridType>::Type::Ptr
117divergence(const GridType& grid, const MaskT& mask, bool threaded, InterruptT* interrupt);
118
119template<typename GridType>
120typename VectorToScalarConverter<GridType>::Type::Ptr
121 divergence(const GridType& grid, bool threaded = true)
122{
123 return divergence<GridType, util::NullInterrupter>(grid, threaded, nullptr);
124}
125
126template<typename GridType, typename MaskT>
127typename VectorToScalarConverter<GridType>::Type::Ptr
128 divergence(const GridType& grid, const MaskT& mask, bool threaded = true)
129{
130 return divergence<GridType, MaskT, util::NullInterrupter>(grid, mask, threaded, nullptr);
131}
132
133
134/// @brief Compute the gradient of the given scalar grid.
135/// @return a new vector-valued grid with the same numerical precision as the input grid
136/// (for example, if the input grid is a DoubleGrid, the output grid will be a Vec3DGrid)
137/// @details When a mask grid is specified, the solution is calculated only in
138/// the intersection of the mask active topology and the input active topology
139/// independent of the transforms associated with either grid.
140template<typename GridType, typename InterruptT>
141typename ScalarToVectorConverter<GridType>::Type::Ptr
142gradient(const GridType& grid, bool threaded, InterruptT* interrupt);
143
144template<typename GridType, typename MaskT, typename InterruptT>
145typename ScalarToVectorConverter<GridType>::Type::Ptr
146gradient(const GridType& grid, const MaskT& mask, bool threaded, InterruptT* interrupt);
147
148template<typename GridType>
149typename ScalarToVectorConverter<GridType>::Type::Ptr
150 gradient(const GridType& grid, bool threaded = true)
151{
152 return gradient<GridType, util::NullInterrupter>(grid, threaded, nullptr);
153}
154
155template<typename GridType, typename MaskT>
156typename ScalarToVectorConverter<GridType>::Type::Ptr
157 gradient(const GridType& grid, const MaskT& mask, bool threaded = true)
158{
159 return gradient<GridType, MaskT, util::NullInterrupter>(grid, mask, threaded, nullptr);
160}
161
162
163/// @brief Compute the Laplacian of the given scalar grid.
164/// @return a new scalar grid
165/// @details When a mask grid is specified, the solution is calculated only in
166/// the intersection of the mask active topology and the input active topology
167/// independent of the transforms associated with either grid.
168template<typename GridType, typename InterruptT>
169typename GridType::Ptr
170laplacian(const GridType& grid, bool threaded, InterruptT* interrupt);
171
172template<typename GridType, typename MaskT, typename InterruptT>
173typename GridType::Ptr
174laplacian(const GridType& grid, const MaskT& mask, bool threaded, InterruptT* interrupt);
175
176template<typename GridType>
177typename GridType::Ptr
178 laplacian(const GridType& grid, bool threaded = true)
179{
180 return laplacian<GridType, util::NullInterrupter>(grid, threaded, nullptr);
181}
182
183template<typename GridType, typename MaskT>
184typename GridType::Ptr
185 laplacian(const GridType& grid, const MaskT& mask, bool threaded = true)
186{
187 return laplacian<GridType, MaskT, util::NullInterrupter>(grid, mask, threaded, nullptr);
188}
189
190
191/// @brief Compute the mean curvature of the given grid.
192/// @return a new grid
193/// @details When a mask grid is specified, the solution is calculated only in
194/// the intersection of the mask active topology and the input active topology
195/// independent of the transforms associated with either grid.
196template<typename GridType, typename InterruptT>
197typename GridType::Ptr
198meanCurvature(const GridType& grid, bool threaded, InterruptT* interrupt);
199
200template<typename GridType, typename MaskT, typename InterruptT>
201typename GridType::Ptr
202meanCurvature(const GridType& grid, const MaskT& mask, bool threaded, InterruptT* interrupt);
203
204template<typename GridType>
205typename GridType::Ptr
206 meanCurvature(const GridType& grid, bool threaded = true)
207{
208 return meanCurvature<GridType, util::NullInterrupter>(grid, threaded, nullptr);
209}
210
211template<typename GridType, typename MaskT>
212typename GridType::Ptr
213 meanCurvature(const GridType& grid, const MaskT& mask, bool threaded = true)
214{
215 return meanCurvature<GridType, MaskT, util::NullInterrupter>(grid, mask, threaded, nullptr);
216}
217
218
219/// @brief Compute the magnitudes of the vectors of the given vector-valued grid.
220/// @return a new scalar-valued grid with the same numerical precision as the input grid
221/// (for example, if the input grid is a Vec3DGrid, the output grid will be a DoubleGrid)
222/// @details When a mask grid is specified, the solution is calculated only in
223/// the intersection of the mask active topology and the input active topology
224/// independent of the transforms associated with either grid.
225template<typename GridType, typename InterruptT>
226typename VectorToScalarConverter<GridType>::Type::Ptr
227magnitude(const GridType& grid, bool threaded, InterruptT* interrupt);
228
229template<typename GridType, typename MaskT, typename InterruptT>
230typename VectorToScalarConverter<GridType>::Type::Ptr
231magnitude(const GridType& grid, const MaskT& mask, bool threaded, InterruptT* interrupt);
232
233template<typename GridType>
234typename VectorToScalarConverter<GridType>::Type::Ptr
235 magnitude(const GridType& grid, bool threaded = true)
236{
237 return magnitude<GridType, util::NullInterrupter>(grid, threaded, nullptr);
238}
239
240template<typename GridType, typename MaskT>
241typename VectorToScalarConverter<GridType>::Type::Ptr
242 magnitude(const GridType& grid, const MaskT& mask, bool threaded = true)
243{
244 return magnitude<GridType, MaskT, util::NullInterrupter>(grid, mask, threaded, nullptr);
245}
246
247
248/// @brief Normalize the vectors of the given vector-valued grid.
249/// @return a new vector-valued grid
250/// @details When a mask grid is specified, the solution is calculated only in
251/// the intersection of the mask active topology and the input active topology
252/// independent of the transforms associated with either grid.
253template<typename GridType, typename InterruptT>
254typename GridType::Ptr
255normalize(const GridType& grid, bool threaded, InterruptT* interrupt);
256
257template<typename GridType, typename MaskT, typename InterruptT>
258typename GridType::Ptr
259normalize(const GridType& grid, const MaskT& mask, bool threaded, InterruptT* interrupt);
260
261template<typename GridType>
262typename GridType::Ptr
263 normalize(const GridType& grid, bool threaded = true)
264{
265 return normalize<GridType, util::NullInterrupter>(grid, threaded, nullptr);
266}
267
268template<typename GridType, typename MaskT>
269typename GridType::Ptr
270 normalize(const GridType& grid, const MaskT& mask, bool threaded = true)
271{
272 return normalize<GridType, MaskT, util::NullInterrupter>(grid, mask, threaded, nullptr);
273}
274
275
276////////////////////////////////////////
277
278
279 namespace gridop {
280
281/// @brief ToMaskGrid<T>::Type is the type of a grid having the same
282/// tree hierarchy as grid type T but a value equal to its active state.
283/// @details For example, ToMaskGrid<FloatGrid>::Type is equivalent to MaskGrid.
284template<typename GridType>
285 struct ToMaskGrid {
286 typedef Grid<typename GridType::TreeType::template ValueConverter<ValueMask>::Type> Type;
287};
288
289
290/// @brief Apply an operator to an input grid to produce an output grid
291/// with the same active voxel topology but a potentially different value type.
292/// @details To facilitate inlining, this class is also templated on a Map type.
293///
294/// @note This is a helper class and should never be used directly.
295template<
296 typename InGridT,
297 typename MaskGridType,
298 typename OutGridT,
299 typename MapT,
300 typename OperatorT,
301 typename InterruptT = util::NullInterrupter>
302 class GridOperator
303{
304public:
305 typedef typename OutGridT::TreeType OutTreeT;
306 typedef typename OutTreeT::LeafNodeType OutLeafT;
307 typedef typename tree::LeafManager<OutTreeT> LeafManagerT;
308
309 GridOperator(const InGridT& grid, const MaskGridType* mask, const MapT& map,
310 InterruptT* interrupt = nullptr, bool densify = true)
311 : mAcc(grid.getConstAccessor())
312 , mMap(map)
313 , mInterrupt(interrupt)
314 , mMask(mask)
315 , mDensify(densify) ///< @todo consider adding a "NeedsDensification" operator trait
316 {
317 }
318 GridOperator(const GridOperator&) = default;
319 GridOperator& operator=(const GridOperator&) = default;
320 virtual ~GridOperator() = default;
321
322 typename OutGridT::Ptr process(bool threaded = true)
323 {
324 if (mInterrupt) mInterrupt->start("Processing grid");
325
326 // Derive background value of the output grid
327 typename InGridT::TreeType tmp(mAcc.tree().background());
328 typename OutGridT::ValueType backg = OperatorT::result(mMap, tmp, math::Coord(0));
329
330 // The output tree is topology copy, optionally densified, of the input tree.
331 // (Densification is necessary for some operators because applying the operator to
332 // a constant tile produces distinct output values, particularly along tile borders.)
333 /// @todo Can tiles be handled correctly without densification, or by densifying
334 /// only to the width of the operator stencil?
335 typename OutTreeT::Ptr tree(new OutTreeT(mAcc.tree(), backg, TopologyCopy()));
336 if (mDensify) tree->voxelizeActiveTiles();
337
338 // create grid with output tree and unit transform
339 typename OutGridT::Ptr result(new OutGridT(tree));
340
341 // Modify the solution area if a mask was supplied.
342 if (mMask) {
343 result->topologyIntersection(*mMask);
344 }
345
346 // transform of output grid = transform of input grid
347 result->setTransform(math::Transform::Ptr(new math::Transform( mMap.copy() )));
348
349 LeafManagerT leafManager(*tree);
350
351 if (threaded) {
352 tbb::parallel_for(leafManager.leafRange(), *this);
353 } else {
354 (*this)(leafManager.leafRange());
355 }
356
357 // If the tree wasn't densified, it might have active tiles that need to be processed.
358 if (!mDensify) {
359 using TileIter = typename OutTreeT::ValueOnIter;
360
361 TileIter tileIter = tree->beginValueOn();
362 tileIter.setMaxDepth(tileIter.getLeafDepth() - 1); // skip leaf values (i.e., voxels)
363
364 AccessorT inAcc = mAcc; // each thread needs its own accessor, captured by value
365 auto tileOp = [this, inAcc](const TileIter& it) {
366 // Apply the operator to the input grid's tile value at the iterator's
367 // current coordinates, and set the output tile's value to the result.
368 it.setValue(OperatorT::result(this->mMap, inAcc, it.getCoord()));
369 };
370
371 // Apply the operator to tile values, optionally in parallel.
372 // (But don't share the functor; each thread needs its own accessor.)
373 tools::foreach(tileIter, tileOp, threaded, /*shareFunctor=*/false);
374 }
375
376 if (mDensify) tree->prune();
377
378 if (mInterrupt) mInterrupt->end();
379 return result;
380 }
381
382 /// @brief Iterate sequentially over LeafNodes and voxels in the output
383 /// grid and apply the operator using a value accessor for the input grid.
384 ///
385 /// @note Never call this public method directly - it is called by
386 /// TBB threads only!
387 void operator()(const typename LeafManagerT::LeafRange& range) const
388 {
389 if (util::wasInterrupted(mInterrupt)) {
390 thread::cancelGroupExecution();
391 }
392
393 for (typename LeafManagerT::LeafRange::Iterator leaf=range.begin(); leaf; ++leaf) {
394 for (typename OutLeafT::ValueOnIter value=leaf->beginValueOn(); value; ++value) {
395 value.setValue(OperatorT::result(mMap, mAcc, value.getCoord()));
396 }
397 }
398 }
399
400protected:
401 typedef typename InGridT::ConstAccessor AccessorT;
402 mutable AccessorT mAcc;
403 const MapT& mMap;
404 InterruptT* mInterrupt;
405 const MaskGridType* mMask;
406 const bool mDensify;
407}; // end of GridOperator class
408
409} // namespace gridop
410
411
412////////////////////////////////////////
413
414
415/// @brief Compute the closest-point transform of a scalar grid.
416template<
417 typename InGridT,
418 typename MaskGridType = typename gridop::ToMaskGrid<InGridT>::Type,
419 typename InterruptT = util::NullInterrupter>
420 class Cpt
421{
422public:
423 typedef InGridT InGridType;
424 typedef typename ScalarToVectorConverter<InGridT>::Type OutGridType;
425
426 Cpt(const InGridType& grid, InterruptT* interrupt = nullptr):
427 mInputGrid(grid), mInterrupt(interrupt), mMask(nullptr)
428 {
429 }
430
431 Cpt(const InGridType& grid, const MaskGridType& mask, InterruptT* interrupt = nullptr):
432 mInputGrid(grid), mInterrupt(interrupt), mMask(&mask)
433 {
434 }
435
436 typename OutGridType::Ptr process(bool threaded = true, bool useWorldTransform = true)
437 {
438 Functor functor(mInputGrid, mMask, threaded, useWorldTransform, mInterrupt);
439 processTypedMap(mInputGrid.transform(), functor);
440 if (functor.mOutputGrid) functor.mOutputGrid->setVectorType(VEC_CONTRAVARIANT_ABSOLUTE);
441 return functor.mOutputGrid;
442 }
443
444private:
445 struct IsOpT
446 {
447 template<typename MapT, typename AccT>
448 static typename OutGridType::ValueType
449 result(const MapT& map, const AccT& acc, const Coord& xyz)
450 {
451 return math::CPT<MapT, math::CD_2ND>::result(map, acc, xyz);
452 }
453 };
454 struct WsOpT
455 {
456 template<typename MapT, typename AccT>
457 static typename OutGridType::ValueType
458 result(const MapT& map, const AccT& acc, const Coord& xyz)
459 {
460 return math::CPT_RANGE<MapT, math::CD_2ND>::result(map, acc, xyz);
461 }
462 };
463 struct Functor
464 {
465 Functor(const InGridType& grid, const MaskGridType* mask,
466 bool threaded, bool worldspace, InterruptT* interrupt)
467 : mThreaded(threaded)
468 , mWorldSpace(worldspace)
469 , mInputGrid(grid)
470 , mInterrupt(interrupt)
471 , mMask(mask)
472 {}
473
474 template<typename MapT>
475 void operator()(const MapT& map)
476 {
477 if (mWorldSpace) {
478 gridop::GridOperator<InGridType, MaskGridType, OutGridType, MapT, WsOpT, InterruptT>
479 op(mInputGrid, mMask, map, mInterrupt, /*densify=*/false);
480 mOutputGrid = op.process(mThreaded); // cache the result
481 } else {
482 gridop::GridOperator<InGridType, MaskGridType, OutGridType, MapT, IsOpT, InterruptT>
483 op(mInputGrid, mMask, map, mInterrupt, /*densify=*/false);
484 mOutputGrid = op.process(mThreaded); // cache the result
485 }
486 }
487 const bool mThreaded;
488 const bool mWorldSpace;
489 const InGridType& mInputGrid;
490 typename OutGridType::Ptr mOutputGrid;
491 InterruptT* mInterrupt;
492 const MaskGridType* mMask;
493 };
494 const InGridType& mInputGrid;
495 InterruptT* mInterrupt;
496 const MaskGridType* mMask;
497}; // end of Cpt class
498
499
500////////////////////////////////////////
501
502
503/// @brief Compute the curl of a vector grid.
504template<
505 typename GridT,
506 typename MaskGridType = typename gridop::ToMaskGrid<GridT>::Type,
507 typename InterruptT = util::NullInterrupter>
508 class Curl
509{
510public:
511 typedef GridT InGridType;
512 typedef GridT OutGridType;
513
514 Curl(const GridT& grid, InterruptT* interrupt = nullptr):
515 mInputGrid(grid), mInterrupt(interrupt), mMask(nullptr)
516 {
517 }
518
519 Curl(const GridT& grid, const MaskGridType& mask, InterruptT* interrupt = nullptr):
520 mInputGrid(grid), mInterrupt(interrupt), mMask(&mask)
521 {
522 }
523
524 typename GridT::Ptr process(bool threaded = true)
525 {
526 Functor functor(mInputGrid, mMask, threaded, mInterrupt);
527 processTypedMap(mInputGrid.transform(), functor);
528 if (functor.mOutputGrid) functor.mOutputGrid->setVectorType(VEC_COVARIANT);
529 return functor.mOutputGrid;
530 }
531
532private:
533 struct Functor
534 {
535 Functor(const GridT& grid, const MaskGridType* mask,
536 bool threaded, InterruptT* interrupt):
537 mThreaded(threaded), mInputGrid(grid), mInterrupt(interrupt), mMask(mask) {}
538
539 template<typename MapT>
540 void operator()(const MapT& map)
541 {
542 typedef math::Curl<MapT, math::CD_2ND> OpT;
543 gridop::GridOperator<GridT, MaskGridType, GridT, MapT, OpT, InterruptT>
544 op(mInputGrid, mMask, map, mInterrupt);
545 mOutputGrid = op.process(mThreaded); // cache the result
546 }
547
548 const bool mThreaded;
549 const GridT& mInputGrid;
550 typename GridT::Ptr mOutputGrid;
551 InterruptT* mInterrupt;
552 const MaskGridType* mMask;
553 }; // Private Functor
554
555 const GridT& mInputGrid;
556 InterruptT* mInterrupt;
557 const MaskGridType* mMask;
558}; // end of Curl class
559
560
561////////////////////////////////////////
562
563
564/// @brief Compute the divergence of a vector grid.
565template<
566 typename InGridT,
567 typename MaskGridType = typename gridop::ToMaskGrid<InGridT>::Type,
568 typename InterruptT = util::NullInterrupter>
569 class Divergence
570{
571public:
572 typedef InGridT InGridType;
573 typedef typename VectorToScalarConverter<InGridT>::Type OutGridType;
574
575 Divergence(const InGridT& grid, InterruptT* interrupt = nullptr):
576 mInputGrid(grid), mInterrupt(interrupt), mMask(nullptr)
577 {
578 }
579
580 Divergence(const InGridT& grid, const MaskGridType& mask, InterruptT* interrupt = nullptr):
581 mInputGrid(grid), mInterrupt(interrupt), mMask(&mask)
582 {
583 }
584
585 typename OutGridType::Ptr process(bool threaded = true)
586 {
587 if (mInputGrid.getGridClass() == GRID_STAGGERED) {
588 Functor<math::FD_1ST> functor(mInputGrid, mMask, threaded, mInterrupt);
589 processTypedMap(mInputGrid.transform(), functor);
590 return functor.mOutputGrid;
591 } else {
592 Functor<math::CD_2ND> functor(mInputGrid, mMask, threaded, mInterrupt);
593 processTypedMap(mInputGrid.transform(), functor);
594 return functor.mOutputGrid;
595 }
596 }
597
598protected:
599 template<math::DScheme DiffScheme>
600 struct Functor
601 {
602 Functor(const InGridT& grid, const MaskGridType* mask,
603 bool threaded, InterruptT* interrupt):
604 mThreaded(threaded), mInputGrid(grid), mInterrupt(interrupt), mMask(mask) {}
605
606 template<typename MapT>
607 void operator()(const MapT& map)
608 {
609 typedef math::Divergence<MapT, DiffScheme> OpT;
610 gridop::GridOperator<InGridType, MaskGridType, OutGridType, MapT, OpT, InterruptT>
611 op(mInputGrid, mMask, map, mInterrupt);
612 mOutputGrid = op.process(mThreaded); // cache the result
613 }
614
615 const bool mThreaded;
616 const InGridType& mInputGrid;
617 typename OutGridType::Ptr mOutputGrid;
618 InterruptT* mInterrupt;
619 const MaskGridType* mMask;
620 }; // Private Functor
621
622 const InGridType& mInputGrid;
623 InterruptT* mInterrupt;
624 const MaskGridType* mMask;
625}; // end of Divergence class
626
627
628////////////////////////////////////////
629
630
631/// @brief Compute the gradient of a scalar grid.
632template<
633 typename InGridT,
634 typename MaskGridType = typename gridop::ToMaskGrid<InGridT>::Type,
635 typename InterruptT = util::NullInterrupter>
636 class Gradient
637{
638public:
639 typedef InGridT InGridType;
640 typedef typename ScalarToVectorConverter<InGridT>::Type OutGridType;
641
642 Gradient(const InGridT& grid, InterruptT* interrupt = nullptr):
643 mInputGrid(grid), mInterrupt(interrupt), mMask(nullptr)
644 {
645 }
646
647 Gradient(const InGridT& grid, const MaskGridType& mask, InterruptT* interrupt = nullptr):
648 mInputGrid(grid), mInterrupt(interrupt), mMask(&mask)
649 {
650 }
651
652 typename OutGridType::Ptr process(bool threaded = true)
653 {
654 Functor functor(mInputGrid, mMask, threaded, mInterrupt);
655 processTypedMap(mInputGrid.transform(), functor);
656 if (functor.mOutputGrid) functor.mOutputGrid->setVectorType(VEC_COVARIANT);
657 return functor.mOutputGrid;
658 }
659
660protected:
661 struct Functor
662 {
663 Functor(const InGridT& grid, const MaskGridType* mask,
664 bool threaded, InterruptT* interrupt):
665 mThreaded(threaded), mInputGrid(grid), mInterrupt(interrupt), mMask(mask) {}
666
667 template<typename MapT>
668 void operator()(const MapT& map)
669 {
670 typedef math::Gradient<MapT, math::CD_2ND> OpT;
671 gridop::GridOperator<InGridType, MaskGridType, OutGridType, MapT, OpT, InterruptT>
672 op(mInputGrid, mMask, map, mInterrupt);
673 mOutputGrid = op.process(mThreaded); // cache the result
674 }
675
676 const bool mThreaded;
677 const InGridT& mInputGrid;
678 typename OutGridType::Ptr mOutputGrid;
679 InterruptT* mInterrupt;
680 const MaskGridType* mMask;
681 }; // Private Functor
682
683 const InGridT& mInputGrid;
684 InterruptT* mInterrupt;
685 const MaskGridType* mMask;
686}; // end of Gradient class
687
688
689////////////////////////////////////////
690
691
692template<
693 typename GridT,
694 typename MaskGridType = typename gridop::ToMaskGrid<GridT>::Type,
695 typename InterruptT = util::NullInterrupter>
696 class Laplacian
697{
698public:
699 typedef GridT InGridType;
700 typedef GridT OutGridType;
701
702 Laplacian(const GridT& grid, InterruptT* interrupt = nullptr):
703 mInputGrid(grid), mInterrupt(interrupt), mMask(nullptr)
704 {
705 }
706
707 Laplacian(const GridT& grid, const MaskGridType& mask, InterruptT* interrupt = nullptr):
708 mInputGrid(grid), mInterrupt(interrupt), mMask(&mask)
709 {
710 }
711
712 typename GridT::Ptr process(bool threaded = true)
713 {
714 Functor functor(mInputGrid, mMask, threaded, mInterrupt);
715 processTypedMap(mInputGrid.transform(), functor);
716 if (functor.mOutputGrid) functor.mOutputGrid->setVectorType(VEC_COVARIANT);
717 return functor.mOutputGrid;
718 }
719
720protected:
721 struct Functor
722 {
723 Functor(const GridT& grid, const MaskGridType* mask, bool threaded, InterruptT* interrupt):
724 mThreaded(threaded), mInputGrid(grid), mInterrupt(interrupt), mMask(mask) {}
725
726 template<typename MapT>
727 void operator()(const MapT& map)
728 {
729 typedef math::Laplacian<MapT, math::CD_SECOND> OpT;
730 gridop::GridOperator<GridT, MaskGridType, GridT, MapT, OpT, InterruptT>
731 op(mInputGrid, mMask, map, mInterrupt);
732 mOutputGrid = op.process(mThreaded); // cache the result
733 }
734
735 const bool mThreaded;
736 const GridT& mInputGrid;
737 typename GridT::Ptr mOutputGrid;
738 InterruptT* mInterrupt;
739 const MaskGridType* mMask;
740 }; // Private Functor
741
742 const GridT& mInputGrid;
743 InterruptT* mInterrupt;
744 const MaskGridType* mMask;
745}; // end of Laplacian class
746
747
748////////////////////////////////////////
749
750
751template<
752 typename GridT,
753 typename MaskGridType = typename gridop::ToMaskGrid<GridT>::Type,
754 typename InterruptT = util::NullInterrupter>
755 class MeanCurvature
756{
757public:
758 typedef GridT InGridType;
759 typedef GridT OutGridType;
760
761 MeanCurvature(const GridT& grid, InterruptT* interrupt = nullptr):
762 mInputGrid(grid), mInterrupt(interrupt), mMask(nullptr)
763 {
764 }
765
766 MeanCurvature(const GridT& grid, const MaskGridType& mask, InterruptT* interrupt = nullptr):
767 mInputGrid(grid), mInterrupt(interrupt), mMask(&mask)
768 {
769 }
770
771 typename GridT::Ptr process(bool threaded = true)
772 {
773 Functor functor(mInputGrid, mMask, threaded, mInterrupt);
774 processTypedMap(mInputGrid.transform(), functor);
775 if (functor.mOutputGrid) functor.mOutputGrid->setVectorType(VEC_COVARIANT);
776 return functor.mOutputGrid;
777 }
778
779protected:
780 struct Functor
781 {
782 Functor(const GridT& grid, const MaskGridType* mask, bool threaded, InterruptT* interrupt):
783 mThreaded(threaded), mInputGrid(grid), mInterrupt(interrupt), mMask(mask) {}
784
785 template<typename MapT>
786 void operator()(const MapT& map)
787 {
788 typedef math::MeanCurvature<MapT, math::CD_SECOND, math::CD_2ND> OpT;
789 gridop::GridOperator<GridT, MaskGridType, GridT, MapT, OpT, InterruptT>
790 op(mInputGrid, mMask, map, mInterrupt);
791 mOutputGrid = op.process(mThreaded); // cache the result
792 }
793
794 const bool mThreaded;
795 const GridT& mInputGrid;
796 typename GridT::Ptr mOutputGrid;
797 InterruptT* mInterrupt;
798 const MaskGridType* mMask;
799 }; // Private Functor
800
801 const GridT& mInputGrid;
802 InterruptT* mInterrupt;
803 const MaskGridType* mMask;
804}; // end of MeanCurvature class
805
806
807////////////////////////////////////////
808
809
810template<
811 typename InGridT,
812 typename MaskGridType = typename gridop::ToMaskGrid<InGridT>::Type,
813 typename InterruptT = util::NullInterrupter>
814 class Magnitude
815{
816public:
817 typedef InGridT InGridType;
818 typedef typename VectorToScalarConverter<InGridT>::Type OutGridType;
819
820 Magnitude(const InGridType& grid, InterruptT* interrupt = nullptr):
821 mInputGrid(grid), mInterrupt(interrupt), mMask(nullptr)
822 {
823 }
824
825 Magnitude(const InGridType& grid, const MaskGridType& mask, InterruptT* interrupt = nullptr):
826 mInputGrid(grid), mInterrupt(interrupt), mMask(&mask)
827 {
828 }
829
830 typename OutGridType::Ptr process(bool threaded = true)
831 {
832 Functor functor(mInputGrid, mMask, threaded, mInterrupt);
833 processTypedMap(mInputGrid.transform(), functor);
834 return functor.mOutputGrid;
835 }
836
837protected:
838 struct OpT
839 {
840 template<typename MapT, typename AccT>
841 static typename OutGridType::ValueType
842 result(const MapT&, const AccT& acc, const Coord& xyz) { return acc.getValue(xyz).length();}
843 };
844 struct Functor
845 {
846 Functor(const InGridT& grid, const MaskGridType* mask,
847 bool threaded, InterruptT* interrupt):
848 mThreaded(threaded), mInputGrid(grid), mInterrupt(interrupt), mMask(mask) {}
849
850 template<typename MapT>
851 void operator()(const MapT& map)
852 {
853 gridop::GridOperator<InGridType, MaskGridType, OutGridType, MapT, OpT, InterruptT>
854 op(mInputGrid, mMask, map, mInterrupt, /*densify=*/false);
855 mOutputGrid = op.process(mThreaded); // cache the result
856 }
857
858 const bool mThreaded;
859 const InGridType& mInputGrid;
860 typename OutGridType::Ptr mOutputGrid;
861 InterruptT* mInterrupt;
862 const MaskGridType* mMask;
863 }; // Private Functor
864
865 const InGridType& mInputGrid;
866 InterruptT* mInterrupt;
867 const MaskGridType* mMask;
868}; // end of Magnitude class
869
870
871////////////////////////////////////////
872
873
874template<
875 typename GridT,
876 typename MaskGridType = typename gridop::ToMaskGrid<GridT>::Type,
877 typename InterruptT = util::NullInterrupter>
878 class Normalize
879{
880public:
881 typedef GridT InGridType;
882 typedef GridT OutGridType;
883
884 Normalize(const GridT& grid, InterruptT* interrupt = nullptr):
885 mInputGrid(grid), mInterrupt(interrupt), mMask(nullptr)
886 {
887 }
888
889 Normalize(const GridT& grid, const MaskGridType& mask, InterruptT* interrupt = nullptr):
890 mInputGrid(grid), mInterrupt(interrupt), mMask(&mask)
891 {
892 }
893
894 typename GridT::Ptr process(bool threaded = true)
895 {
896 Functor functor(mInputGrid, mMask, threaded, mInterrupt);
897 processTypedMap(mInputGrid.transform(), functor);
898 if (typename GridT::Ptr outGrid = functor.mOutputGrid) {
899 const VecType vecType = mInputGrid.getVectorType();
900 if (vecType == VEC_COVARIANT) {
901 outGrid->setVectorType(VEC_COVARIANT_NORMALIZE);
902 } else {
903 outGrid->setVectorType(vecType);
904 }
905 }
906 return functor.mOutputGrid;
907 }
908
909protected:
910 struct OpT
911 {
912 template<typename MapT, typename AccT>
913 static typename OutGridType::ValueType
914 result(const MapT&, const AccT& acc, const Coord& xyz)
915 {
916 typename OutGridType::ValueType vec = acc.getValue(xyz);
917 if ( !vec.normalize() ) vec.setZero();
918 return vec;
919 }
920 };
921 struct Functor
922 {
923 Functor(const GridT& grid, const MaskGridType* mask, bool threaded, InterruptT* interrupt):
924 mThreaded(threaded), mInputGrid(grid), mInterrupt(interrupt), mMask(mask) {}
925
926 template<typename MapT>
927 void operator()(const MapT& map)
928 {
929 gridop::GridOperator<GridT, MaskGridType, GridT, MapT, OpT, InterruptT>
930 op(mInputGrid, mMask, map, mInterrupt, /*densify=*/false);
931 mOutputGrid = op.process(mThreaded); // cache the result
932 }
933
934 const bool mThreaded;
935 const GridT& mInputGrid;
936 typename GridT::Ptr mOutputGrid;
937 InterruptT* mInterrupt;
938 const MaskGridType* mMask;
939 }; // Private Functor
940
941 const GridT& mInputGrid;
942 InterruptT* mInterrupt;
943 const MaskGridType* mMask;
944}; // end of Normalize class
945
946
947////////////////////////////////////////
948
949
950template<typename GridType, typename InterruptT>
951typename ScalarToVectorConverter<GridType>::Type::Ptr
952cpt(const GridType& grid, bool threaded, InterruptT* interrupt)
953{
954 Cpt<GridType, typename gridop::ToMaskGrid<GridType>::Type, InterruptT> op(grid, interrupt);
955 return op.process(threaded);
956}
957
958template<typename GridType, typename MaskT, typename InterruptT>
959typename ScalarToVectorConverter<GridType>::Type::Ptr
960 cpt(const GridType& grid, const MaskT& mask, bool threaded, InterruptT* interrupt)
961{
962 Cpt<GridType, MaskT, InterruptT> op(grid, mask, interrupt);
963 return op.process(threaded);
964}
965
966template<typename GridType, typename InterruptT>
967typename GridType::Ptr
968curl(const GridType& grid, bool threaded, InterruptT* interrupt)
969{
970 Curl<GridType, typename gridop::ToMaskGrid<GridType>::Type, InterruptT> op(grid, interrupt);
971 return op.process(threaded);
972}
973
974template<typename GridType, typename MaskT, typename InterruptT>
975typename GridType::Ptr
976 curl(const GridType& grid, const MaskT& mask, bool threaded, InterruptT* interrupt)
977{
978 Curl<GridType, MaskT, InterruptT> op(grid, mask, interrupt);
979 return op.process(threaded);
980}
981
982template<typename GridType, typename InterruptT>
983typename VectorToScalarConverter<GridType>::Type::Ptr
984divergence(const GridType& grid, bool threaded, InterruptT* interrupt)
985{
986 Divergence<GridType, typename gridop::ToMaskGrid<GridType>::Type, InterruptT>
987 op(grid, interrupt);
988 return op.process(threaded);
989}
990
991template<typename GridType, typename MaskT, typename InterruptT>
992typename VectorToScalarConverter<GridType>::Type::Ptr
993 divergence(const GridType& grid, const MaskT& mask, bool threaded, InterruptT* interrupt)
994{
995 Divergence<GridType, MaskT, InterruptT> op(grid, mask, interrupt);
996 return op.process(threaded);
997}
998
999template<typename GridType, typename InterruptT>
1000typename ScalarToVectorConverter<GridType>::Type::Ptr
1001gradient(const GridType& grid, bool threaded, InterruptT* interrupt)
1002{
1003 Gradient<GridType, typename gridop::ToMaskGrid<GridType>::Type, InterruptT>
1004 op(grid, interrupt);
1005 return op.process(threaded);
1006}
1007
1008template<typename GridType, typename MaskT, typename InterruptT>
1009typename ScalarToVectorConverter<GridType>::Type::Ptr
1010 gradient(const GridType& grid, const MaskT& mask, bool threaded, InterruptT* interrupt)
1011{
1012 Gradient<GridType, MaskT, InterruptT> op(grid, mask, interrupt);
1013 return op.process(threaded);
1014}
1015
1016template<typename GridType, typename InterruptT>
1017typename GridType::Ptr
1018laplacian(const GridType& grid, bool threaded, InterruptT* interrupt)
1019{
1020 Laplacian<GridType, typename gridop::ToMaskGrid<GridType>::Type, InterruptT>
1021 op(grid, interrupt);
1022 return op.process(threaded);
1023}
1024
1025template<typename GridType, typename MaskT, typename InterruptT>
1026typename GridType::Ptr
1027 laplacian(const GridType& grid, const MaskT& mask, bool threaded, InterruptT* interrupt)
1028{
1029 Laplacian<GridType, MaskT, InterruptT> op(grid, mask, interrupt);
1030 return op.process(threaded);
1031}
1032
1033template<typename GridType, typename InterruptT>
1034typename GridType::Ptr
1035meanCurvature(const GridType& grid, bool threaded, InterruptT* interrupt)
1036{
1037 MeanCurvature<GridType, typename gridop::ToMaskGrid<GridType>::Type, InterruptT>
1038 op(grid, interrupt);
1039 return op.process(threaded);
1040}
1041
1042template<typename GridType, typename MaskT, typename InterruptT>
1043typename GridType::Ptr
1044 meanCurvature(const GridType& grid, const MaskT& mask, bool threaded, InterruptT* interrupt)
1045{
1046 MeanCurvature<GridType, MaskT, InterruptT> op(grid, mask, interrupt);
1047 return op.process(threaded);
1048}
1049
1050template<typename GridType, typename InterruptT>
1051typename VectorToScalarConverter<GridType>::Type::Ptr
1052magnitude(const GridType& grid, bool threaded, InterruptT* interrupt)
1053{
1054 Magnitude<GridType, typename gridop::ToMaskGrid<GridType>::Type, InterruptT>
1055 op(grid, interrupt);
1056 return op.process(threaded);
1057}
1058
1059template<typename GridType, typename MaskT, typename InterruptT>
1060typename VectorToScalarConverter<GridType>::Type::Ptr
1061 magnitude(const GridType& grid, const MaskT& mask, bool threaded, InterruptT* interrupt)
1062{
1063 Magnitude<GridType, MaskT, InterruptT> op(grid, mask, interrupt);
1064 return op.process(threaded);
1065}
1066
1067template<typename GridType, typename InterruptT>
1068typename GridType::Ptr
1069normalize(const GridType& grid, bool threaded, InterruptT* interrupt)
1070{
1071 Normalize<GridType, typename gridop::ToMaskGrid<GridType>::Type, InterruptT>
1072 op(grid, interrupt);
1073 return op.process(threaded);
1074}
1075
1076template<typename GridType, typename MaskT, typename InterruptT>
1077typename GridType::Ptr
1078 normalize(const GridType& grid, const MaskT& mask, bool threaded, InterruptT* interrupt)
1079{
1080 Normalize<GridType, MaskT, InterruptT> op(grid, mask, interrupt);
1081 return op.process(threaded);
1082}
1083
1084////////////////////////////////////////
1085
1086
1087// Explicit Template Instantiation
1088
1089#ifdef OPENVDB_USE_EXPLICIT_INSTANTIATION
1090
1091#ifdef OPENVDB_INSTANTIATE_GRIDOPERATORS
1092#include <openvdb/util/ExplicitInstantiation.h>
1093#endif
1094
1095#define _FUNCTION(TreeT) \
1096 ScalarToVectorConverter<Grid<TreeT>>::Type::Ptr cpt(const Grid<TreeT>&, bool, util::NullInterrupter*)
1097 OPENVDB_REAL_TREE_INSTANTIATE(_FUNCTION)
1098#undef _FUNCTION
1099
1100#define _FUNCTION(TreeT) \
1101 ScalarToVectorConverter<Grid<TreeT>>::Type::Ptr cpt(const Grid<TreeT>&, const BoolGrid&, bool, util::NullInterrupter*)
1102 OPENVDB_REAL_TREE_INSTANTIATE(_FUNCTION)
1103#undef _FUNCTION
1104
1105#define _FUNCTION(TreeT) \
1106 Grid<TreeT>::Ptr curl(const Grid<TreeT>&, bool, util::NullInterrupter*)
1107 OPENVDB_VEC3_TREE_INSTANTIATE(_FUNCTION)
1108#undef _FUNCTION
1109
1110#define _FUNCTION(TreeT) \
1111 Grid<TreeT>::Ptr curl(const Grid<TreeT>&, const BoolGrid&, bool, util::NullInterrupter*)
1112 OPENVDB_VEC3_TREE_INSTANTIATE(_FUNCTION)
1113#undef _FUNCTION
1114
1115#define _FUNCTION(TreeT) \
1116 VectorToScalarConverter<Grid<TreeT>>::Type::Ptr divergence(const Grid<TreeT>&, bool, util::NullInterrupter*)
1117 OPENVDB_VEC3_TREE_INSTANTIATE(_FUNCTION)
1118#undef _FUNCTION
1119
1120#define _FUNCTION(TreeT) \
1121 VectorToScalarConverter<Grid<TreeT>>::Type::Ptr divergence(const Grid<TreeT>&, const BoolGrid&, bool, util::NullInterrupter*)
1122 OPENVDB_VEC3_TREE_INSTANTIATE(_FUNCTION)
1123#undef _FUNCTION
1124
1125#define _FUNCTION(TreeT) \
1126 ScalarToVectorConverter<Grid<TreeT>>::Type::Ptr gradient(const Grid<TreeT>&, bool, util::NullInterrupter*)
1127 OPENVDB_REAL_TREE_INSTANTIATE(_FUNCTION)
1128#undef _FUNCTION
1129
1130#define _FUNCTION(TreeT) \
1131 ScalarToVectorConverter<Grid<TreeT>>::Type::Ptr gradient(const Grid<TreeT>&, const BoolGrid&, bool, util::NullInterrupter*)
1132 OPENVDB_REAL_TREE_INSTANTIATE(_FUNCTION)
1133#undef _FUNCTION
1134
1135#define _FUNCTION(TreeT) \
1136 Grid<TreeT>::Ptr laplacian(const Grid<TreeT>&, bool, util::NullInterrupter*)
1137 OPENVDB_NUMERIC_TREE_INSTANTIATE(_FUNCTION)
1138#undef _FUNCTION
1139
1140#define _FUNCTION(TreeT) \
1141 Grid<TreeT>::Ptr laplacian(const Grid<TreeT>&, const BoolGrid&, bool, util::NullInterrupter*)
1142 OPENVDB_NUMERIC_TREE_INSTANTIATE(_FUNCTION)
1143#undef _FUNCTION
1144
1145#define _FUNCTION(TreeT) \
1146 Grid<TreeT>::Ptr meanCurvature(const Grid<TreeT>&, bool, util::NullInterrupter*)
1147 OPENVDB_NUMERIC_TREE_INSTANTIATE(_FUNCTION)
1148#undef _FUNCTION
1149
1150#define _FUNCTION(TreeT) \
1151 Grid<TreeT>::Ptr meanCurvature(const Grid<TreeT>&, const BoolGrid&, bool, util::NullInterrupter*)
1152 OPENVDB_NUMERIC_TREE_INSTANTIATE(_FUNCTION)
1153#undef _FUNCTION
1154
1155#define _FUNCTION(TreeT) \
1156 VectorToScalarConverter<Grid<TreeT>>::Type::Ptr magnitude(const Grid<TreeT>&, bool, util::NullInterrupter*)
1157 OPENVDB_VEC3_TREE_INSTANTIATE(_FUNCTION)
1158#undef _FUNCTION
1159
1160#define _FUNCTION(TreeT) \
1161 VectorToScalarConverter<Grid<TreeT>>::Type::Ptr magnitude(const Grid<TreeT>&, const BoolGrid&, bool, util::NullInterrupter*)
1162 OPENVDB_VEC3_TREE_INSTANTIATE(_FUNCTION)
1163#undef _FUNCTION
1164
1165#define _FUNCTION(TreeT) \
1166 Grid<TreeT>::Ptr normalize(const Grid<TreeT>&, bool, util::NullInterrupter*)
1167 OPENVDB_VEC3_TREE_INSTANTIATE(_FUNCTION)
1168#undef _FUNCTION
1169
1170#define _FUNCTION(TreeT) \
1171 Grid<TreeT>::Ptr normalize(const Grid<TreeT>&, const BoolGrid&, bool, util::NullInterrupter*)
1172 OPENVDB_VEC3_TREE_INSTANTIATE(_FUNCTION)
1173#undef _FUNCTION
1174
1175#endif // OPENVDB_USE_EXPLICIT_INSTANTIATION
1176
1177
1178} // namespace tools
1179} // namespace OPENVDB_VERSION_NAME
1180} // namespace openvdb
1181
1182#endif // OPENVDB_TOOLS_GRID_OPERATORS_HAS_BEEN_INCLUDED
ExplicitInstantiation.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...
NullInterrupter.h
Operators.h
ValueAccessor.h
ValueAccessors are designed to help accelerate accesses into the OpenVDB Tree structures by storing c...
ValueTransformer.h
openvdb::v11_0::Grid
Container class that associates a tree with a transform and metadata.
Definition Grid.h:571
openvdb::v11_0::TopologyCopy
Tag dispatch class that distinguishes topology copy constructors from deep copy constructors.
Definition Types.h:683
openvdb::v11_0::math::Coord
Signed (x, y, z) 32-bit integer coordinates.
Definition Coord.h:25
openvdb::v11_0::math::Transform
Definition Transform.h:40
openvdb::v11_0::math::Transform::Ptr
SharedPtr< Transform > Ptr
Definition Transform.h:42
openvdb::v11_0::math::Vec3
Definition Vec3.h:24
openvdb::v11_0::tools::Cpt
Compute the closest-point transform of a scalar grid.
Definition GridOperators.h:421
openvdb::v11_0::tools::Cpt::Cpt
Cpt(const InGridType &grid, const MaskGridType &mask, InterruptT *interrupt=nullptr)
Definition GridOperators.h:431
openvdb::v11_0::tools::Cpt::Cpt
Cpt(const InGridType &grid, InterruptT *interrupt=nullptr)
Definition GridOperators.h:426
openvdb::v11_0::tools::Cpt::InGridType
InGridT InGridType
Definition GridOperators.h:423
openvdb::v11_0::tools::Cpt::OutGridType
ScalarToVectorConverter< InGridT >::Type OutGridType
Definition GridOperators.h:424
openvdb::v11_0::tools::Cpt::process
OutGridType::Ptr process(bool threaded=true, bool useWorldTransform=true)
Definition GridOperators.h:436
openvdb::v11_0::tools::Curl
Compute the curl of a vector grid.
Definition GridOperators.h:509
openvdb::v11_0::tools::Curl::process
GridT::Ptr process(bool threaded=true)
Definition GridOperators.h:524
openvdb::v11_0::tools::Curl::InGridType
GridT InGridType
Definition GridOperators.h:511
openvdb::v11_0::tools::Curl::Curl
Curl(const GridT &grid, const MaskGridType &mask, InterruptT *interrupt=nullptr)
Definition GridOperators.h:519
openvdb::v11_0::tools::Curl::OutGridType
GridT OutGridType
Definition GridOperators.h:512
openvdb::v11_0::tools::Curl::Curl
Curl(const GridT &grid, InterruptT *interrupt=nullptr)
Definition GridOperators.h:514
openvdb::v11_0::tools::Divergence
Compute the divergence of a vector grid.
Definition GridOperators.h:570
openvdb::v11_0::tools::Divergence::mInterrupt
InterruptT * mInterrupt
Definition GridOperators.h:623
openvdb::v11_0::tools::Divergence::mMask
const MaskGridType * mMask
Definition GridOperators.h:624
openvdb::v11_0::tools::Divergence::InGridType
InGridT InGridType
Definition GridOperators.h:572
openvdb::v11_0::tools::Divergence::Divergence
Divergence(const InGridT &grid, InterruptT *interrupt=nullptr)
Definition GridOperators.h:575
openvdb::v11_0::tools::Divergence::process
OutGridType::Ptr process(bool threaded=true)
Definition GridOperators.h:585
openvdb::v11_0::tools::Divergence::OutGridType
VectorToScalarConverter< InGridT >::Type OutGridType
Definition GridOperators.h:573
openvdb::v11_0::tools::Divergence::Divergence
Divergence(const InGridT &grid, const MaskGridType &mask, InterruptT *interrupt=nullptr)
Definition GridOperators.h:580
openvdb::v11_0::tools::Divergence::mInputGrid
const InGridType & mInputGrid
Definition GridOperators.h:622
openvdb::v11_0::tools::Gradient
Compute the gradient of a scalar grid.
Definition GridOperators.h:637
openvdb::v11_0::tools::Gradient::mInterrupt
InterruptT * mInterrupt
Definition GridOperators.h:684
openvdb::v11_0::tools::Gradient::mMask
const MaskGridType * mMask
Definition GridOperators.h:685
openvdb::v11_0::tools::Gradient::InGridType
InGridT InGridType
Definition GridOperators.h:639
openvdb::v11_0::tools::Gradient::mInputGrid
const InGridT & mInputGrid
Definition GridOperators.h:683
openvdb::v11_0::tools::Gradient::Gradient
Gradient(const InGridT &grid, const MaskGridType &mask, InterruptT *interrupt=nullptr)
Definition GridOperators.h:647
openvdb::v11_0::tools::Gradient::process
OutGridType::Ptr process(bool threaded=true)
Definition GridOperators.h:652
openvdb::v11_0::tools::Gradient::Gradient
Gradient(const InGridT &grid, InterruptT *interrupt=nullptr)
Definition GridOperators.h:642
openvdb::v11_0::tools::Gradient::OutGridType
ScalarToVectorConverter< InGridT >::Type OutGridType
Definition GridOperators.h:640
openvdb::v11_0::tools::Laplacian
Definition GridOperators.h:697
openvdb::v11_0::tools::Laplacian::process
GridT::Ptr process(bool threaded=true)
Definition GridOperators.h:712
openvdb::v11_0::tools::Laplacian::mInterrupt
InterruptT * mInterrupt
Definition GridOperators.h:743
openvdb::v11_0::tools::Laplacian::mInputGrid
const GridT & mInputGrid
Definition GridOperators.h:742
openvdb::v11_0::tools::Laplacian::mMask
const MaskGridType * mMask
Definition GridOperators.h:744
openvdb::v11_0::tools::Laplacian::InGridType
GridT InGridType
Definition GridOperators.h:699
openvdb::v11_0::tools::Laplacian::Laplacian
Laplacian(const GridT &grid, const MaskGridType &mask, InterruptT *interrupt=nullptr)
Definition GridOperators.h:707
openvdb::v11_0::tools::Laplacian::OutGridType
GridT OutGridType
Definition GridOperators.h:700
openvdb::v11_0::tools::Laplacian::Laplacian
Laplacian(const GridT &grid, InterruptT *interrupt=nullptr)
Definition GridOperators.h:702
openvdb::v11_0::tools::Magnitude
Definition GridOperators.h:815
openvdb::v11_0::tools::Magnitude::mInterrupt
InterruptT * mInterrupt
Definition GridOperators.h:866
openvdb::v11_0::tools::Magnitude::mMask
const MaskGridType * mMask
Definition GridOperators.h:867
openvdb::v11_0::tools::Magnitude::InGridType
InGridT InGridType
Definition GridOperators.h:817
openvdb::v11_0::tools::Magnitude::process
OutGridType::Ptr process(bool threaded=true)
Definition GridOperators.h:830
openvdb::v11_0::tools::Magnitude::Magnitude
Magnitude(const InGridType &grid, InterruptT *interrupt=nullptr)
Definition GridOperators.h:820
openvdb::v11_0::tools::Magnitude::OutGridType
VectorToScalarConverter< InGridT >::Type OutGridType
Definition GridOperators.h:818
openvdb::v11_0::tools::Magnitude::Magnitude
Magnitude(const InGridType &grid, const MaskGridType &mask, InterruptT *interrupt=nullptr)
Definition GridOperators.h:825
openvdb::v11_0::tools::Magnitude::mInputGrid
const InGridType & mInputGrid
Definition GridOperators.h:865
openvdb::v11_0::tools::MeanCurvature
Definition GridOperators.h:756
openvdb::v11_0::tools::MeanCurvature::process
GridT::Ptr process(bool threaded=true)
Definition GridOperators.h:771
openvdb::v11_0::tools::MeanCurvature::mInterrupt
InterruptT * mInterrupt
Definition GridOperators.h:802
openvdb::v11_0::tools::MeanCurvature::mInputGrid
const GridT & mInputGrid
Definition GridOperators.h:801
openvdb::v11_0::tools::MeanCurvature::mMask
const MaskGridType * mMask
Definition GridOperators.h:803
openvdb::v11_0::tools::MeanCurvature::MeanCurvature
MeanCurvature(const GridT &grid, const MaskGridType &mask, InterruptT *interrupt=nullptr)
Definition GridOperators.h:766
openvdb::v11_0::tools::MeanCurvature::MeanCurvature
MeanCurvature(const GridT &grid, InterruptT *interrupt=nullptr)
Definition GridOperators.h:761
openvdb::v11_0::tools::MeanCurvature::InGridType
GridT InGridType
Definition GridOperators.h:758
openvdb::v11_0::tools::MeanCurvature::OutGridType
GridT OutGridType
Definition GridOperators.h:759
openvdb::v11_0::tools::Normalize
Definition GridOperators.h:879
openvdb::v11_0::tools::Normalize::process
GridT::Ptr process(bool threaded=true)
Definition GridOperators.h:894
openvdb::v11_0::tools::Normalize::mInterrupt
InterruptT * mInterrupt
Definition GridOperators.h:942
openvdb::v11_0::tools::Normalize::mInputGrid
const GridT & mInputGrid
Definition GridOperators.h:941
openvdb::v11_0::tools::Normalize::mMask
const MaskGridType * mMask
Definition GridOperators.h:943
openvdb::v11_0::tools::Normalize::InGridType
GridT InGridType
Definition GridOperators.h:881
openvdb::v11_0::tools::Normalize::OutGridType
GridT OutGridType
Definition GridOperators.h:882
openvdb::v11_0::tools::Normalize::Normalize
Normalize(const GridT &grid, InterruptT *interrupt=nullptr)
Definition GridOperators.h:884
openvdb::v11_0::tools::Normalize::Normalize
Normalize(const GridT &grid, const MaskGridType &mask, InterruptT *interrupt=nullptr)
Definition GridOperators.h:889
openvdb::v11_0::tools::gridop::GridOperator
Apply an operator to an input grid to produce an output grid with the same active voxel topology but ...
Definition GridOperators.h:303
openvdb::v11_0::tools::gridop::GridOperator::mInterrupt
InterruptT * mInterrupt
Definition GridOperators.h:404
openvdb::v11_0::tools::gridop::GridOperator::mAcc
AccessorT mAcc
Definition GridOperators.h:402
openvdb::v11_0::tools::gridop::GridOperator::mMask
const MaskGridType * mMask
Definition GridOperators.h:405
openvdb::v11_0::tools::gridop::GridOperator::OutTreeT
OutGridT::TreeType OutTreeT
Definition GridOperators.h:305
openvdb::v11_0::tools::gridop::GridOperator::mMap
const MapT & mMap
Definition GridOperators.h:403
openvdb::v11_0::tools::gridop::GridOperator::OutLeafT
OutTreeT::LeafNodeType OutLeafT
Definition GridOperators.h:306
openvdb::v11_0::tools::gridop::GridOperator::GridOperator
GridOperator(const InGridT &grid, const MaskGridType *mask, const MapT &map, InterruptT *interrupt=nullptr, bool densify=true)
Definition GridOperators.h:309
openvdb::v11_0::tools::gridop::GridOperator::mDensify
const bool mDensify
Definition GridOperators.h:406
openvdb::v11_0::tools::gridop::GridOperator::GridOperator
GridOperator(const GridOperator &)=default
openvdb::v11_0::tools::gridop::GridOperator::operator()
void operator()(const typename LeafManagerT::LeafRange &range) const
Iterate sequentially over LeafNodes and voxels in the output grid and apply the operator using a valu...
Definition GridOperators.h:387
openvdb::v11_0::tools::gridop::GridOperator::operator=
GridOperator & operator=(const GridOperator &)=default
openvdb::v11_0::tools::gridop::GridOperator::~GridOperator
virtual ~GridOperator()=default
openvdb::v11_0::tools::gridop::GridOperator::process
OutGridT::Ptr process(bool threaded=true)
Definition GridOperators.h:322
openvdb::v11_0::tools::gridop::GridOperator::AccessorT
InGridT::ConstAccessor AccessorT
Definition GridOperators.h:401
openvdb::v11_0::tools::gridop::GridOperator::LeafManagerT
tree::LeafManager< OutTreeT > LeafManagerT
Definition GridOperators.h:307
openvdb::v11_0::tree::LeafManager::LeafRange
Definition LeafManager.h:102
openvdb::v11_0::tree::LeafManager::LeafRange::begin
Iterator begin() const
Definition LeafManager.h:155
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
openvdb::v11_0::tree::LeafManager::leafRange
LeafRange leafRange(size_t grainsize=1) const
Return a TBB-compatible LeafRange.
Definition LeafManager.h:345
openvdb::v11_0::tools::curl
GridType::Ptr curl(const GridType &grid, bool threaded, InterruptT *interrupt)
Compute the curl of the given vector-valued grid.
Definition GridOperators.h:968
openvdb::v11_0::tools::meanCurvature
GridType::Ptr meanCurvature(const GridType &grid, bool threaded, InterruptT *interrupt)
Compute the mean curvature of the given grid.
Definition GridOperators.h:1035
openvdb::v11_0::tools::gradient
ScalarToVectorConverter< GridType >::Type::Ptr gradient(const GridType &grid, bool threaded, InterruptT *interrupt)
Compute the gradient of the given scalar grid.
Definition GridOperators.h:1001
openvdb::v11_0::tools::magnitude
VectorToScalarConverter< GridType >::Type::Ptr magnitude(const GridType &grid, bool threaded, InterruptT *interrupt)
Compute the magnitudes of the vectors of the given vector-valued grid.
Definition GridOperators.h:1052
openvdb::v11_0::tools::divergence
VectorToScalarConverter< GridType >::Type::Ptr divergence(const GridType &grid, bool threaded, InterruptT *interrupt)
Compute the divergence of the given vector-valued grid.
Definition GridOperators.h:984
openvdb::v11_0::tools::cpt
ScalarToVectorConverter< GridType >::Type::Ptr cpt(const GridType &grid, bool threaded, InterruptT *interrupt)
Compute the Closest-Point Transform (CPT) from a distance field.
Definition GridOperators.h:952
openvdb::v11_0::tools::laplacian
GridType::Ptr laplacian(const GridType &grid, bool threaded, InterruptT *interrupt)
Compute the Laplacian of the given scalar grid.
Definition GridOperators.h:1018
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::GRID_STAGGERED
@ GRID_STAGGERED
Definition Types.h:457
openvdb::v11_0::VecType
VecType
Definition Types.h:483
openvdb::v11_0::VEC_CONTRAVARIANT_ABSOLUTE
@ VEC_CONTRAVARIANT_ABSOLUTE
Definition Types.h:488
openvdb::v11_0::VEC_COVARIANT
@ VEC_COVARIANT
Definition Types.h:485
openvdb::v11_0::VEC_COVARIANT_NORMALIZE
@ VEC_COVARIANT_NORMALIZE
Definition Types.h:486
openvdb
Definition Exceptions.h:13
openvdb.h
openvdb::v11_0::math::CPT_RANGE
Compute the closest-point transform to a level set.
Definition Operators.h:1719
openvdb::v11_0::math::CPT
Compute the closest-point transform to a level set.
Definition Operators.h:1666
openvdb::v11_0::math::Curl
Compute the curl of a vector-valued grid using differencing of various orders in the space defined by...
Definition Operators.h:1275
openvdb::v11_0::math::Divergence
Compute the divergence of a vector-valued grid using differencing of various orders,...
Definition Operators.h:950
openvdb::v11_0::math::Gradient
Center difference gradient operators, defined with respect to the range-space of the map.
Definition Operators.h:620
openvdb::v11_0::math::Laplacian
Compute the Laplacian at a given location in a grid using finite differencing of various orders....
Definition Operators.h:1420
openvdb::v11_0::math::MeanCurvature
Compute the mean curvature.
Definition Operators.h:1762
openvdb::v11_0::tools::Divergence::Functor
Definition GridOperators.h:601
openvdb::v11_0::tools::Divergence::Functor::operator()
void operator()(const MapT &map)
Definition GridOperators.h:607
openvdb::v11_0::tools::Divergence::Functor::mInterrupt
InterruptT * mInterrupt
Definition GridOperators.h:618
openvdb::v11_0::tools::Divergence::Functor::mMask
const MaskGridType * mMask
Definition GridOperators.h:619
openvdb::v11_0::tools::Divergence::Functor::mOutputGrid
OutGridType::Ptr mOutputGrid
Definition GridOperators.h:617
openvdb::v11_0::tools::Divergence::Functor::Functor
Functor(const InGridT &grid, const MaskGridType *mask, bool threaded, InterruptT *interrupt)
Definition GridOperators.h:602
openvdb::v11_0::tools::Divergence::Functor::mThreaded
const bool mThreaded
Definition GridOperators.h:615
openvdb::v11_0::tools::Divergence::Functor::mInputGrid
const InGridType & mInputGrid
Definition GridOperators.h:616
openvdb::v11_0::tools::Gradient::Functor
Definition GridOperators.h:662
openvdb::v11_0::tools::Gradient::Functor::operator()
void operator()(const MapT &map)
Definition GridOperators.h:668
openvdb::v11_0::tools::Gradient::Functor::mInterrupt
InterruptT * mInterrupt
Definition GridOperators.h:679
openvdb::v11_0::tools::Gradient::Functor::mMask
const MaskGridType * mMask
Definition GridOperators.h:680
openvdb::v11_0::tools::Gradient::Functor::mInputGrid
const InGridT & mInputGrid
Definition GridOperators.h:677
openvdb::v11_0::tools::Gradient::Functor::mOutputGrid
OutGridType::Ptr mOutputGrid
Definition GridOperators.h:678
openvdb::v11_0::tools::Gradient::Functor::Functor
Functor(const InGridT &grid, const MaskGridType *mask, bool threaded, InterruptT *interrupt)
Definition GridOperators.h:663
openvdb::v11_0::tools::Gradient::Functor::mThreaded
const bool mThreaded
Definition GridOperators.h:676
openvdb::v11_0::tools::Laplacian::Functor
Definition GridOperators.h:722
openvdb::v11_0::tools::Laplacian::Functor::operator()
void operator()(const MapT &map)
Definition GridOperators.h:727
openvdb::v11_0::tools::Laplacian::Functor::mInterrupt
InterruptT * mInterrupt
Definition GridOperators.h:738
openvdb::v11_0::tools::Laplacian::Functor::mInputGrid
const GridT & mInputGrid
Definition GridOperators.h:736
openvdb::v11_0::tools::Laplacian::Functor::mMask
const MaskGridType * mMask
Definition GridOperators.h:739
openvdb::v11_0::tools::Laplacian::Functor::mOutputGrid
GridT::Ptr mOutputGrid
Definition GridOperators.h:737
openvdb::v11_0::tools::Laplacian::Functor::Functor
Functor(const GridT &grid, const MaskGridType *mask, bool threaded, InterruptT *interrupt)
Definition GridOperators.h:723
openvdb::v11_0::tools::Laplacian::Functor::mThreaded
const bool mThreaded
Definition GridOperators.h:735
openvdb::v11_0::tools::Magnitude::Functor
Definition GridOperators.h:845
openvdb::v11_0::tools::Magnitude::Functor::operator()
void operator()(const MapT &map)
Definition GridOperators.h:851
openvdb::v11_0::tools::Magnitude::Functor::mInterrupt
InterruptT * mInterrupt
Definition GridOperators.h:861
openvdb::v11_0::tools::Magnitude::Functor::mMask
const MaskGridType * mMask
Definition GridOperators.h:862
openvdb::v11_0::tools::Magnitude::Functor::mOutputGrid
OutGridType::Ptr mOutputGrid
Definition GridOperators.h:860
openvdb::v11_0::tools::Magnitude::Functor::Functor
Functor(const InGridT &grid, const MaskGridType *mask, bool threaded, InterruptT *interrupt)
Definition GridOperators.h:846
openvdb::v11_0::tools::Magnitude::Functor::mThreaded
const bool mThreaded
Definition GridOperators.h:858
openvdb::v11_0::tools::Magnitude::Functor::mInputGrid
const InGridType & mInputGrid
Definition GridOperators.h:859
openvdb::v11_0::tools::Magnitude::OpT
Definition GridOperators.h:839
openvdb::v11_0::tools::Magnitude::OpT::result
static OutGridType::ValueType result(const MapT &, const AccT &acc, const Coord &xyz)
Definition GridOperators.h:842
openvdb::v11_0::tools::MeanCurvature::Functor
Definition GridOperators.h:781
openvdb::v11_0::tools::MeanCurvature::Functor::operator()
void operator()(const MapT &map)
Definition GridOperators.h:786
openvdb::v11_0::tools::MeanCurvature::Functor::mInterrupt
InterruptT * mInterrupt
Definition GridOperators.h:797
openvdb::v11_0::tools::MeanCurvature::Functor::mInputGrid
const GridT & mInputGrid
Definition GridOperators.h:795
openvdb::v11_0::tools::MeanCurvature::Functor::mMask
const MaskGridType * mMask
Definition GridOperators.h:798
openvdb::v11_0::tools::MeanCurvature::Functor::mOutputGrid
GridT::Ptr mOutputGrid
Definition GridOperators.h:796
openvdb::v11_0::tools::MeanCurvature::Functor::Functor
Functor(const GridT &grid, const MaskGridType *mask, bool threaded, InterruptT *interrupt)
Definition GridOperators.h:782
openvdb::v11_0::tools::MeanCurvature::Functor::mThreaded
const bool mThreaded
Definition GridOperators.h:794
openvdb::v11_0::tools::Normalize::Functor
Definition GridOperators.h:922
openvdb::v11_0::tools::Normalize::Functor::operator()
void operator()(const MapT &map)
Definition GridOperators.h:927
openvdb::v11_0::tools::Normalize::Functor::mInterrupt
InterruptT * mInterrupt
Definition GridOperators.h:937
openvdb::v11_0::tools::Normalize::Functor::mInputGrid
const GridT & mInputGrid
Definition GridOperators.h:935
openvdb::v11_0::tools::Normalize::Functor::mMask
const MaskGridType * mMask
Definition GridOperators.h:938
openvdb::v11_0::tools::Normalize::Functor::mOutputGrid
GridT::Ptr mOutputGrid
Definition GridOperators.h:936
openvdb::v11_0::tools::Normalize::Functor::Functor
Functor(const GridT &grid, const MaskGridType *mask, bool threaded, InterruptT *interrupt)
Definition GridOperators.h:923
openvdb::v11_0::tools::Normalize::Functor::mThreaded
const bool mThreaded
Definition GridOperators.h:934
openvdb::v11_0::tools::Normalize::OpT
Definition GridOperators.h:911
openvdb::v11_0::tools::Normalize::OpT::result
static OutGridType::ValueType result(const MapT &, const AccT &acc, const Coord &xyz)
Definition GridOperators.h:914
openvdb::v11_0::tools::ScalarToVectorConverter
ScalarToVectorConverter<ScalarGridType>::Type is the type of a grid having the same tree configuratio...
Definition GridOperators.h:42
openvdb::v11_0::tools::ScalarToVectorConverter::VectorValueT
math::Vec3< typename ScalarGridType::ValueType > VectorValueT
Definition GridOperators.h:43
openvdb::v11_0::tools::ScalarToVectorConverter::Type
ScalarGridType::template ValueConverter< VectorValueT >::Type Type
Definition GridOperators.h:44
openvdb::v11_0::tools::VectorToScalarConverter
VectorToScalarConverter<VectorGridType>::Type is the type of a grid having the same tree configuratio...
Definition GridOperators.h:33
openvdb::v11_0::tools::VectorToScalarConverter::Type
VectorGridType::template ValueConverter< VecComponentValueT >::Type Type
Definition GridOperators.h:35
openvdb::v11_0::tools::VectorToScalarConverter::VecComponentValueT
VectorGridType::ValueType::value_type VecComponentValueT
Definition GridOperators.h:34
openvdb::v11_0::tools::gridop::ToMaskGrid
ToMaskGrid<T>::Type is the type of a grid having the same tree hierarchy as grid type T but a value e...
Definition GridOperators.h:285
openvdb::v11_0::tools::gridop::ToMaskGrid::Type
Grid< typename GridType::TreeType::template ValueConverter< ValueMask >::Type > Type
Definition GridOperators.h:286
openvdb::v11_0::util::NullInterrupter
Base class for interrupters.
Definition NullInterrupter.h:26
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_NUMERIC_TREE_INSTANTIATE
#define OPENVDB_NUMERIC_TREE_INSTANTIATE(Function)
Definition version.h.in:158
OPENVDB_REAL_TREE_INSTANTIATE
#define OPENVDB_REAL_TREE_INSTANTIATE(Function)
Definition version.h.in:157
OPENVDB_VEC3_TREE_INSTANTIATE
#define OPENVDB_VEC3_TREE_INSTANTIATE(Function)
Definition version.h.in:159