VTK-m  1.6
Namespaces | Classes | Typedefs | Enumerations | Functions
vtkm::filter Namespace Reference

VTK-m Filters. More...

Namespaces

 particleadvection
 

Classes

class  CellAverage
 Point to cell interpolation filter. More...
 
class  CellMeasures
 Compute the measure of each (3D) cell in a dataset. More...
 
class  CellSetConnectivity
 Finds groups of cells that are connected together through their topology. More...
 
class  CleanGrid
 Clean a mesh to an unstructured grid. More...
 
class  ClipWithField
 Clip a dataset using a field. More...
 
class  ClipWithImplicitFunction
 Clip a dataset using an implicit function. More...
 
class  ComputeMoments
 
class  Contour
 generate isosurface(s) from a Volume More...
 
class  ContourTreeAugmented
 Construct the Contour Tree for a 2D or 3D regular mesh. More...
 
class  ContourTreeMesh2D
 Construct the ContourTree for a 2D Mesh. More...
 
class  ContourTreeMesh3D
 Construct the ContourTree for a 3D Mesh. More...
 
class  ContourTreeUniformDistributed
 Construct the Contour Tree for a 2D or 3D regular mesh. More...
 
class  CrossProduct
 
class  CylindricalCoordinateTransform
 Generate a coordinate transformation on coordiantes from a dataset. More...
 
struct  DeduceFilterFieldStorage
 
struct  DeduceFilterFieldTypes
 
class  DotProduct
 
class  Entropy
 Construct the entropy histogram of a given Field. More...
 
class  ExternalFaces
 Extract external faces of a geometry. More...
 
class  ExtractGeometry
 Extract a subset of geometry based on an implicit function. More...
 
class  ExtractPoints
 Extract only points from a geometry using an implicit function. More...
 
class  ExtractStructured
 Select piece (e.g., volume of interest) and/or subsample structured points dataset. More...
 
class  FieldMetadata
 
class  FieldSelection
 A FieldSelection stores information about fields to map for input dataset to output when a filter is executed. More...
 
class  FieldToColors
 Convert an arbitrary field to an RGB or RGBA field. More...
 
class  Filter
 base class for all filters. More...
 
class  FilterDataSet
 
class  FilterDataSetWithField
 
class  FilterField
 
struct  FilterTraits
 
struct  GhostCellClassify
 
class  GhostCellRemove
 Removes ghost cells. More...
 
struct  GhostCellRemovePolicy
 
class  Gradient
 A general filter for gradient estimation. More...
 
class  Histogram
 Construct the histogram of a given Field. More...
 
class  ImageConnectivity
 
class  ImageDifference
 Construct an ImageDifference of a given DataSet. More...
 
class  ImageMedian
 
class  Lagrangian
 
class  LagrangianStructures
 
class  Mask
 Subselect cells using a stride. More...
 
class  MaskPoints
 Subselect points using a stride. More...
 
class  MeshQuality
 Computes the quality of an unstructured cell-based mesh. More...
 
class  NDEntropy
 Calculate the entropy of input N-Dims fields. More...
 
class  NDHistogram
 Generate a N-Dims histogram from input fields. More...
 
class  ParticleAdvection
 advect particles in a vector field. More...
 
class  ParticleDensityNearestGridPoint
 Estimate the density of particles using the Nearest Grid Point method. More...
 
class  Pathline
 generate streamlines from a vector field. More...
 
class  PointAverage
 Cell to Point interpolation filter. More...
 
class  PointElevation
 generate a scalar field along a specified direction More...
 
class  PointTransform
 Generate scalar field from a dataset. More...
 
struct  PolicyBase
 
struct  PolicyDefault
 
class  Probe
 
class  SphericalCoordinateTransform
 
class  SplitSharpEdges
 Split sharp manifold edges where the feature angle between the adjacent surfaces are larger than the threshold value. More...
 
class  Streamline
 generate streamlines from a vector field. More...
 
class  StreamSurface
 generate streamlines from a vector field. More...
 
class  SurfaceNormals
 compute normals for polygonal mesh More...
 
class  Tetrahedralize
 
class  Threshold
 Extracts cells where scalar value in cell satisfies threshold criterion. More...
 
class  ThresholdPoints
 
class  Triangulate
 
class  Tube
 generate tube geometry from polylines. More...
 
class  VectorMagnitude
 
class  VertexClustering
 Reduce the number of triangles in a mesh. More...
 
class  WarpScalar
 Modify points by moving points along point normals by the scalar amount times the scalar factor. More...
 
class  WarpVector
 Modify points by moving points along a vector multiplied by the scale factor. More...
 
