A control signature tag for neighborhood input values. More...
#include <WorkletPointNeighborhood.h>
Additional Inherited Members | |
 Public Types inherited from vtkm::worklet::WorkletNeighborhood::FieldInNeighborhood | |
| using | TypeCheckTag = vtkm::cont::arg::TypeCheckTagArrayIn |
| using | TransportTag = vtkm::cont::arg::TransportTagArrayIn |
| using | FetchTag = vtkm::exec::arg::FetchTagArrayNeighborhoodIn |
Detailed Description
A control signature tag for neighborhood input values.
A neighborhood worklet operates by allowing access to a adjacent element values in a NxNxN patch called a neighborhood. No matter the size of the neighborhood it is symmetric across its center in each axis, and the current point value will be at the center For example a 3x3x3 neighborhood would have local indices ranging from -1 to 1 in each dimension.
This tag specifies a vtkm::cont::ArrayHandle object that holds the values. It is an input array with entries for each element.
What differentiates FieldInNeighborhood from FieldIn is that FieldInNeighborhood allows the worklet function to access the field value at the element it is visiting and the field values in the neighborhood around it. Thus, instead of getting a single value out of the array, each invocation of the worklet gets a vtkm::exec::FieldNeighborhood object. These objects allow retrieval of field values using indices relative to the visited element.
The documentation for this struct was generated from the following file:
