Adds fields to a vtkm::cont::DataSet that give the ids for the points and cells. More...

#include <GenerateIds.h>

Inheritance diagram for vtkm::filter::field_transform::GenerateIds:

Public Member Functions
const std::string &	GetPointFieldName () const
	The name given to the generated point field. More...

void	SetPointFieldName (const std::string &name)
	The name given to the generated point field. More...

const std::string &	GetCellFieldName () const
	The name given to the generated cell field. More...

void	SetCellFieldName (const std::string &name)
	The name given to the generated cell field. More...

bool	GetGeneratePointIds () const
	Specify whether the point id field is generated. More...

void	SetGeneratePointIds (bool flag)
	Specify whether the point id field is generated. More...

bool	GetGenerateCellIds () const
	Specify whether the cell id field is generated. More...

void	SetGenerateCellIds (bool flag)
	Specify whether the cell id field is generated. More...

bool	GetUseFloat () const
	Specify whether the generated fields should be integer or float. More...

void	SetUseFloat (bool flag)
	Specify whether the generated fields should be integer or float. More...

Public Member Functions inherited from vtkm::filter::Filter
	Filter ()

virtual	~Filter ()

vtkm::cont::DataSet	Execute (const vtkm::cont::DataSet &input)
	Executes the filter on the input and produces a result dataset. More...

vtkm::cont::PartitionedDataSet	Execute (const vtkm::cont::PartitionedDataSet &input)
	Executes the filter on the input PartitionedDataSet and produces a result PartitionedDataSet. More...

void	SetFieldsToPass (const vtkm::filter::FieldSelection &fieldsToPass)
	Specify which fields get passed from input to output. More...

void	SetFieldsToPass (vtkm::filter::FieldSelection &&fieldsToPass)
	Specify which fields get passed from input to output. More...

void	SetFieldsToPass (const vtkm::filter::FieldSelection &fieldsToPass, vtkm::filter::FieldSelection::Mode mode)

void	SetFieldsToPass (std::initializer_list< std::string > fields, vtkm::filter::FieldSelection::Mode mode=vtkm::filter::FieldSelection::Mode::Select)
	Specify which fields get passed from input to output. More...

void	SetFieldsToPass (std::initializer_list< std::pair< std::string, vtkm::cont::Field::Association >> fields, vtkm::filter::FieldSelection::Mode mode=vtkm::filter::FieldSelection::Mode::Select)
	Specify which fields get passed from input to output. More...

void	SetFieldsToPass (const std::string &fieldname, vtkm::cont::Field::Association association, vtkm::filter::FieldSelection::Mode mode=vtkm::filter::FieldSelection::Mode::Select)
	Specify which fields get passed from input to output. More...

void	SetFieldsToPass (const std::string &fieldname, vtkm::filter::FieldSelection::Mode mode)
	Specify which fields get passed from input to output. More...

const vtkm::filter::FieldSelection &	GetFieldsToPass () const
	Specify which fields get passed from input to output. More...

vtkm::filter::FieldSelection &	GetFieldsToPass ()
	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, vtkm::cont::Field::Association association=vtkm::cont::Field::Association::Any)
	Specifies a field to operate on. More...

void	SetActiveField (vtkm::IdComponent index, const std::string &name, vtkm::cont::Field::Association association=vtkm::cont::Field::Association::Any)
	Specifies a field to operate on. More...

const std::string &	GetActiveFieldName (vtkm::IdComponent index=0) const
	Specifies a field to operate on. More...

vtkm::cont::Field::Association	GetActiveFieldAssociation (vtkm::IdComponent index=0) const
	Specifies a field to operate on. More...

void	SetActiveCoordinateSystem (vtkm::Id coord_idx)
	Specifies the coordinate system index to make active to use when processing the input `vtkm::cont::DataSet`. More...

void	SetActiveCoordinateSystem (vtkm::IdComponent index, vtkm::Id coord_idx)
	Specifies the coordinate system index to make active to use when processing the input `vtkm::cont::DataSet`. More...

vtkm::Id	GetActiveCoordinateSystemIndex (vtkm::IdComponent index=0) const
	Specifies the coordinate system index to make active to use when processing the input `vtkm::cont::DataSet`. More...

void	SetUseCoordinateSystemAsField (bool val)
	Specifies whether to use point coordinates as the input field. More...

void	SetUseCoordinateSystemAsField (vtkm::IdComponent index, bool val)
	Specifies whether to use point coordinates as the input field. More...

bool	GetUseCoordinateSystemAsField (vtkm::IdComponent index=0) const
	Specifies whether to use point coordinates as the input field. More...

