VTK-m  1.4
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
vtkm::filter::FilterDataSetWithField< Derived > Class Template Reference

#include <FilterDataSetWithField.h>

Inheritance diagram for vtkm::filter::FilterDataSetWithField< Derived >:
Inheritance graph
[legend]
Collaboration diagram for vtkm::filter::FilterDataSetWithField< Derived >:
Collaboration graph
[legend]

Public Member Functions

VTKM_CONT FilterDataSetWithField ()
 
VTKM_CONT ~FilterDataSetWithField ()
 
VTKM_CONT void SetActiveCoordinateSystem (vtkm::Id index)
 
VTKM_CONT vtkm::Id GetActiveCoordinateSystemIndex () const
 
template<typename DerivedPolicy >
VTKM_CONT bool MapFieldOntoOutput (vtkm::cont::DataSet &result, const vtkm::cont::Field &field, vtkm::filter::PolicyBase< DerivedPolicy > policy)
 
template<typename DerivedPolicy >
VTKM_CONT vtkm::cont::DataSet PrepareForExecution (const vtkm::cont::DataSet &input, vtkm::filter::PolicyBase< DerivedPolicy > policy)
 
VTKM_CONT void SetActiveField (const std::string &name, vtkm::cont::Field::Association association=vtkm::cont::Field::Association::ANY)
 Choose the field to operate on. More...
 
VTKM_CONT const std::string & GetActiveFieldName () const
 Choose the field to operate on. More...
 
VTKM_CONT vtkm::cont::Field::Association GetActiveFieldAssociation () const
 Choose the field to operate on. More...
 
VTKM_CONT void SetUseCoordinateSystemAsField (bool val)
 To simply use the active coordinate system as the field to operate on, set UseCoordinateSystemAsField to true. More...
 
VTKM_CONT bool GetUseCoordinateSystemAsField () const
 To simply use the active coordinate system as the field to operate on, set UseCoordinateSystemAsField to true. More...
 
- Public Member Functions inherited from vtkm::filter::Filter< Derived >
VTKM_CONT Filter ()
 
VTKM_CONT ~Filter ()
 
template<typename DerivedPolicy >
VTKM_CONT void MapFieldsToPass (const vtkm::cont::DataSet &input, vtkm::cont::DataSet &output, vtkm::filter::PolicyBase< DerivedPolicy > policy)
 Map fields from input dataset to output. More...
 
void SetInvoker (vtkm::cont::Invoker inv)
 Specify the vtkm::cont::Invoker to be used to execute worklets by this filter instance. More...
 
VTKM_CONT void SetFieldsToPass (const vtkm::filter::FieldSelection &fieldsToPass)
 Specify which fields get passed from input to output. More...
 
VTKM_CONT void SetFieldsToPass (const vtkm::filter::FieldSelection &fieldsToPass, vtkm::filter::FieldSelection::ModeEnum mode)
 Specify which fields get passed from input to output. More...
 
VTKM_CONT void SetFieldsToPass (const std::string &fieldname, vtkm::cont::Field::Association association, vtkm::filter::FieldSelection::ModeEnum mode=vtkm::filter::FieldSelection::MODE_SELECT)
 Specify which fields get passed from input to output. More...
 
VTKM_CONT const vtkm::filter::FieldSelectionGetFieldsToPass () const
 Specify which fields get passed from input to output. More...
 
VTKM_CONT vtkm::filter::FieldSelectionGetFieldsToPass ()
 Specify which fields get passed from input to output. More...
 
VTKM_CONT vtkm::cont::DataSet Execute (const vtkm::cont::DataSet &input)
 Executes the filter on the input and produces a result dataset. More...
 
template<typename DerivedPolicy >
VTKM_CONT vtkm::cont::DataSet Execute (const vtkm::cont::DataSet &input, vtkm::filter::PolicyBase< DerivedPolicy > policy)
 Executes the filter on the input and produces a result dataset. More...
 
VTKM_CONT vtkm::cont::PartitionedDataSet Execute (const vtkm::cont::PartitionedDataSet &input)
 Executes the filter on the input PartitionedDataSet and produces a result PartitionedDataSet. More...
 
template<typename DerivedPolicy >
VTKM_CONT vtkm::cont::PartitionedDataSet Execute (const vtkm::cont::PartitionedDataSet &input, vtkm::filter::PolicyBase< DerivedPolicy > policy)
 Executes the filter on the input PartitionedDataSet and produces a result PartitionedDataSet. More...
 

Private Member Functions

template<typename DerivedPolicy >
VTKM_CONT vtkm::cont::DataSet PrepareForExecution (const vtkm::cont::DataSet &input, const vtkm::cont::Field &field, vtkm::filter::PolicyBase< DerivedPolicy > policy)
 
template<typename DerivedPolicy >
VTKM_CONT vtkm::cont::DataSet PrepareForExecution (const vtkm::cont::DataSet &input, const vtkm::cont::CoordinateSystem &field, vtkm::filter::PolicyBase< DerivedPolicy > policy)
 

