Visualize isosurface uncertainty using Monte Carlo approach for uniformly distributed data. More...

#include <ContourUncertainUniformMonteCarlo.h>

Inheritance diagram for vtkm::filter::uncertainty::ContourUncertainUniformMonteCarlo:

Public Member Functions
	ContourUncertainUniformMonteCarlo ()

void	SetMinField (const std::string &fieldName)

void	SetMaxField (const std::string &fieldName)

void	SetIsoValue (vtkm::Float64 value)

vtkm::Float64	GetIsoValue () const

void	SetNumSample (vtkm::IdComponent value)

vtkm::IdComponent	GetNumSample () const

void	SetCrossProbabilityName (const std::string &name)

const std::string &	GetCrossProbabilityName () const

void	SetNumberNonzeroProbabilityName (const std::string &name)

const std::string &	GetNumberNonzeroProbabilityName () const

void	SetEntropyName (const std::string &name)

const std::string &	GetEntropyName () const

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

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

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

Private Attributes
std::string	NumberNonzeroProbabilityName = "num_nonzero_probability"

std::string	EntropyName = "entropy"

vtkm::Float64	IsoValue = 0.0

vtkm::IdComponent	IterValue = 1

Additional Inherited Members
Protected Attributes inherited from vtkm::filter::Filter
vtkm::cont::Invoker	Invoke

Detailed Description

Visualize isosurface uncertainty using Monte Carlo approach for uniformly distributed data.

This filter is implemented to validate the correctness of the ContourUncertainUniform filter. We encourage usage of the ContourUncertainUniform filter because the Monte Carlo approach implemented in this filter is computationally inefficient.

Constructor & Destructor Documentation

◆ ContourUncertainUniformMonteCarlo()

vtkm::filter::uncertainty::ContourUncertainUniformMonteCarlo::ContourUncertainUniformMonteCarlo ( )

Member Function Documentation

◆ DoExecute()

vtkm::cont::DataSet vtkm::filter::uncertainty::ContourUncertainUniformMonteCarlo::DoExecute ( const vtkm::cont::DataSet & input )

overrideprotectedvirtual

Implements vtkm::filter::Filter.

◆ GetCrossProbabilityName()

const std::string& vtkm::filter::uncertainty::ContourUncertainUniformMonteCarlo::GetCrossProbabilityName ( ) const

inline

◆ GetEntropyName()

const std::string& vtkm::filter::uncertainty::ContourUncertainUniformMonteCarlo::GetEntropyName ( ) const

inline

◆ GetIsoValue()

vtkm::Float64 vtkm::filter::uncertainty::ContourUncertainUniformMonteCarlo::GetIsoValue ( ) const

inline

◆ GetNumberNonzeroProbabilityName()

const std::string& vtkm::filter::uncertainty::ContourUncertainUniformMonteCarlo::GetNumberNonzeroProbabilityName ( ) const

inline

◆ GetNumSample()

vtkm::IdComponent vtkm::filter::uncertainty::ContourUncertainUniformMonteCarlo::GetNumSample ( ) const

inline

◆ SetCrossProbabilityName()

void vtkm::filter::uncertainty::ContourUncertainUniformMonteCarlo::SetCrossProbabilityName ( const std::string & name )

inline

◆ SetEntropyName()

void vtkm::filter::uncertainty::ContourUncertainUniformMonteCarlo::SetEntropyName ( const std::string & name )

inline

◆ SetIsoValue()

void vtkm::filter::uncertainty::ContourUncertainUniformMonteCarlo::SetIsoValue ( vtkm::Float64 value )

inline

◆ SetMaxField()

void vtkm::filter::uncertainty::ContourUncertainUniformMonteCarlo::SetMaxField ( const std::string & fieldName )

inline

◆ SetMinField()

void vtkm::filter::uncertainty::ContourUncertainUniformMonteCarlo::SetMinField ( const std::string & fieldName )

inline

◆ SetNumberNonzeroProbabilityName()

void vtkm::filter::uncertainty::ContourUncertainUniformMonteCarlo::SetNumberNonzeroProbabilityName ( const std::string & name )

inline

◆ SetNumSample()

void vtkm::filter::uncertainty::ContourUncertainUniformMonteCarlo::SetNumSample ( vtkm::IdComponent value )

inline

Member Data Documentation

◆ EntropyName

std::string vtkm::filter::uncertainty::ContourUncertainUniformMonteCarlo::EntropyName = "entropy"

private

◆ IsoValue

vtkm::Float64 vtkm::filter::uncertainty::ContourUncertainUniformMonteCarlo::IsoValue = 0.0

private

◆ IterValue

vtkm::IdComponent vtkm::filter::uncertainty::ContourUncertainUniformMonteCarlo::IterValue = 1

private

◆ NumberNonzeroProbabilityName

std::string vtkm::filter::uncertainty::ContourUncertainUniformMonteCarlo::NumberNonzeroProbabilityName = "num_nonzero_probability"

private

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

ContourUncertainUniformMonteCarlo.h

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ContourUncertainUniformMonteCarlo()

Member Function Documentation

◆ DoExecute()

◆ GetCrossProbabilityName()

◆ GetEntropyName()

◆ GetIsoValue()

◆ GetNumberNonzeroProbabilityName()

◆ GetNumSample()

◆ SetCrossProbabilityName()

◆ SetEntropyName()

◆ SetIsoValue()

◆ SetMaxField()

◆ SetMinField()

◆ SetNumberNonzeroProbabilityName()

◆ SetNumSample()

Member Data Documentation

◆ EntropyName

◆ IsoValue

◆ IterValue

◆ NumberNonzeroProbabilityName