vtkm::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 (vtkm::Id numThreads)

void	SetThreadsPerGPU (vtkm::Id numThreads)

vtkm::Id	GetThreadsPerCPU () const

vtkm::Id	GetThreadsPerGPU () const

bool	GetRunMultiThreadedFilter () const

void	SetRunMultiThreadedFilter (bool val)

void	SetInvoker (vtkm::cont::Invoker inv)
	Specify the vtkm::cont::Invoker to be used to execute worklets by this filter instance. More...

Private Member Functions
vtkm::cont::DataSet	DoExecute (const vtkm::cont::DataSet &input) override

Private Attributes
std::string	PointFieldName = "pointids"

std::string	CellFieldName = "cellids"

bool	GeneratePointIds = true

bool	GenerateCellIds = true

bool	UseFloat = false

Additional Inherited Members
Protected Member Functions inherited from vtkm::filter::Filter
vtkm::cont::DataSet	CreateResult (const vtkm::cont::DataSet &inDataSet) const
	Create the output data set for `DoExecute`. More...

vtkm::cont::DataSet	CreateResultField (const vtkm::cont::DataSet &inDataSet, const vtkm::cont::Field &resultField) const
	Create the output data set for `DoExecute` More...

vtkm::cont::DataSet	CreateResultField (const vtkm::cont::DataSet &inDataSet, const std::string &resultFieldName, vtkm::cont::Field::Association resultFieldAssociation, const vtkm::cont::UnknownArrayHandle &resultFieldArray) const
	Create the output data set for `DoExecute` More...

vtkm::cont::DataSet	CreateResultFieldPoint (const vtkm::cont::DataSet &inDataSet, const std::string &resultFieldName, const vtkm::cont::UnknownArrayHandle &resultFieldArray) const
	Create the output data set for `DoExecute` More...

vtkm::cont::DataSet	CreateResultFieldCell (const vtkm::cont::DataSet &inDataSet, const std::string &resultFieldName, const vtkm::cont::UnknownArrayHandle &resultFieldArray) const
	Create the output data set for `DoExecute` More...

vtkm::cont::PartitionedDataSet	CreateResult (const vtkm::cont::PartitionedDataSet &input, const vtkm::cont::PartitionedDataSet &resultPartitions) const
	Create the output data set for `DoExecute`. More...

template<typename FieldMapper >
vtkm::cont::PartitionedDataSet	CreateResult (const vtkm::cont::PartitionedDataSet &input, const vtkm::cont::PartitionedDataSet &resultPartitions, FieldMapper &&fieldMapper) const
	Create the output data set for `DoExecute`. More...

template<typename FieldMapper >
vtkm::cont::DataSet	CreateResult (const vtkm::cont::DataSet &inDataSet, const vtkm::cont::UnknownCellSet &resultCellSet, FieldMapper &&fieldMapper) const
	Create the output data set for `DoExecute`. More...

template<typename FieldMapper >
vtkm::cont::DataSet	CreateResultCoordinateSystem (const vtkm::cont::DataSet &inDataSet, const vtkm::cont::UnknownCellSet &resultCellSet, const vtkm::cont::CoordinateSystem &resultCoordSystem, FieldMapper &&fieldMapper) const
	Create the output data set for `DoExecute`. More...

template<typename FieldMapper >
vtkm::cont::DataSet	CreateResultCoordinateSystem (const vtkm::cont::DataSet &inDataSet, const vtkm::cont::UnknownCellSet &resultCellSet, const std::string &coordsName, const vtkm::cont::UnknownArrayHandle &coordsData, FieldMapper &&fieldMapper) const
	Create the output data set for `DoExecute`. More...

const vtkm::cont::Field &	GetFieldFromDataSet (const vtkm::cont::DataSet &input) const
	Retrieve an input field from a `vtkm::cont::DataSet` object. More...

const vtkm::cont::Field &	GetFieldFromDataSet (vtkm::IdComponent index, const vtkm::cont::DataSet &input) const
	Retrieve an input field from a `vtkm::cont::DataSet` object. More...

virtual vtkm::cont::PartitionedDataSet	DoExecutePartitions (const vtkm::cont::PartitionedDataSet &inData)

template<typename Functor , typename... Args>
void	CastAndCallScalarField (const vtkm::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 vtkm::cont::Field &field, Functor &&functor, Args &&... args) const
	Convenience method to get the array from a filter's input scalar field. More...

template<vtkm::IdComponent VecSize, typename Functor , typename... Args>
void	CastAndCallVecField (const vtkm::cont::UnknownArrayHandle &fieldArray, Functor &&functor, Args &&... args) const
	Convenience method to get the array from a filter's input vector field. More...

