Viskores  1.0
List of all members
viskores::filter::FilterField Class Reference

#include <Filter.h>

Inheritance diagram for viskores::filter::FilterField:
viskores::filter::Filter

Additional Inherited Members

- Public Member Functions inherited from viskores::filter::Filter
 Filter ()
 
virtual ~Filter ()
 
viskores::cont::DataSet Execute (const viskores::cont::DataSet &input)
 Executes the filter on the input and produces a result dataset. More...
 
viskores::cont::PartitionedDataSet Execute (const viskores::cont::PartitionedDataSet &input)
 Executes the filter on the input PartitionedDataSet and produces a result PartitionedDataSet. More...
 
void SetFieldsToPass (const viskores::filter::FieldSelection &fieldsToPass)
 Specify which fields get passed from input to output. More...
 
void SetFieldsToPass (viskores::filter::FieldSelection &&fieldsToPass)
 Specify which fields get passed from input to output. More...
 
void SetFieldsToPass (const viskores::filter::FieldSelection &fieldsToPass, viskores::filter::FieldSelection::Mode mode)
 
void SetFieldsToPass (std::initializer_list< std::string > fields, viskores::filter::FieldSelection::Mode mode=viskores::filter::FieldSelection::Mode::Select)
 Specify which fields get passed from input to output. More...
 
void SetFieldsToPass (std::initializer_list< std::pair< std::string, viskores::cont::Field::Association >> fields, viskores::filter::FieldSelection::Mode mode=viskores::filter::FieldSelection::Mode::Select)
 Specify which fields get passed from input to output. More...
 
void SetFieldsToPass (const std::string &fieldname, viskores::cont::Field::Association association, viskores::filter::FieldSelection::Mode mode=viskores::filter::FieldSelection::Mode::Select)
 Specify which fields get passed from input to output. More...
 
void SetFieldsToPass (const std::string &fieldname, viskores::filter::FieldSelection::Mode mode)
 Specify which fields get passed from input to output. More...
 
const viskores::filter::FieldSelectionGetFieldsToPass () const
 Specify which fields get passed from input to output. More...
 
viskores::filter::FieldSelectionGetFieldsToPass ()
 Specify which fields get passed from input to output. More...
 
void SetPassCoordinateSystems (bool flag)
 Specify whether to always pass coordinate systems. More...
 
bool GetPassCoordinateSystems () const
 Specify whether to always pass coordinate systems. More...
 
void SetOutputFieldName (const std::string &name)
 Specifies the name of the output field generated. More...
 
const std::string & GetOutputFieldName () const
 Specifies the name of the output field generated. More...
 
void SetActiveField (const std::string &name, viskores::cont::Field::Association association=viskores::cont::Field::Association::Any)
 Specifies a field to operate on. More...
 
void SetActiveField (viskores::IdComponent index, const std::string &name, viskores::cont::Field::Association association=viskores::cont::Field::Association::Any)
 Specifies a field to operate on. More...
 
const std::string & GetActiveFieldName (viskores::IdComponent index=0) const
 Specifies a field to operate on. More...
 
viskores::cont::Field::Association GetActiveFieldAssociation (viskores::IdComponent index=0) const
 Specifies a field to operate on. More...
 
void SetActiveCoordinateSystem (viskores::Id coord_idx)
 Specifies the coordinate system index to make active to use when processing the input viskores::cont::DataSet. More...
 
void SetActiveCoordinateSystem (viskores::IdComponent index, viskores::Id coord_idx)
 Specifies the coordinate system index to make active to use when processing the input viskores::cont::DataSet. More...
 
viskores::Id GetActiveCoordinateSystemIndex (viskores::IdComponent index=0) const
 Specifies the coordinate system index to make active to use when processing the input viskores::cont::DataSet. More...
 
void SetUseCoordinateSystemAsField (bool val)
 Specifies whether to use point coordinates as the input field. More...
 
void SetUseCoordinateSystemAsField (viskores::IdComponent index, bool val)
 Specifies whether to use point coordinates as the input field. More...
 
bool GetUseCoordinateSystemAsField (viskores::IdComponent index=0) const
 Specifies whether to use point coordinates as the input field. More...
 
viskores::IdComponent GetNumberOfActiveFields () const
 Return the number of active fields currently set. More...
 
virtual bool CanThread () const
 Returns whether the filter can execute on partitions in concurrent threads. More...
 
void SetThreadsPerCPU (viskores::Id numThreads)
 
void SetThreadsPerGPU (viskores::Id numThreads)
 
viskores::Id GetThreadsPerCPU () const
 
viskores::Id GetThreadsPerGPU () const
 
bool GetRunMultiThreadedFilter () const
 
void SetRunMultiThreadedFilter (bool val)
 
void SetInvoker (viskores::cont::Invoker inv)
 Specify the viskores::cont::Invoker to be used to execute worklets by this filter instance. More...
 
