Modify points by moving points along point normals by the scalar amount times the scalar factor. More...

#include <WarpScalar.h>

Inheritance diagram for vtkm::filter::field_transform::WarpScalar:

Public Member Functions
VTKM_CONT	WarpScalar (vtkm::FloatDefault scaleAmount)


VTKM_CONT void	SetNormalField (const std::string &name, vtkm::cont::Field::Association association=vtkm::cont::Field::Association::Any)

const VTKM_CONT std::string &	GetNormalFieldName () const

VTKM_CONT vtkm::cont::Field::Association	GetNormalFieldAssociation () const


VTKM_CONT void	SetScalarFactorField (const std::string &name, vtkm::cont::Field::Association association=vtkm::cont::Field::Association::Any)

const VTKM_CONT std::string &	GetScalarFactorFieldName () const

VTKM_CONT vtkm::cont::Field::Association	GetScalarFactorFieldAssociation () const

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

VTKM_CONT void	SetOutputFieldName (const std::string &name)

const VTKM_CONT std::string &	GetOutputFieldName () const

VTKM_CONT void	SetActiveField (const std::string &name, vtkm::cont::Field::Association association=vtkm::cont::Field::Association::Any)

void	SetActiveField (vtkm::IdComponent index, const std::string &name, vtkm::cont::Field::Association association=vtkm::cont::Field::Association::Any)

const VTKM_CONT std::string &	GetActiveFieldName (vtkm::IdComponent index=0) const

VTKM_CONT vtkm::cont::Field::Association	GetActiveFieldAssociation (vtkm::IdComponent index=0) const

VTKM_CONT void	SetActiveCoordinateSystem (vtkm::Id coord_idx)

VTKM_CONT void	SetActiveCoordinateSystem (vtkm::IdComponent index, vtkm::Id coord_idx)

VTKM_CONT vtkm::Id	GetActiveCoordinateSystemIndex () const

VTKM_CONT vtkm::Id	GetActiveCoordinateSystemIndex (vtkm::IdComponent index) const

VTKM_CONT void	SetUseCoordinateSystemAsField (bool val)

VTKM_CONT void	SetUseCoordinateSystemAsField (vtkm::IdComponent index, bool val)

VTKM_CONT bool	GetUseCoordinateSystemAsField (vtkm::IdComponent index=0) const

Public Member Functions inherited from vtkm::filter::Filter
virtual VTKM_CONT	~Filter ()

virtual VTKM_CONT bool	CanThread () const

VTKM_CONT void	SetThreadsPerCPU (vtkm::Id numThreads)

VTKM_CONT void	SetThreadsPerGPU (vtkm::Id numThreads)

VTKM_CONT vtkm::Id	GetThreadsPerCPU () const

VTKM_CONT vtkm::Id	GetThreadsPerGPU () const

VTKM_CONT bool	GetRunMultiThreadedFilter () const

VTKM_CONT 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...

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

VTKM_CONT void	SetFieldsToPass (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::Mode mode)
	Specify which fields get passed from input to output. More...

VTKM_CONT 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...

VTKM_CONT 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...

VTKM_CONT 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...

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

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

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

VTKM_CONT void	SetPassCoordinateSystems (bool flag)
	Specify whether to always pass coordinate systems. More...

VTKM_CONT bool	GetPassCoordinateSystems () const
	Specify whether to always pass coordinate systems. More...

VTKM_CONT vtkm::cont::DataSet	Execute (const vtkm::cont::DataSet &input)

VTKM_CONT vtkm::cont::PartitionedDataSet	Execute (const vtkm::cont::PartitionedDataSet &input)

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

Private Attributes
std::string	NormalFieldName = "normal"

vtkm::cont::Field::Association	NormalFieldAssociation = vtkm::cont::Field::Association::Any

std::string	ScalarFactorFieldName = "scalarfactor"

vtkm::cont::Field::Association	ScalarFactorFieldAssociation = vtkm::cont::Field::Association::Any

vtkm::FloatDefault	ScaleAmount

Additional Inherited Members
Protected Member Functions inherited from vtkm::filter::FilterField
const VTKM_CONT vtkm::cont::Field &	GetFieldFromDataSet (const vtkm::cont::DataSet &input) const

const VTKM_CONT vtkm::cont::Field &	GetFieldFromDataSet (vtkm::IdComponent index, const vtkm::cont::DataSet &input) const

template<typename Functor , typename... Args>
VTKM_CONT void	CastAndCallScalarField (const vtkm::cont::UnknownArrayHandle &fieldArray, Functor &&functor, Args &&... args) const

template<typename Functor , typename... Args>
VTKM_CONT void	CastAndCallScalarField (const vtkm::cont::Field &field, Functor &&functor, Args &&... args) const