template<vtkm::IdComponent VecSize, typename Functor , typename... Args>
void	CastAndCallVecField (const vtkm::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 vtkm::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 vtkm::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 vtkm::filter::Filter
vtkm::cont::Invoker	Invoke

Detailed Description

Adds fields to a vtkm::cont::DataSet that give the ids for the points and cells.

This filter will add (by default) a point field named pointids that gives the index of the associated point and likewise a cell field named cellids for the associated cell indices. These fields are useful for tracking the provenance of the elements of a vtkm::cont::DataSet as it gets manipulated by filters. It is also convenient for adding indices to operations designed for fields and generally creating test data.

Member Function Documentation

◆ DoExecute()

vtkm::cont::DataSet vtkm::filter::field_transform::GenerateIds::DoExecute ( const vtkm::cont::DataSet & input )

overrideprivatevirtual

Implements vtkm::filter::Filter.

◆ GetCellFieldName()

const std::string& vtkm::filter::field_transform::GenerateIds::GetCellFieldName ( ) const

inline

The name given to the generated cell field.

By default, the name is cellids.

◆ GetGenerateCellIds()

bool vtkm::filter::field_transform::GenerateIds::GetGenerateCellIds ( ) const

inline

Specify whether the cell id field is generated.

When GenerateCellIds is true (the default), a field echoing the cell indices is generated. When set to false, this output is not created.

◆ GetGeneratePointIds()

bool vtkm::filter::field_transform::GenerateIds::GetGeneratePointIds ( ) const

inline

Specify whether the point id field is generated.

When GeneratePointIds is true (the default), a field echoing the point indices is generated. When set to false, this output is not created.

◆ GetPointFieldName()

const std::string& vtkm::filter::field_transform::GenerateIds::GetPointFieldName ( ) const

inline

The name given to the generated point field.

By default, the name is pointids.

◆ GetUseFloat()

bool vtkm::filter::field_transform::GenerateIds::GetUseFloat ( ) const

inline

Specify whether the generated fields should be integer or float.

When UseFloat is false (the default), then the fields generated will have type vtkm::Id. If it is set to true, then the fields will be generated with type vtkm::FloatDefault.

◆ SetCellFieldName()

void vtkm::filter::field_transform::GenerateIds::SetCellFieldName ( const std::string & name )

inline

The name given to the generated cell field.

By default, the name is cellids.

◆ SetGenerateCellIds()

void vtkm::filter::field_transform::GenerateIds::SetGenerateCellIds ( bool flag )

inline

Specify whether the cell id field is generated.

When GenerateCellIds is true (the default), a field echoing the cell indices is generated. When set to false, this output is not created.

◆ SetGeneratePointIds()

void vtkm::filter::field_transform::GenerateIds::SetGeneratePointIds ( bool flag )

inline

Specify whether the point id field is generated.

When GeneratePointIds is true (the default), a field echoing the point indices is generated. When set to false, this output is not created.

◆ SetPointFieldName()

void vtkm::filter::field_transform::GenerateIds::SetPointFieldName ( const std::string & name )

inline

The name given to the generated point field.

By default, the name is pointids.

◆ SetUseFloat()

void vtkm::filter::field_transform::GenerateIds::SetUseFloat ( bool flag )

inline

Specify whether the generated fields should be integer or float.

When UseFloat is false (the default), then the fields generated will have type vtkm::Id. If it is set to true, then the fields will be generated with type vtkm::FloatDefault.

Member Data Documentation

◆ CellFieldName

std::string vtkm::filter::field_transform::GenerateIds::CellFieldName = "cellids"

private

◆ GenerateCellIds

bool vtkm::filter::field_transform::GenerateIds::GenerateCellIds = true

private

◆ GeneratePointIds

bool vtkm::filter::field_transform::GenerateIds::GeneratePointIds = true

private

◆ PointFieldName

std::string vtkm::filter::field_transform::GenerateIds::PointFieldName = "pointids"

private

◆ UseFloat

bool vtkm::filter::field_transform::GenerateIds::UseFloat = false

private

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

GenerateIds.h

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DoExecute()

◆ GetCellFieldName()

◆ GetGenerateCellIds()

◆ GetGeneratePointIds()

◆ GetPointFieldName()

◆ GetUseFloat()

◆ SetCellFieldName()

◆ SetGenerateCellIds()

◆ SetGeneratePointIds()

◆ SetPointFieldName()

◆ SetUseFloat()

Member Data Documentation

◆ CellFieldName

◆ GenerateCellIds

◆ GeneratePointIds

◆ PointFieldName

◆ UseFloat