class  ZFPCompressor1D
 Compress a scalar field using ZFP. More...
 
class  ZFPCompressor2D
 Compress a scalar field using ZFP. More...
 
class  ZFPCompressor3D
 Compress a scalar field using ZFP. More...
 
class  ZFPDecompressor1D
 Compress a scalar field using ZFP. More...
 
class  ZFPDecompressor2D
 Compress a scalar field using ZFP. More...
 
class  ZFPDecompressor3D
 Compress a scalar field using ZFP. More...
 

Typedefs

using FilterCell = vtkm::filter::FilterField< Derived >
 

Enumerations

enum  CellMetric {
  CellMetric::AREA, CellMetric::ASPECT_GAMMA, CellMetric::ASPECT_RATIO, CellMetric::CONDITION,
  CellMetric::DIAGONAL_RATIO, CellMetric::DIMENSION, CellMetric::JACOBIAN, CellMetric::MAX_ANGLE,
  CellMetric::MAX_DIAGONAL, CellMetric::MIN_ANGLE, CellMetric::MIN_DIAGONAL, CellMetric::ODDY,
  CellMetric::RELATIVE_SIZE_SQUARED, CellMetric::SCALED_JACOBIAN, CellMetric::SHAPE, CellMetric::SHAPE_AND_SIZE,
  CellMetric::SHEAR, CellMetric::SKEW, CellMetric::STRETCH, CellMetric::TAPER,
  CellMetric::VOLUME, CellMetric::WARPAGE, CellMetric::NUMBER_OF_CELL_METRICS, CellMetric::EMPTY
}
 

Functions

 VTKM_FILTER_COMMON_EXPORT_EXECUTE_METHOD (CellAverage)
 
 VTKM_FILTER_EXTRA_EXPORT_EXECUTE_METHOD (ClipWithField)
 
 VTKM_FILTER_EXTRA_EXPORT_EXECUTE_METHOD (ClipWithImplicitFunction)
 
VTKM_CONT vtkm::cont::DataSet CreateResult (const vtkm::cont::DataSet &inDataSet, const vtkm::cont::Field &field)
 These are utility functions defined to use in filters when creating an output dataset to return from DoExecute methods. More...
 
template<typename T , typename Storage >
VTKM_CONT vtkm::cont::DataSet CreateResult (const vtkm::cont::DataSet &inDataSet, const vtkm::cont::ArrayHandle< T, Storage > &fieldArray, const std::string &fieldName, const vtkm::filter::FieldMetadata &metaData)
 Use this function if you have an ArrayHandle that holds the data for the field. More...
 
VTKM_CONT vtkm::cont::DataSet CreateResult (const vtkm::cont::DataSet &inDataSet, const vtkm::cont::VariantArrayHandle &fieldArray, const std::string &fieldName, const vtkm::filter::FieldMetadata &metaData)
 Use this function if you have a VariantArrayHandle that holds the data for the field. More...
 
template<typename T , typename Storage >
VTKM_CONT vtkm::cont::DataSet CreateResultFieldCell (const vtkm::cont::DataSet &inDataSet, const vtkm::cont::ArrayHandle< T, Storage > &fieldArray, const std::string &fieldName)
 Use this function if you want to explicit construct a Cell field and have a ArrayHandle that holds the data for the field. More...
 
VTKM_CONT vtkm::cont::DataSet CreateResultFieldCell (const vtkm::cont::DataSet &inDataSet, const vtkm::cont::VariantArrayHandle &fieldArray, const std::string &fieldName)
 Use this function if you want to explicit construct a Cell field and have a VariantArrayHandle that holds the data for the field. More...
 
template<typename T , typename Storage >
VTKM_CONT vtkm::cont::DataSet CreateResultFieldPoint (const vtkm::cont::DataSet &inDataSet, const vtkm::cont::ArrayHandle< T, Storage > &fieldArray, const std::string &fieldName)
 Use this function if you want to explicit construct a Point field and have a ArrayHandle that holds the data for the field. More...
 
VTKM_CONT vtkm::cont::DataSet CreateResultFieldPoint (const vtkm::cont::DataSet &inDataSet, const vtkm::cont::VariantArrayHandle &fieldArray, const std::string &fieldName)
 Use this function if you want to explicit construct a Point field and have a VariantArrayHandle that holds the data for the field. More...
 
VTKM_FILTER_COMMON_EXPORT VTKM_CONT bool MapFieldMergeAverage (const vtkm::cont::Field &inputField, const vtkm::worklet::internal::KeysBase &keys, vtkm::cont::Field &outputField)
 Maps a field by merging entries based on a keys object. More...
 
