Extracts cells which satisfy threshold criterion. More...

#include <Threshold.h>

Inheritance diagram for vtkm::filter::entity_extraction::Threshold:

Public Member Functions
VTKM_CONT void	SetLowerThreshold (vtkm::Float64 value)

VTKM_CONT void	SetUpperThreshold (vtkm::Float64 value)

VTKM_CONT vtkm::Float64	GetLowerThreshold () const

VTKM_CONT vtkm::Float64	GetUpperThreshold () const

VTKM_CONT void	SetThresholdBelow (vtkm::Float64 value)
	Set the threshold criterion to pass any value <= to the specified value. More...

VTKM_CONT void	SetThresholdAbove (vtkm::Float64 value)
	Set the threshold criterion to pass any value >= to the specified value. More...

VTKM_CONT void	SetThresholdBetween (vtkm::Float64 value1, vtkm::Float64 value2)
	Set the threshold criterion to pass any value between (inclusive) the given values. More...

VTKM_CONT void	SetAllInRange (bool value)
	If using field from point data, all values for all points in a cell must satisfy the threshold criterion if `AllInRange` is set. More...

VTKM_CONT bool	GetAllInRange () const

VTKM_CONT void	SetInvert (bool value)
	Invert the threshold result, i.e. More...

VTKM_CONT bool	GetInvert () const


VTKM_CONT void	SetComponentToTest (vtkm::IdComponent component)
	For multi-component fields, select how to apply the threshold criterion. The default is to test the 0th component. More...

VTKM_CONT void	SetComponentToTestToAny ()
	For multi-component fields, select how to apply the threshold criterion. The default is to test the 0th component. More...

VTKM_CONT void	SetComponentToTestToAll ()
	For multi-component fields, select how to apply the threshold criterion. The default is to test the 0th component. More...

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 Types
enum	Component { Component::Any, Component::All, Component::Selected }

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

Private Attributes
double	LowerValue = 0

double	UpperValue = 0

Component	ComponentMode = Component::Selected

vtkm::IdComponent	SelectedComponent = 0

bool	AllInRange = false

bool	Invert = false

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

Extracts cells which satisfy threshold criterion.

Extracts all cells from any dataset type that satisfy a threshold criterion. The output of this filter is an permutation of the input dataset.

You can threshold either on point or cell fields

Member Enumeration Documentation

◆ Component

enum vtkm::filter::entity_extraction::Threshold::Component

strongprivate

Enumerator
Any
All
Selected

Member Function Documentation

◆ DoExecute()

VTKM_CONT vtkm::cont::DataSet vtkm::filter::entity_extraction::Threshold::DoExecute ( const vtkm::cont::DataSet & input )

overrideprivatevirtual

Implements vtkm::filter::Filter.

◆ GetAllInRange()

VTKM_CONT bool vtkm::filter::entity_extraction::Threshold::GetAllInRange ( ) const

inline

◆ GetInvert()

VTKM_CONT bool vtkm::filter::entity_extraction::Threshold::GetInvert ( ) const

inline

◆ GetLowerThreshold()

VTKM_CONT vtkm::Float64 vtkm::filter::entity_extraction::Threshold::GetLowerThreshold ( ) const

inline

◆ GetUpperThreshold()

VTKM_CONT vtkm::Float64 vtkm::filter::entity_extraction::Threshold::GetUpperThreshold ( ) const

inline

◆ SetAllInRange()

VTKM_CONT void vtkm::filter::entity_extraction::Threshold::SetAllInRange ( bool value )

inline

If using field from point data, all values for all points in a cell must satisfy the threshold criterion if AllInRange is set.

Otherwise, just a single point's value satisfying the threshold criterion will extract the cell.

◆ SetComponentToTest()

VTKM_CONT void vtkm::filter::entity_extraction::Threshold::SetComponentToTest ( vtkm::IdComponent component )

inline

For multi-component fields, select how to apply the threshold criterion. The default is to test the 0th component.

◆ SetComponentToTestToAll()

VTKM_CONT void vtkm::filter::entity_extraction::Threshold::SetComponentToTestToAll ( )

inline

For multi-component fields, select how to apply the threshold criterion. The default is to test the 0th component.

◆ SetComponentToTestToAny()

VTKM_CONT void vtkm::filter::entity_extraction::Threshold::SetComponentToTestToAny ( )

inline

For multi-component fields, select how to apply the threshold criterion. The default is to test the 0th component.

◆ SetInvert()

VTKM_CONT void vtkm::filter::entity_extraction::Threshold::SetInvert ( bool value )

inline

Invert the threshold result, i.e.

cells that would have been in the output with this option off are excluded, while cells that would have been excluded from the output are included.

◆ SetLowerThreshold()

VTKM_CONT void vtkm::filter::entity_extraction::Threshold::SetLowerThreshold ( vtkm::Float64 value )

inline

◆ SetThresholdAbove()

VTKM_CONT void vtkm::filter::entity_extraction::Threshold::SetThresholdAbove ( vtkm::Float64 value )

Set the threshold criterion to pass any value >= to the specified value.

◆ SetThresholdBelow()

VTKM_CONT void vtkm::filter::entity_extraction::Threshold::SetThresholdBelow ( vtkm::Float64 value )

Set the threshold criterion to pass any value <= to the specified value.

◆ SetThresholdBetween()

VTKM_CONT void vtkm::filter::entity_extraction::Threshold::SetThresholdBetween	(	vtkm::Float64	value1,
		vtkm::Float64	value2
	)

Set the threshold criterion to pass any value between (inclusive) the given values.

◆ SetUpperThreshold()

VTKM_CONT void vtkm::filter::entity_extraction::Threshold::SetUpperThreshold ( vtkm::Float64 value )

inline

Member Data Documentation

◆ AllInRange

bool vtkm::filter::entity_extraction::Threshold::AllInRange = false

private

◆ ComponentMode

Component vtkm::filter::entity_extraction::Threshold::ComponentMode = Component::Selected

private

◆ Invert

bool vtkm::filter::entity_extraction::Threshold::Invert = false

private

◆ LowerValue

double vtkm::filter::entity_extraction::Threshold::LowerValue = 0

private

◆ SelectedComponent

vtkm::IdComponent vtkm::filter::entity_extraction::Threshold::SelectedComponent = 0

private

◆ UpperValue

double vtkm::filter::entity_extraction::Threshold::UpperValue = 0

private

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

Threshold.h

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Component

Member Function Documentation

◆ DoExecute()

◆ GetAllInRange()

◆ GetInvert()

◆ GetLowerThreshold()

◆ GetUpperThreshold()

◆ SetAllInRange()

◆ SetComponentToTest()

◆ SetComponentToTestToAll()

◆ SetComponentToTestToAny()

◆ SetInvert()

◆ SetLowerThreshold()

◆ SetThresholdAbove()

◆ SetThresholdBelow()

◆ SetThresholdBetween()

◆ SetUpperThreshold()

Member Data Documentation

◆ AllInRange

◆ ComponentMode

◆ Invert

◆ LowerValue

◆ SelectedComponent

◆ UpperValue