Convert an arbitrary field to an RGB or RGBA field. More...

#include <FieldToColors.h>

Inheritance diagram for vtkm::filter::field_transform::FieldToColors:

Public Types
enum	InputMode { InputMode::Scalar, InputMode::Magnitude, InputMode::Component }

enum	OutputMode { OutputMode::RGB, OutputMode::RGBA }

Public Member Functions
VTKM_CONT	FieldToColors (const vtkm::cont::ColorTable &table=vtkm::cont::ColorTable())

void	SetColorTable (const vtkm::cont::ColorTable &table)

const vtkm::cont::ColorTable &	GetColorTable () const

void	SetMappingMode (InputMode mode)

void	SetMappingToScalar ()

void	SetMappingToMagnitude ()

void	SetMappingToComponent ()

InputMode	GetMappingMode () const

bool	IsMappingScalar () const

bool	IsMappingMagnitude () const

bool	IsMappingComponent () const

void	SetMappingComponent (vtkm::IdComponent comp)

vtkm::IdComponent	GetMappingComponent () const

void	SetOutputMode (OutputMode mode)

void	SetOutputToRGB ()

void	SetOutputToRGBA ()

OutputMode	GetOutputMode () const

bool	IsOutputRGB () const

bool	IsOutputRGBA () const

void	SetNumberOfSamplingPoints (vtkm::Int32 count)

vtkm::Int32	GetNumberOfSamplingPoints () 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
vtkm::cont::ColorTable	Table

InputMode	InputModeType = InputMode::Scalar

OutputMode	OutputModeType = OutputMode::RGBA

vtkm::cont::ColorTableSamplesRGB	SamplesRGB

vtkm::cont::ColorTableSamplesRGBA	SamplesRGBA

vtkm::IdComponent	Component = 0

vtkm::Int32	SampleCount = 256

vtkm::Id	ModifiedCount = -1

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

Convert an arbitrary field to an RGB or RGBA field.

Member Enumeration Documentation

◆ InputMode

enum vtkm::filter::field_transform::FieldToColors::InputMode

strong

Enumerator
Scalar
Magnitude
Component

◆ OutputMode

enum vtkm::filter::field_transform::FieldToColors::OutputMode

strong

Enumerator
RGB
RGBA

Constructor & Destructor Documentation

◆ FieldToColors()

VTKM_CONT vtkm::filter::field_transform::FieldToColors::FieldToColors ( const vtkm::cont::ColorTable & table = vtkm::cont::ColorTable() )

explicit

Member Function Documentation

◆ DoExecute()

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

overrideprivatevirtual

Implements vtkm::filter::Filter.

◆ GetColorTable()

const vtkm::cont::ColorTable& vtkm::filter::field_transform::FieldToColors::GetColorTable ( ) const

inline

◆ GetMappingComponent()

vtkm::IdComponent vtkm::filter::field_transform::FieldToColors::GetMappingComponent ( ) const

inline

◆ GetMappingMode()

InputMode vtkm::filter::field_transform::FieldToColors::GetMappingMode ( ) const

inline

◆ GetNumberOfSamplingPoints()

vtkm::Int32 vtkm::filter::field_transform::FieldToColors::GetNumberOfSamplingPoints ( ) const

inline

◆ GetOutputMode()

OutputMode vtkm::filter::field_transform::FieldToColors::GetOutputMode ( ) const

inline

◆ IsMappingComponent()

bool vtkm::filter::field_transform::FieldToColors::IsMappingComponent ( ) const

inline

◆ IsMappingMagnitude()

bool vtkm::filter::field_transform::FieldToColors::IsMappingMagnitude ( ) const

inline

◆ IsMappingScalar()

bool vtkm::filter::field_transform::FieldToColors::IsMappingScalar ( ) const

inline

◆ IsOutputRGB()

bool vtkm::filter::field_transform::FieldToColors::IsOutputRGB ( ) const

inline

◆ IsOutputRGBA()

bool vtkm::filter::field_transform::FieldToColors::IsOutputRGBA ( ) const

inline

◆ SetColorTable()

void vtkm::filter::field_transform::FieldToColors::SetColorTable ( const vtkm::cont::ColorTable & table )

inline

◆ SetMappingComponent()

void vtkm::filter::field_transform::FieldToColors::SetMappingComponent ( vtkm::IdComponent comp )

inline

◆ SetMappingMode()

void vtkm::filter::field_transform::FieldToColors::SetMappingMode ( InputMode mode )

inline

◆ SetMappingToComponent()

void vtkm::filter::field_transform::FieldToColors::SetMappingToComponent ( )

inline

◆ SetMappingToMagnitude()

void vtkm::filter::field_transform::FieldToColors::SetMappingToMagnitude ( )

inline

◆ SetMappingToScalar()

void vtkm::filter::field_transform::FieldToColors::SetMappingToScalar ( )

inline

◆ SetNumberOfSamplingPoints()

void vtkm::filter::field_transform::FieldToColors::SetNumberOfSamplingPoints ( vtkm::Int32 count )

◆ SetOutputMode()

void vtkm::filter::field_transform::FieldToColors::SetOutputMode ( OutputMode mode )

inline

◆ SetOutputToRGB()

void vtkm::filter::field_transform::FieldToColors::SetOutputToRGB ( )

inline

◆ SetOutputToRGBA()

void vtkm::filter::field_transform::FieldToColors::SetOutputToRGBA ( )

inline

Member Data Documentation

◆ Component

vtkm::IdComponent vtkm::filter::field_transform::FieldToColors::Component = 0

private

◆ InputModeType

InputMode vtkm::filter::field_transform::FieldToColors::InputModeType = InputMode::Scalar

private

◆ ModifiedCount

vtkm::Id vtkm::filter::field_transform::FieldToColors::ModifiedCount = -1

private

◆ OutputModeType

OutputMode vtkm::filter::field_transform::FieldToColors::OutputModeType = OutputMode::RGBA

private

◆ SampleCount

vtkm::Int32 vtkm::filter::field_transform::FieldToColors::SampleCount = 256

private

◆ SamplesRGB

vtkm::cont::ColorTableSamplesRGB vtkm::filter::field_transform::FieldToColors::SamplesRGB

private

◆ SamplesRGBA

vtkm::cont::ColorTableSamplesRGBA vtkm::filter::field_transform::FieldToColors::SamplesRGBA

private

◆ Table

vtkm::cont::ColorTable vtkm::filter::field_transform::FieldToColors::Table

private

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

FieldToColors.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ InputMode

◆ OutputMode

Constructor & Destructor Documentation

◆ FieldToColors()

Member Function Documentation

◆ DoExecute()

◆ GetColorTable()

◆ GetMappingComponent()

◆ GetMappingMode()

◆ GetNumberOfSamplingPoints()

◆ GetOutputMode()

◆ IsMappingComponent()

◆ IsMappingMagnitude()

◆ IsMappingScalar()

◆ IsOutputRGB()

◆ IsOutputRGBA()

◆ SetColorTable()

◆ SetMappingComponent()

◆ SetMappingMode()

◆ SetMappingToComponent()

◆ SetMappingToMagnitude()

◆ SetMappingToScalar()

◆ SetNumberOfSamplingPoints()

◆ SetOutputMode()

◆ SetOutputToRGB()

◆ SetOutputToRGBA()

Member Data Documentation

◆ Component

◆ InputModeType

◆ ModifiedCount

◆ OutputModeType

◆ SampleCount

◆ SamplesRGB

◆ SamplesRGBA

◆ Table