VTKM_FILTER_COMMON_EXPORT VTKM_CONT bool MapFieldMergeAverage (const vtkm::cont::Field &inputField, const vtkm::worklet::internal::KeysBase &keys, vtkm::cont::DataSet &outputData)
 Maps a field by merging entries based on a keys object. More...
 
VTKM_FILTER_COMMON_EXPORT VTKM_CONT bool MapFieldPermutation (const vtkm::cont::Field &inputField, const vtkm::cont::ArrayHandle< vtkm::Id > &permutation, vtkm::cont::Field &outputField, vtkm::Float64 invalidValue=vtkm::Nan< vtkm::Float64 >())
 Maps a field by permuting it by a given index array. More...
 
VTKM_FILTER_COMMON_EXPORT VTKM_CONT bool MapFieldPermutation (const vtkm::cont::Field &inputField, const vtkm::cont::ArrayHandle< vtkm::Id > &permutation, vtkm::cont::DataSet &outputData, vtkm::Float64 invalidValue=vtkm::Nan< vtkm::Float64 >())
 Maps a field by permuting it by a given index array. More...
 
 VTKM_FILTER_COMMON_EXPORT_EXECUTE_METHOD (PointAverage)
 
template<typename DerivedPolicy >
VTKM_CONT vtkm::cont::UncertainArrayHandle< typename std::conditional< std::is_same< typename DerivedPolicy::FieldTypeList, vtkm::ListUniversal >::value, VTKM_DEFAULT_TYPE_LIST, typename DerivedPolicy::FieldTypeList >::type, typename DerivedPolicy::StorageList > ApplyPolicyFieldNotActive (const vtkm::cont::Field &field, vtkm::filter::PolicyBase< DerivedPolicy >)
 Get an array from a Field that is not the active field. More...
 
template<typename T , typename DerivedPolicy , typename FilterType >
VTKM_CONT internal::ArrayHandleMultiplexerForStorageList< T, vtkm::ListAppend< typename vtkm::filter::FilterTraits< FilterType >::AdditionalFieldStorage, typename DerivedPolicy::StorageList > > ApplyPolicyFieldOfType (const vtkm::cont::Field &field, vtkm::filter::PolicyBase< DerivedPolicy >, const FilterType &)
 Get an ArrayHandle of a specific type from a Field. More...
 
template<typename DerivedPolicy , typename FilterType >
VTKM_CONT vtkm::cont::VariantArrayHandleBase< typename vtkm::filter::DeduceFilterFieldTypes< DerivedPolicy, typename vtkm::filter::FilterTraits< FilterType >::InputFieldTypeList >::TypeList > ApplyPolicyFieldActive (const vtkm::cont::Field &field, vtkm::filter::PolicyBase< DerivedPolicy >, vtkm::filter::FilterTraits< FilterType >)
 Get an array from a Field that follows the types of an active field. More...
 
template<typename DerivedPolicy , typename DerivedFilter >
VTKM_CONT vtkm::cont::DynamicCellSetBase< vtkm::ListAppend< typename DerivedFilter::SupportedCellSets, typename DerivedPolicy::AllCellSetList > > ApplyPolicyCellSet (const vtkm::cont::DynamicCellSet &cellset, vtkm::filter::PolicyBase< DerivedPolicy >, const vtkm::filter::Filter< DerivedFilter > &)
 Ge a cell set from a DynamicCellSet object. More...
 
template<typename DerivedPolicy >
VTKM_CONT vtkm::cont::DynamicCellSetBase< typename DerivedPolicy::AllCellSetList > ApplyPolicyCellSet (const vtkm::cont::DynamicCellSet &cellset, vtkm::filter::PolicyBase< DerivedPolicy >)
 
template<typename DerivedPolicy , typename DerivedFilter >
VTKM_CONT vtkm::cont::DynamicCellSetBase< vtkm::ListAppend< typename DerivedFilter::SupportedStructuredCellSets, typename DerivedPolicy::StructuredCellSetList > > ApplyPolicyCellSetStructured (const vtkm::cont::DynamicCellSet &cellset, vtkm::filter::PolicyBase< DerivedPolicy >, const vtkm::filter::Filter< DerivedFilter > &)
 Get a structured cell set from a DynamicCellSet object. More...
 
template<typename DerivedPolicy >
VTKM_CONT vtkm::cont::DynamicCellSetBase< typename DerivedPolicy::StructuredCellSetList > ApplyPolicyCellSetStructured (const vtkm::cont::DynamicCellSet &cellset, vtkm::filter::PolicyBase< DerivedPolicy >)
 
