vtkm::worklet::MaskSelect Class Reference

Mask using arrays to select specific elements to suppress. More...

#include <MaskSelect.h>

Inheritance diagram for vtkm::worklet::MaskSelect:

Public Types
using	ThreadToOutputMapType = vtkm::cont::ArrayHandle< vtkm::Id >

Public Member Functions
	MaskSelect (const vtkm::cont::UnknownArrayHandle &maskArray, vtkm::cont::DeviceAdapterId device=vtkm::cont::DeviceAdapterTagAny())
template<typename RangeType >
vtkm::Id	GetThreadRange (RangeType vtkmNotUsed(outputRange)) const
template<typename RangeType >
ThreadToOutputMapType	GetThreadToOutputMap (RangeType vtkmNotUsed(outputRange)) const

Private Types
using	MaskTypes = vtkm::List< vtkm::Int32, vtkm::Int64, vtkm::UInt32, vtkm::UInt64, vtkm::Int8, vtkm::UInt8, char >

Private Member Functions
VTKM_CONT ThreadToOutputMapType	Build (const vtkm::cont::UnknownArrayHandle &maskArray, vtkm::cont::DeviceAdapterId device)

Private Attributes
ThreadToOutputMapType	ThreadToOutputMap

Detailed Description

Mask using arrays to select specific elements to suppress.

MaskSelect is a worklet mask object that is used to select elements in the output of a worklet to suppress the invocation. That is, the worklet will only be invoked for elements in the output that are not masked out by the given array.

MaskSelect is initialized with a mask array. This array should contain a 0 for any entry that should be masked and a 1 for any output that should be generated. It is an error to have any value that is not a 0 or 1. This method is slower than specifying an index array.

Member Typedef Documentation

MaskTypes

using vtkm::worklet::MaskSelect::MaskTypes = vtkm::List<vtkm::Int32, vtkm::Int64, vtkm::UInt32, vtkm::UInt64, vtkm::Int8, vtkm::UInt8, char>

private

ThreadToOutputMapType

using vtkm::worklet::MaskSelect::ThreadToOutputMapType = vtkm::cont::ArrayHandle<vtkm::Id>

Constructor & Destructor Documentation

MaskSelect()

vtkm::worklet::MaskSelect::MaskSelect ( const vtkm::cont::UnknownArrayHandle &  maskArray, vtkm::cont::DeviceAdapterId  device = vtkm::cont::DeviceAdapterTagAny()  )

inline

Member Function Documentation

Build()

VTKM_CONT ThreadToOutputMapType vtkm::worklet::MaskSelect::Build ( const vtkm::cont::UnknownArrayHandle &  maskArray, vtkm::cont::DeviceAdapterId  device  )

private

GetThreadRange()

template<typename RangeType >

vtkm::Id vtkm::worklet::MaskSelect::GetThreadRange ( RangeType   vtkmNotUsedoutputRange ) const

inline

GetThreadToOutputMap()

template<typename RangeType >

ThreadToOutputMapType vtkm::worklet::MaskSelect::GetThreadToOutputMap ( RangeType   vtkmNotUsedoutputRange ) const

inline

Member Data Documentation

ThreadToOutputMap

ThreadToOutputMapType vtkm::worklet::MaskSelect::ThreadToOutputMap

private

---

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

• MaskSelect.h