template<vtkm::IdComponent VecSize, typename Functor , typename... Args>
VTKM_CONT void	CastAndCallVecField (const vtkm::cont::UnknownArrayHandle &fieldArray, Functor &&functor, Args &&... args) const

template<vtkm::IdComponent VecSize, typename Functor , typename... Args>
VTKM_CONT void	CastAndCallVecField (const vtkm::cont::Field &field, Functor &&functor, Args &&... args) const

VTKM_CONT 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 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 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 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...

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

VTKM_CONT 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 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 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...

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

template<typename FieldMapper >
VTKM_CONT 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 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...

Protected Attributes inherited from vtkm::filter::Filter
vtkm::cont::Invoker	Invoke

Detailed Description

Modify points by moving points along point normals by the scalar amount times the scalar factor.

A filter that modifies point coordinates by moving points along point normals by the scalar amount times the scalar factor. It's a VTK-m version of the vtkWarpScalar in VTK. Useful for creating carpet or x-y-z plots. It doesn't modify the point coordinates, but creates a new point coordinates that have been warped.

Constructor & Destructor Documentation

◆ WarpScalar()

VTKM_CONT vtkm::filter::field_transform::WarpScalar::WarpScalar ( vtkm::FloatDefault scaleAmount )

explicit

Member Function Documentation

◆ DoExecute()

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

overrideprivatevirtual

Implements vtkm::filter::Filter.

◆ GetNormalFieldAssociation()

VTKM_CONT vtkm::cont::Field::Association vtkm::filter::field_transform::WarpScalar::GetNormalFieldAssociation ( ) const

inline

Choose the secondary field to operate on. In the warp op A + B * scaleAmount * scalarFactor, B is the secondary field

◆ GetNormalFieldName()

const VTKM_CONT std::string& vtkm::filter::field_transform::WarpScalar::GetNormalFieldName ( ) const

inline

Choose the secondary field to operate on. In the warp op A + B * scaleAmount * scalarFactor, B is the secondary field

◆ GetScalarFactorFieldAssociation()

VTKM_CONT vtkm::cont::Field::Association vtkm::filter::field_transform::WarpScalar::GetScalarFactorFieldAssociation ( ) const

inline

Choose the scalar factor field to operate on. In the warp op A + B * scaleAmount * scalarFactor, scalarFactor is the scalar factor field.

◆ GetScalarFactorFieldName()

const VTKM_CONT std::string& vtkm::filter::field_transform::WarpScalar::GetScalarFactorFieldName ( ) const

inline

Choose the scalar factor field to operate on. In the warp op A + B * scaleAmount * scalarFactor, scalarFactor is the scalar factor field.

◆ SetNormalField()

VTKM_CONT void vtkm::filter::field_transform::WarpScalar::SetNormalField	(	const std::string &	name,
		vtkm::cont::Field::Association	association = `vtkm::cont::Field::Association::Any`
	)

inline

Choose the secondary field to operate on. In the warp op A + B * scaleAmount * scalarFactor, B is the secondary field

◆ SetScalarFactorField()

VTKM_CONT void vtkm::filter::field_transform::WarpScalar::SetScalarFactorField	(	const std::string &	name,
		vtkm::cont::Field::Association	association = `vtkm::cont::Field::Association::Any`
	)

inline

Choose the scalar factor field to operate on. In the warp op A + B * scaleAmount * scalarFactor, scalarFactor is the scalar factor field.

Member Data Documentation

◆ NormalFieldAssociation

vtkm::cont::Field::Association vtkm::filter::field_transform::WarpScalar::NormalFieldAssociation = vtkm::cont::Field::Association::Any

private

◆ NormalFieldName

std::string vtkm::filter::field_transform::WarpScalar::NormalFieldName = "normal"

private

◆ ScalarFactorFieldAssociation

vtkm::cont::Field::Association vtkm::filter::field_transform::WarpScalar::ScalarFactorFieldAssociation = vtkm::cont::Field::Association::Any

private

◆ ScalarFactorFieldName

std::string vtkm::filter::field_transform::WarpScalar::ScalarFactorFieldName = "scalarfactor"

private

◆ ScaleAmount

vtkm::FloatDefault vtkm::filter::field_transform::WarpScalar::ScaleAmount

private

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

WarpScalar.h

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WarpScalar()

Member Function Documentation

◆ DoExecute()

◆ GetNormalFieldAssociation()

◆ GetNormalFieldName()

◆ GetScalarFactorFieldAssociation()

◆ GetScalarFactorFieldName()

◆ SetNormalField()

◆ SetScalarFactorField()

Member Data Documentation

◆ NormalFieldAssociation

◆ NormalFieldName

◆ ScalarFactorFieldAssociation

◆ ScalarFactorFieldName

◆ ScaleAmount