template<typename DerivedPolicy , typename DerivedFilter >
VTKM_CONT vtkm::cont::DynamicCellSetBase< vtkm::ListAppend< typename DerivedFilter::SupportedUnstructuredCellSets, typename DerivedPolicy::UnstructuredCellSetList > > ApplyPolicyCellSetUnstructured (const vtkm::cont::DynamicCellSet &cellset, vtkm::filter::PolicyBase< DerivedPolicy >, const vtkm::filter::Filter< DerivedFilter > &)
 Get an unstructured cell set from a DynamicCellSet object. More...
 
template<typename DerivedPolicy >
VTKM_CONT vtkm::cont::DynamicCellSetBase< typename DerivedPolicy::UnstructuredCellSetList > ApplyPolicyCellSetUnstructured (const vtkm::cont::DynamicCellSet &cellset, vtkm::filter::PolicyBase< DerivedPolicy >)
 
template<typename DerivedPolicy >
VTKM_DEPRECATED_SUPPRESS_BEGIN VTKM_CONT vtkm::cont::SerializableField< typename DerivedPolicy::FieldTypeList > MakeSerializableField (vtkm::filter::PolicyBase< DerivedPolicy >)
 
template<typename DerivedPolicy >
VTKM_CONT vtkm::cont::SerializableField< typename DerivedPolicy::FieldTypeList > MakeSerializableField (const vtkm::cont::Field &field, vtkm::filter::PolicyBase< DerivedPolicy >)
 
template<typename DerivedPolicy >
VTKM_DEPRECATED_SUPPRESS_END VTKM_CONT vtkm::cont::SerializableDataSet< typename DerivedPolicy::FieldTypeList, typename DerivedPolicy::AllCellSetList > MakeSerializableDataSet (vtkm::filter::PolicyBase< DerivedPolicy >)
 
template<typename DerivedPolicy , typename DerivedFilter >
VTKM_CONT vtkm::cont::SerializableDataSet< typename DerivedPolicy::FieldTypeList, vtkm::ListAppend< typename DerivedFilter::SupportedCellSets, typename DerivedPolicy::AllCellSetList > > MakeSerializableDataSet (vtkm::filter::PolicyBase< DerivedPolicy >, const vtkm::filter::Filter< DerivedFilter > &)
 
template<typename DerivedFilter >
VTKM_CONT vtkm::cont::SerializableDataSet< VTKM_DEFAULT_TYPE_LIST, typename DerivedFilter::SupportedCellSets > MakeSerializableDataSet (const vtkm::filter::Filter< DerivedFilter > &)
 
template<typename DerivedPolicy >
VTKM_CONT vtkm::cont::SerializableDataSet< typename DerivedPolicy::FieldTypeList, typename DerivedPolicy::AllCellSetList > MakeSerializableDataSet (const vtkm::cont::DataSet &dataset, vtkm::filter::PolicyBase< DerivedPolicy >)
 
template<typename DerivedPolicy , typename DerivedFilter >
VTKM_CONT vtkm::cont::SerializableDataSet< typename DerivedPolicy::FieldTypeList, vtkm::ListAppend< typename DerivedFilter::SupportedCellSets, typename DerivedPolicy::AllCellSetList > > MakeSerializableDataSet (const vtkm::cont::DataSet &dataset, vtkm::filter::PolicyBase< DerivedPolicy >, const vtkm::filter::Filter< DerivedFilter > &)
 
template<typename DerivedFilter >
VTKM_CONT vtkm::cont::SerializableDataSet< VTKM_DEFAULT_TYPE_LIST, typename DerivedFilter::SupportedCellSets > MakeSerializableDataSet (const vtkm::cont::DataSet &dataset, const vtkm::filter::Filter< DerivedFilter > &)
 
 VTKM_FILTER_COMMON_EXPORT_EXECUTE_METHOD (Threshold)
 
 VTKM_FILTER_EXTRA_EXPORT_EXECUTE_METHOD (VectorMagnitude)
 

Detailed Description

VTK-m Filters.

vtkm::filter is the collection of predefined filters that take data as input and write new data as output. Filters operate on vtkm::cont::DataSet objects, vtkm::cont::Fields, and other runtime typeless objects.

Typedef Documentation

◆ FilterCell

Enumeration Type Documentation

◆ CellMetric