- Protected Member Functions inherited from viskores::filter::Filter
viskores::cont::DataSet CreateResult (const viskores::cont::DataSet &inDataSet) const
 Create the output data set for DoExecute. More...
 
viskores::cont::DataSet CreateResultField (const viskores::cont::DataSet &inDataSet, const viskores::cont::Field &resultField) const
 Create the output data set for DoExecute More...
 
viskores::cont::DataSet CreateResultField (const viskores::cont::DataSet &inDataSet, const std::string &resultFieldName, viskores::cont::Field::Association resultFieldAssociation, const viskores::cont::UnknownArrayHandle &resultFieldArray) const
 Create the output data set for DoExecute More...
 
viskores::cont::DataSet CreateResultFieldPoint (const viskores::cont::DataSet &inDataSet, const std::string &resultFieldName, const viskores::cont::UnknownArrayHandle &resultFieldArray) const
 Create the output data set for DoExecute More...
 
viskores::cont::DataSet CreateResultFieldCell (const viskores::cont::DataSet &inDataSet, const std::string &resultFieldName, const viskores::cont::UnknownArrayHandle &resultFieldArray) const
 Create the output data set for DoExecute More...
 
viskores::cont::PartitionedDataSet CreateResult (const viskores::cont::PartitionedDataSet &input, const viskores::cont::PartitionedDataSet &resultPartitions) const
 Create the output data set for DoExecute. More...
 
template<typename FieldMapper >
viskores::cont::PartitionedDataSet CreateResult (const viskores::cont::PartitionedDataSet &input, const viskores::cont::PartitionedDataSet &resultPartitions, FieldMapper &&fieldMapper) const
 Create the output data set for DoExecute. More...
 
template<typename FieldMapper >
viskores::cont::DataSet CreateResult (const viskores::cont::DataSet &inDataSet, const viskores::cont::UnknownCellSet &resultCellSet, FieldMapper &&fieldMapper) const
 Create the output data set for DoExecute. More...
 
template<typename FieldMapper >
viskores::cont::DataSet CreateResultCoordinateSystem (const viskores::cont::DataSet &inDataSet, const viskores::cont::UnknownCellSet &resultCellSet, const viskores::cont::CoordinateSystem &resultCoordSystem, FieldMapper &&fieldMapper) const
 Create the output data set for DoExecute. More...
 
template<typename FieldMapper >
viskores::cont::DataSet CreateResultCoordinateSystem (const viskores::cont::DataSet &inDataSet, const viskores::cont::UnknownCellSet &resultCellSet, const std::string &coordsName, const viskores::cont::UnknownArrayHandle &coordsData, FieldMapper &&fieldMapper) const
 Create the output data set for DoExecute. More...
 
const viskores::cont::FieldGetFieldFromDataSet (const viskores::cont::DataSet &input) const
 Retrieve an input field from a viskores::cont::DataSet object. More...
 
const viskores::cont::FieldGetFieldFromDataSet (viskores::IdComponent index, const viskores::cont::DataSet &input) const
 Retrieve an input field from a viskores::cont::DataSet object. More...
 
virtual viskores::cont::DataSet DoExecute (const viskores::cont::DataSet &inData)=0
 
virtual viskores::cont::PartitionedDataSet DoExecutePartitions (const viskores::cont::PartitionedDataSet &inData)
 
template<typename Functor , typename... Args>
void CastAndCallScalarField (const viskores::cont::UnknownArrayHandle &fieldArray, Functor &&functor, Args &&... args) const
 Convenience method to get the array from a filter's input scalar field. More...
 
template<typename Functor , typename... Args>
void CastAndCallScalarField (const viskores::cont::Field &field, Functor &&functor, Args &&... args) const
 Convenience method to get the array from a filter's input scalar field. More...
 
template<viskores::IdComponent VecSize, typename Functor , typename... Args>
void CastAndCallVecField (const viskores::cont::UnknownArrayHandle &fieldArray, Functor &&functor, Args &&... args) const
 Convenience method to get the array from a filter's input vector field. More...
 
template<viskores::IdComponent VecSize, typename Functor , typename... Args>
void CastAndCallVecField (const viskores::cont::Field &field, Functor &&functor, Args &&... args) const
 Convenience method to get the array from a filter's input vector field. More...
 
template<typename Functor , typename... Args>
void CastAndCallVariableVecField (const viskores::cont::UnknownArrayHandle &fieldArray, Functor &&functor, Args &&... args) const
 This method is like CastAndCallVecField except that it can be used for a field of unknown vector size (or scalars). More...
 
template<typename Functor , typename... Args>
void CastAndCallVariableVecField (const viskores::cont::Field &field, Functor &&functor, Args &&... args) const
 This method is like CastAndCallVecField except that it can be used for a field of unknown vector size (or scalars). More...
 
- Protected Attributes inherited from viskores::filter::Filter
viskores::cont::Invoker Invoke
 

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