Private Attributes

std::string OutputFieldName
 
vtkm::Id CoordinateSystemIndex
 
std::string ActiveFieldName
 
vtkm::cont::Field::Association ActiveFieldAssociation
 
bool UseCoordinateSystemAsField
 

Friends

class vtkm::filter::Filter< Derived >
 

Additional Inherited Members

- Public Types inherited from vtkm::filter::Filter< Derived >
using SupportedTypes = vtkm::ListTagUniversal
 Specify which subset of types a filter supports. More...
 
using AdditionalFieldStorage = vtkm::ListTagEmpty
 Specify which additional field storage to support. More...
 
- Protected Attributes inherited from vtkm::filter::Filter< Derived >
vtkm::cont::Invoker Invoke
 

Constructor & Destructor Documentation

template<class Derived>
VTKM_CONT vtkm::filter::FilterDataSetWithField< Derived >::~FilterDataSetWithField ( )

Member Function Documentation

template<class Derived>
VTKM_CONT vtkm::Id vtkm::filter::FilterDataSetWithField< Derived >::GetActiveCoordinateSystemIndex ( ) const
inline
template<class Derived>
VTKM_CONT vtkm::cont::Field::Association vtkm::filter::FilterDataSetWithField< Derived >::GetActiveFieldAssociation ( ) const
inline

Choose the field to operate on.

Note, if this->UseCoordinateSystemAsField is true, then the active field is not used.

template<class Derived>
VTKM_CONT const std::string& vtkm::filter::FilterDataSetWithField< Derived >::GetActiveFieldName ( ) const
inline

Choose the field to operate on.

Note, if this->UseCoordinateSystemAsField is true, then the active field is not used.

template<class Derived>
VTKM_CONT bool vtkm::filter::FilterDataSetWithField< Derived >::GetUseCoordinateSystemAsField ( ) const
inline

To simply use the active coordinate system as the field to operate on, set UseCoordinateSystemAsField to true.

template<class Derived>
template<typename DerivedPolicy >
VTKM_CONT bool vtkm::filter::FilterDataSetWithField< Derived >::MapFieldOntoOutput ( vtkm::cont::DataSet result,
const vtkm::cont::Field field,
vtkm::filter::PolicyBase< DerivedPolicy >  policy 
)
template<class Derived>
template<typename DerivedPolicy >
VTKM_CONT vtkm::cont::DataSet vtkm::filter::FilterDataSetWithField< Derived >::PrepareForExecution ( const vtkm::cont::DataSet input,
vtkm::filter::PolicyBase< DerivedPolicy >  policy 
)
template<class Derived>
template<typename DerivedPolicy >
VTKM_CONT vtkm::cont::DataSet vtkm::filter::FilterDataSetWithField< Derived >::PrepareForExecution ( const vtkm::cont::DataSet input,
const vtkm::cont::Field field,
vtkm::filter::PolicyBase< DerivedPolicy >  policy 
)
private
template<class Derived>
template<typename DerivedPolicy >
VTKM_CONT vtkm::cont::DataSet vtkm::filter::FilterDataSetWithField< Derived >::PrepareForExecution ( const vtkm::cont::DataSet input,
const vtkm::cont::CoordinateSystem field,
vtkm::filter::PolicyBase< DerivedPolicy >  policy 
)
private
template<class Derived>
VTKM_CONT void vtkm::filter::FilterDataSetWithField< Derived >::SetActiveCoordinateSystem ( vtkm::Id  index)
inline
template<class Derived>
VTKM_CONT void vtkm::filter::FilterDataSetWithField< Derived >::SetActiveField ( const std::string &  name,
vtkm::cont::Field::Association  association = vtkm::cont::Field::Association::ANY 
)
inline

Choose the field to operate on.

Note, if this->UseCoordinateSystemAsField is true, then the active field is not used.

template<class Derived>
VTKM_CONT void vtkm::filter::FilterDataSetWithField< Derived >::SetUseCoordinateSystemAsField ( bool  val)
inline

To simply use the active coordinate system as the field to operate on, set UseCoordinateSystemAsField to true.

Friends And Related Function Documentation

template<class Derived>
friend class vtkm::filter::Filter< Derived >
friend

Member Data Documentation

template<class Derived>
vtkm::cont::Field::Association vtkm::filter::FilterDataSetWithField< Derived >::ActiveFieldAssociation
private
template<class Derived>
std::string vtkm::filter::FilterDataSetWithField< Derived >::ActiveFieldName
private
template<class Derived>
vtkm::Id vtkm::filter::FilterDataSetWithField< Derived >::CoordinateSystemIndex
private
template<class Derived>
std::string vtkm::filter::FilterDataSetWithField< Derived >::OutputFieldName
private
template<class Derived>
bool vtkm::filter::FilterDataSetWithField< Derived >::UseCoordinateSystemAsField
private

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