Enumerator
AREA 
ASPECT_GAMMA 
ASPECT_RATIO 
CONDITION 
DIAGONAL_RATIO 
DIMENSION 
JACOBIAN 
MAX_ANGLE 
MAX_DIAGONAL 
MIN_ANGLE 
MIN_DIAGONAL 
ODDY 
RELATIVE_SIZE_SQUARED 
SCALED_JACOBIAN 
SHAPE 
SHAPE_AND_SIZE 
SHEAR 
SKEW 
STRETCH 
TAPER 
VOLUME 
WARPAGE 
NUMBER_OF_CELL_METRICS 
EMPTY 

Function Documentation

◆ ApplyPolicyCellSet() [1/2]

template<typename DerivedPolicy >
VTKM_CONT vtkm::cont::DynamicCellSetBase<typename DerivedPolicy::AllCellSetList> vtkm::filter::ApplyPolicyCellSet ( const vtkm::cont::DynamicCellSet cellset,
vtkm::filter::PolicyBase< DerivedPolicy >   
)

◆ ApplyPolicyCellSet() [2/2]

template<typename DerivedPolicy , typename DerivedFilter >
VTKM_CONT vtkm::cont::DynamicCellSetBase<vtkm::ListAppend<typename DerivedFilter::SupportedCellSets, typename DerivedPolicy::AllCellSetList> > vtkm::filter::ApplyPolicyCellSet ( const vtkm::cont::DynamicCellSet cellset,
vtkm::filter::PolicyBase< DerivedPolicy >  ,
const vtkm::filter::Filter< DerivedFilter > &   
)

Ge a cell set from a DynamicCellSet object.

Adjusts the types of CellSets to support those types specified in a policy.

◆ ApplyPolicyCellSetStructured() [1/2]

template<typename DerivedPolicy >
VTKM_CONT vtkm::cont:: DynamicCellSetBase<typename DerivedPolicy::StructuredCellSetList> vtkm::filter::ApplyPolicyCellSetStructured ( const vtkm::cont::DynamicCellSet cellset,
vtkm::filter::PolicyBase< DerivedPolicy >   
)

◆ ApplyPolicyCellSetStructured() [2/2]

template<typename DerivedPolicy , typename DerivedFilter >
VTKM_CONT vtkm::cont::DynamicCellSetBase< vtkm::ListAppend<typename DerivedFilter::SupportedStructuredCellSets, typename DerivedPolicy::StructuredCellSetList> > vtkm::filter::ApplyPolicyCellSetStructured ( const vtkm::cont::DynamicCellSet cellset,
vtkm::filter::PolicyBase< DerivedPolicy >  ,
const vtkm::filter::Filter< DerivedFilter > &   
)

Get a structured cell set from a DynamicCellSet object.

Adjusts the types of CellSets to support those structured cell set types specified in a policy.

◆ ApplyPolicyCellSetUnstructured() [1/2]

template<typename DerivedPolicy >
VTKM_CONT vtkm::cont::DynamicCellSetBase< typename DerivedPolicy:: UnstructuredCellSetList> vtkm::filter::ApplyPolicyCellSetUnstructured ( const vtkm::cont::DynamicCellSet cellset,
vtkm::filter::PolicyBase< DerivedPolicy >   
)

◆ ApplyPolicyCellSetUnstructured() [2/2]

template<typename DerivedPolicy , typename DerivedFilter >
VTKM_CONT vtkm::cont::DynamicCellSetBase< vtkm::ListAppend<typename DerivedFilter::SupportedUnstructuredCellSets, typename DerivedPolicy::UnstructuredCellSetList> > vtkm::filter::ApplyPolicyCellSetUnstructured ( const vtkm::cont::DynamicCellSet cellset,
vtkm::filter::PolicyBase< DerivedPolicy >  ,
const vtkm::filter::Filter< DerivedFilter > &   
)

Get an unstructured cell set from a DynamicCellSet object.

Adjusts the types of CellSets to support those unstructured cell set types specified in a policy.

◆ ApplyPolicyFieldActive()

template<typename DerivedPolicy , typename FilterType >
VTKM_CONT vtkm::cont::VariantArrayHandleBase<typename vtkm::filter::DeduceFilterFieldTypes< DerivedPolicy, typename vtkm::filter::FilterTraits<FilterType>::InputFieldTypeList>::TypeList> vtkm::filter::ApplyPolicyFieldActive ( const vtkm::cont::Field field,
vtkm::filter::PolicyBase< DerivedPolicy >  ,
vtkm::filter::FilterTraits< FilterType >   
)

Get an array from a Field that follows the types of an active field.

Use this form for getting a Field to build the types that are appropriate for the active field of this filter.

◆ ApplyPolicyFieldNotActive()

