OpenVDB: SparseExtractor< OpType, DenseType > Class Template Reference

OpenVDB 9.1.0

Public Types | Public Member Functions | List of all members
SparseExtractor< OpType, DenseType > Class Template Reference

Functor-based class used to extract data that satisfies some criteria defined by the embedded `OpType` functor. The `extractSparseTree` function wraps this class. More...

`#include <openvdb/tools/DenseSparseTools.h>`

## Public Types
using | Index = openvdb::math::Coord::ValueType
using | DenseValueType = typename DenseType::ValueType
using | ResultTreeType = typename OpType::ResultTreeType
using | ResultValueType = typename ResultTreeType::ValueType
using | ResultLeafNodeType = typename ResultTreeType::LeafNodeType
using | MaskTree = typename ResultTreeType::template ValueConverter< ValueMask >::Type
using | Range3d = tbb::blocked_range3d< Index, Index, Index >

## Public Member Functions
| SparseExtractor (const DenseType &dense, const OpType &functor, const ResultValueType background)
| SparseExtractor (const DenseType &dense, const openvdb::math::CoordBBox &bbox, const OpType &functor, const ResultValueType background)
| SparseExtractor (SparseExtractor &other, tbb::split)
ResultTreeType::Ptr | extract (bool threaded=true)
void | operator() (const Range3d &range)
void | join (SparseExtractor &rhs)

## Detailed Description

template<typename OpType, typename DenseType>
class openvdb::v9_1::tools::SparseExtractor< OpType, DenseType >

Functor-based class used to extract data that satisfies some criteria defined by the embedded `OpType` functor. The `extractSparseTree` function wraps this class.

## Member Typedef Documentation

## ◆ DenseValueType

using DenseValueType = typename DenseType::ValueType

## ◆ Index

using Index = openvdb::math::Coord::ValueType

## ◆ MaskTree

using MaskTree = typename ResultTreeType::template ValueConverter<ValueMask>::Type

## ◆ Range3d

using Range3d = tbb::blocked_range3d<Index, Index, Index>

## ◆ ResultLeafNodeType

using ResultLeafNodeType = typename ResultTreeType::LeafNodeType

## ◆ ResultTreeType

using ResultTreeType = typename OpType::ResultTreeType

## ◆ ResultValueType

using ResultValueType = typename ResultTreeType::ValueType

## Constructor & Destructor Documentation

## ◆ SparseExtractor() [1/3]

SparseExtractor | ( | const DenseType & | dense,
|  | const OpType & | functor,
|  | const ResultValueType | background
| ) |  |
| inline

## ◆ SparseExtractor() [2/3]

SparseExtractor | ( | const DenseType & | dense,
|  | const openvdb::math::CoordBBox & | bbox,
|  | const OpType & | functor,
|  | const ResultValueType | background
| ) |  |
| inline

## ◆ SparseExtractor() [3/3]

SparseExtractor | ( | SparseExtractor< OpType, DenseType > & | other,
|  | tbb::split |
| ) |  |
| inline

## Member Function Documentation

## ◆ extract()

ResultTreeType::Ptr extract | ( | bool | threaded = `true` | ) |
| inline

## ◆ join()

void join | ( | SparseExtractor< OpType, DenseType > & | rhs | ) |
| inline

## ◆ operator()()

void operator() | ( | const Range3d & | range | ) |
| inline