OpenVDB: SparseMaskedExtractor< DenseType, MaskTreeType > Class Template Reference

OpenVDB 6.1.0

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

Functor-based class used to extract data from a dense grid, at the index-space intersection with a supplied mask in the form of a sparse tree. The `extractSparseTreeWithMask` function wraps this class. More...

`#include <DenseSparseTools.h>`

## Public Types
using | _ResultTreeType = typename DSConverter< DenseType, MaskTreeType >::Type
using | ResultTreeType = _ResultTreeType
using | ResultLeafNodeType = typename ResultTreeType::LeafNodeType
using | ResultValueType = typename ResultTreeType::ValueType
using | DenseValueType = ResultValueType
using | MaskTree = typename ResultTreeType::template ValueConverter< ValueMask >::Type
using | MaskLeafCIter = typename MaskTree::LeafCIter
using | MaskLeafVec = std::vector< const typename MaskTree::LeafNodeType * >

## Public Member Functions
| SparseMaskedExtractor (const DenseType &dense, const ResultValueType &background, const MaskLeafVec &leafVec)
| SparseMaskedExtractor (const SparseMaskedExtractor &other, tbb::split)
ResultTreeType::Ptr | extract (bool threaded=true)
void | operator() (const tbb::blocked_range< size_t > &range)
void | join (SparseMaskedExtractor &rhs)

## Detailed Description

### template<typename DenseType, typename MaskTreeType>
class openvdb::v6_1::tools::SparseMaskedExtractor< DenseType, MaskTreeType >

Functor-based class used to extract data from a dense grid, at the index-space intersection with a supplied mask in the form of a sparse tree. The `extractSparseTreeWithMask` function wraps this class.

## Member Typedef Documentation

## ◆ _ResultTreeType

using _ResultTreeType = typename DSConverter<DenseType, MaskTreeType>::Type

## ◆ DenseValueType

using DenseValueType = ResultValueType

## ◆ MaskLeafCIter

using MaskLeafCIter = typename MaskTree::LeafCIter

## ◆ MaskLeafVec

using MaskLeafVec = std::vector<const typename MaskTree::LeafNodeType*>

## ◆ MaskTree

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

## ◆ ResultLeafNodeType

using ResultLeafNodeType = typename ResultTreeType::LeafNodeType

## ◆ ResultTreeType

using ResultTreeType = _ResultTreeType

## ◆ ResultValueType

using ResultValueType = typename ResultTreeType::ValueType

## Constructor & Destructor Documentation

## ◆ SparseMaskedExtractor() [1/2]

SparseMaskedExtractor | ( | const DenseType & | dense,
|  | const ResultValueType & | background,
|  | const MaskLeafVec & | leafVec
| ) |  |
| inline

## ◆ SparseMaskedExtractor() [2/2]

SparseMaskedExtractor | ( | const SparseMaskedExtractor< DenseType, MaskTreeType > & | other,
|  | tbb::split |
| ) |  |
| inline

## Member Function Documentation

## ◆ extract()

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

## ◆ join()

void join | ( | SparseMaskedExtractor< DenseType, MaskTreeType > & | rhs | ) |
| inline

## ◆ operator()()

void operator() | ( | const tbb::blocked_range< size_t > & | range | ) |
| inline

The documentation for this class was generated from the following file:

- DenseSparseTools.h