template<typename DerivedPolicy >
VTKM_CONT vtkm::cont::UncertainArrayHandle< typename std::conditional< std::is_same<typename DerivedPolicy::FieldTypeList, vtkm::ListUniversal>::value, VTKM_DEFAULT_TYPE_LIST, typename DerivedPolicy::FieldTypeList>::type, typename DerivedPolicy::StorageList> vtkm::filter::ApplyPolicyFieldNotActive ( const vtkm::cont::Field field,
vtkm::filter::PolicyBase< DerivedPolicy >   
)

Get an array from a Field that is not the active field.

Use this form for getting a Field when you don't know the type and it is not (necessarily) the "active" field of the filter. It is generally used for arrays passed to the DoMapField method of filters.

◆ ApplyPolicyFieldOfType()

template<typename T , typename DerivedPolicy , typename FilterType >
VTKM_CONT internal::ArrayHandleMultiplexerForStorageList< T, vtkm::ListAppend<typename vtkm::filter::FilterTraits<FilterType>::AdditionalFieldStorage, typename DerivedPolicy::StorageList> > vtkm::filter::ApplyPolicyFieldOfType ( const vtkm::cont::Field field,
vtkm::filter::PolicyBase< DerivedPolicy >  ,
const FilterType &   
)

Get an ArrayHandle of a specific type from a Field.

Use this form of ApplyPolicy when you know what the value type of a field is or (more likely) there is a type you are going to cast it to anyway.

◆ CreateResult() [1/3]

template<typename T , typename Storage >
VTKM_CONT vtkm::cont::DataSet vtkm::filter::CreateResult ( const vtkm::cont::DataSet inDataSet,
const vtkm::cont::ArrayHandle< T, Storage > &  fieldArray,
const std::string &  fieldName,
const vtkm::filter::FieldMetadata metaData 
)
inline

Use this function if you have an ArrayHandle that holds the data for the field.

You also need to specify a name for the field.

◆ CreateResult() [2/3]

VTKM_CONT vtkm::cont::DataSet vtkm::filter::CreateResult ( const vtkm::cont::DataSet inDataSet,
const vtkm::cont::Field field 
)
inline

These are utility functions defined to use in filters when creating an output dataset to return from DoExecute methods.

The various overloads provides different ways of creating the output dataset (copying the input without any of the fields) and adding additional field(s). Use this if you have built a Field object. An output DataSet will be created by adding the field to the input.

◆ CreateResult() [3/3]

VTKM_CONT vtkm::cont::DataSet vtkm::filter::CreateResult ( const vtkm::cont::DataSet inDataSet,
const vtkm::cont::VariantArrayHandle fieldArray,
const std::string &  fieldName,
const vtkm::filter::FieldMetadata metaData 
)
inline

Use this function if you have a VariantArrayHandle that holds the data for the field.

◆ CreateResultFieldCell() [1/2]

template<typename T , typename Storage >
VTKM_CONT vtkm::cont::DataSet vtkm::filter::CreateResultFieldCell ( const vtkm::cont::DataSet inDataSet,
const vtkm::cont::ArrayHandle< T, Storage > &  fieldArray,
const std::string &  fieldName 
)
inline

Use this function if you want to explicit construct a Cell field and have a ArrayHandle that holds the data for the field.

◆ CreateResultFieldCell() [2/2]

VTKM_CONT vtkm::cont::DataSet vtkm::filter::CreateResultFieldCell ( const vtkm::cont::DataSet inDataSet,
const vtkm::cont::VariantArrayHandle fieldArray,
const std::string &  fieldName 
)
inline

Use this function if you want to explicit construct a Cell field and have a VariantArrayHandle that holds the data for the field.

◆ CreateResultFieldPoint() [1/2]

template<typename T , typename Storage >
VTKM_CONT vtkm::cont::DataSet vtkm::filter::CreateResultFieldPoint ( const vtkm::cont::DataSet inDataSet,
const vtkm::cont::ArrayHandle< T, Storage > &  fieldArray,
const std::string &  fieldName 
)
inline

Use this function if you want to explicit construct a Point field and have a ArrayHandle that holds the data for the field.

◆ CreateResultFieldPoint() [2/2]

VTKM_CONT vtkm::cont::DataSet vtkm::filter::CreateResultFieldPoint ( const vtkm::cont::DataSet inDataSet,
const vtkm::cont::VariantArrayHandle fieldArray,
const std::string &  fieldName 
)
inline

Use this function if you want to explicit construct a Point field and have a VariantArrayHandle that holds the data for the field.

◆ MakeSerializableDataSet() [1/6]

template<typename DerivedFilter >
VTKM_CONT vtkm::cont::SerializableDataSet<VTKM_DEFAULT_TYPE_LIST, typename DerivedFilter::SupportedCellSets> vtkm::filter::MakeSerializableDataSet ( const vtkm::cont::DataSet dataset,
const vtkm::filter::Filter< DerivedFilter > &   
)

◆ MakeSerializableDataSet() [2/6]

template<typename DerivedPolicy >
VTKM_CONT vtkm::cont::SerializableDataSet< typename DerivedPolicy::FieldTypeList, typename DerivedPolicy::AllCellSetList> vtkm::filter::MakeSerializableDataSet ( const vtkm::cont::DataSet dataset,
vtkm::filter::PolicyBase< DerivedPolicy >   
)

◆ MakeSerializableDataSet() [3/6]

template<typename DerivedPolicy , typename DerivedFilter >
VTKM_CONT vtkm::cont::SerializableDataSet<typename DerivedPolicy::FieldTypeList, vtkm::ListAppend<typename DerivedFilter::SupportedCellSets, typename DerivedPolicy::AllCellSetList> > vtkm::filter::MakeSerializableDataSet ( const vtkm::cont::DataSet dataset,
vtkm::filter::PolicyBase< DerivedPolicy >  ,
const vtkm::filter::Filter< DerivedFilter > &   
)

◆ MakeSerializableDataSet() [4/6]

template<typename DerivedFilter >
VTKM_CONT vtkm::cont::SerializableDataSet<VTKM_DEFAULT_TYPE_LIST, typename DerivedFilter::SupportedCellSets> vtkm::filter::MakeSerializableDataSet ( const vtkm::filter::Filter< DerivedFilter > &  )

◆ MakeSerializableDataSet() [5/6]

template<typename DerivedPolicy >
VTKM_DEPRECATED_SUPPRESS_END VTKM_CONT vtkm::cont::SerializableDataSet< typename DerivedPolicy::FieldTypeList, typename DerivedPolicy::AllCellSetList> vtkm::filter::MakeSerializableDataSet ( vtkm::filter::PolicyBase< DerivedPolicy >  )

◆ MakeSerializableDataSet() [6/6]

template<typename DerivedPolicy , typename DerivedFilter >
VTKM_CONT vtkm::cont::SerializableDataSet<typename DerivedPolicy::FieldTypeList, vtkm::ListAppend<typename DerivedFilter::SupportedCellSets, typename DerivedPolicy::AllCellSetList> > vtkm::filter::MakeSerializableDataSet ( vtkm::filter::PolicyBase< DerivedPolicy >  ,
const vtkm::filter::Filter< DerivedFilter > &   
)

◆ MakeSerializableField() [1/2]

template<typename DerivedPolicy >
VTKM_CONT vtkm::cont::SerializableField<typename DerivedPolicy::FieldTypeList> vtkm::filter::MakeSerializableField ( const vtkm::cont::Field field,
vtkm::filter::PolicyBase< DerivedPolicy >   
)

◆ MakeSerializableField() [2/2]

template<typename DerivedPolicy >
VTKM_DEPRECATED_SUPPRESS_BEGIN VTKM_CONT vtkm::cont::SerializableField<typename DerivedPolicy::FieldTypeList> vtkm::filter::MakeSerializableField ( vtkm::filter::PolicyBase< DerivedPolicy >  )

◆ MapFieldMergeAverage() [1/2]

VTKM_FILTER_COMMON_EXPORT VTKM_CONT bool vtkm::filter::MapFieldMergeAverage ( const vtkm::cont::Field inputField,
const vtkm::worklet::internal::KeysBase &  keys,
vtkm::cont::DataSet outputData 
)

Maps a field by merging entries based on a keys object.

This method will create a new field containing the data from the provided inputField but but with groups of entities merged together. The input keys object encapsulates which elements should be merged together. A group of elements merged together will be averaged.

The intention of this method is to implement the MapFieldOntoOutput methods in filters (many of which require this merge of a field), but can be used in other places as well. The resulting field is put in the given DataSet.

The returned Field has the same metadata as the input. If the metadata needs to change (such as the name or the association), then a different form of MapFieldMergeAverage should be used.

This function returns whether the field was successfully merged. If the returned result is true, then outputData has the merged field. If it is false, then the field is not placed in outputData.

◆ MapFieldMergeAverage() [2/2]

VTKM_FILTER_COMMON_EXPORT VTKM_CONT bool vtkm::filter::MapFieldMergeAverage ( const vtkm::cont::Field inputField,
const vtkm::worklet::internal::KeysBase &  keys,
vtkm::cont::Field outputField 
)

Maps a field by merging entries based on a keys object.

This method will create a new field containing the data from the provided inputField but but with groups of entities merged together. The input keys object encapsulates which elements should be merged together. A group of elements merged together will be averaged. The result is placed in outputField.

The intention of this method is to implement the MapFieldOntoOutput methods in filters (many of which require this merge of a field), but can be used in other places as well.

outputField is set to have the same metadata as the input. If the metadata needs to change (such as the name or the association) that should be done after the function returns.

This function returns whether the field was successfully merged. If the returned result is true, then the results in outputField are valid. If it is false, then outputField should not be used.

◆ MapFieldPermutation() [1/2]

VTKM_FILTER_COMMON_EXPORT VTKM_CONT bool vtkm::filter::MapFieldPermutation ( const vtkm::cont::Field inputField,
const vtkm::cont::ArrayHandle< vtkm::Id > &  permutation,
vtkm::cont::DataSet outputData,
vtkm::Float64  invalidValue = vtkm::Nan< vtkm::Float64 >() 
)

Maps a field by permuting it by a given index array.

This method will create a new field containing the data from the provided inputField but reorded by the given permutation index array. The value in the resulting field for index i will be be a value from inputField, but comes from the index that comes from permutation at position i.

The intention of this method is to implement the MapFieldOntoOutput methods in filters (many of which require this permutation of a field), but can be used in other places as well. The resulting field is put in the given DataSet.

The returned Field has the same metadata as the input. If the metadata needs to change (such as the name or the association), then a different form of MapFieldPermutation should be used.

This function returns whether the field was successfully permuted. If the returned result is true, then outputData has the permuted field. If it is false, then the field is not placed in outputData.

If an invalid index is given in the permutation array (i.e. less than 0 or greater than the size of the array), then the resulting outputField will be given invalidValue (converted as best as possible to the correct data type).

◆ MapFieldPermutation() [2/2]

VTKM_FILTER_COMMON_EXPORT VTKM_CONT bool vtkm::filter::MapFieldPermutation ( const vtkm::cont::Field inputField,
const vtkm::cont::ArrayHandle< vtkm::Id > &  permutation,
vtkm::cont::Field outputField,
vtkm::Float64  invalidValue = vtkm::Nan< vtkm::Float64 >() 
)

Maps a field by permuting it by a given index array.

This method will create a new field containing the data from the provided inputField but reorded by the given permutation index array. The value in the resulting field for index i will be be a value from inputField, but comes from the index that comes from permutation at position i. The result is placed in outputField.

The intention of this method is to implement the MapFieldOntoOutput methods in filters (many of which require this permutation of a field), but can be used in other places as well.

outputField is set to have the same metadata as the input. If the metadata needs to change (such as the name or the association) that should be done after the function returns.

This function returns whether the field was successfully permuted. If the returned result is true, then the results in outputField are valid. If it is false, then outputField should not be used.

If an invalid index is given in the permutation array (i.e. less than 0 or greater than the size of the array), then the resulting outputField will be given invalidValue (converted as best as possible to the correct data type).

◆ VTKM_FILTER_COMMON_EXPORT_EXECUTE_METHOD() [1/3]

vtkm::filter::VTKM_FILTER_COMMON_EXPORT_EXECUTE_METHOD ( CellAverage  )

◆ VTKM_FILTER_COMMON_EXPORT_EXECUTE_METHOD() [2/3]

vtkm::filter::VTKM_FILTER_COMMON_EXPORT_EXECUTE_METHOD ( PointAverage  )

◆ VTKM_FILTER_COMMON_EXPORT_EXECUTE_METHOD() [3/3]

vtkm::filter::VTKM_FILTER_COMMON_EXPORT_EXECUTE_METHOD ( Threshold  )

◆ VTKM_FILTER_EXTRA_EXPORT_EXECUTE_METHOD() [1/3]

vtkm::filter::VTKM_FILTER_EXTRA_EXPORT_EXECUTE_METHOD ( ClipWithField  )

◆ VTKM_FILTER_EXTRA_EXPORT_EXECUTE_METHOD() [2/3]

vtkm::filter::VTKM_FILTER_EXTRA_EXPORT_EXECUTE_METHOD ( ClipWithImplicitFunction  )

◆ VTKM_FILTER_EXTRA_EXPORT_EXECUTE_METHOD() [3/3]

vtkm::filter::VTKM_FILTER_EXTRA_EXPORT_EXECUTE_METHOD ( VectorMagnitude  )