Construct an ImageDifference of a given DataSet. More...

#include <ImageDifference.h>

Inheritance diagram for vtkm::filter::image_processing::ImageDifference:

Public Member Functions
	ImageDifference ()

vtkm::IdComponent	GetAverageRadius () const

void	SetAverageRadius (const vtkm::IdComponent &averageRadius)

vtkm::IdComponent	GetPixelShiftRadius () const

void	SetPixelShiftRadius (const vtkm::IdComponent &pixelShiftRadius)

vtkm::FloatDefault	GetAllowedPixelErrorRatio () const

void	SetAllowedPixelErrorRatio (const vtkm::FloatDefault &pixelErrorRatio)

vtkm::FloatDefault	GetPixelDiffThreshold () const

void	SetPixelDiffThreshold (const vtkm::FloatDefault &threshold)

bool	GetImageDiffWithinThreshold () const

void	SetThresholdFieldName (const std::string &name)

std::string	GetThresholdFieldName () const

void	SetPrimaryField (const std::string &name, vtkm::cont::Field::Association association=vtkm::cont::Field::Association::Any)
	Choose the primary field to operate on. More...

std::string	GetPrimaryFieldName () const

vtkm::cont::Field::Association	GetPrimaryFieldAssociation () const

void	SetSecondaryField (const std::string &name, vtkm::cont::Field::Association association=vtkm::cont::Field::Association::Any)
	Choose the secondary field to operate on. More...

std::string	GetSecondaryFieldName () const

vtkm::cont::Field::Association	GetSecondaryFieldAssociation () 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...

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

Private Attributes
vtkm::IdComponent	AverageRadius = 0

vtkm::IdComponent	PixelShiftRadius = 0

vtkm::FloatDefault	AllowedPixelErrorRatio = 0.00025f

vtkm::FloatDefault	PixelDiffThreshold = 0.05f

bool	ImageDiffWithinThreshold = true

std::string	ThresholdFieldName = "threshold-output"

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

Construct an ImageDifference of a given DataSet.

The dataset generated by executing this filter is a Dataset with two Fields:

"image-diff": Uniform Structured Dataset, difference values of image A - B
"threshold-output": Uniform Structured Dataset, the magnitudes of the pixel differences

The threshold-output is calculated for each pixel using the vtkm::Magnitude vector function on the individual pixel difference.

Constructor & Destructor Documentation

◆ ImageDifference()

vtkm::filter::image_processing::ImageDifference::ImageDifference ( )

Member Function Documentation

◆ DoExecute()

vtkm::cont::DataSet vtkm::filter::image_processing::ImageDifference::DoExecute ( const vtkm::cont::DataSet & primaryArray )

overrideprivatevirtual

Implements vtkm::filter::Filter.

◆ GetAllowedPixelErrorRatio()

vtkm::FloatDefault vtkm::filter::image_processing::ImageDifference::GetAllowedPixelErrorRatio ( ) const

inline

◆ GetAverageRadius()

vtkm::IdComponent vtkm::filter::image_processing::ImageDifference::GetAverageRadius ( ) const

inline

◆ GetImageDiffWithinThreshold()

bool vtkm::filter::image_processing::ImageDifference::GetImageDiffWithinThreshold ( ) const

inline

◆ GetPixelDiffThreshold()

vtkm::FloatDefault vtkm::filter::image_processing::ImageDifference::GetPixelDiffThreshold ( ) const

inline

◆ GetPixelShiftRadius()

vtkm::IdComponent vtkm::filter::image_processing::ImageDifference::GetPixelShiftRadius ( ) const

inline

◆ GetPrimaryFieldAssociation()

vtkm::cont::Field::Association vtkm::filter::image_processing::ImageDifference::GetPrimaryFieldAssociation ( ) const

inline

◆ GetPrimaryFieldName()

std::string vtkm::filter::image_processing::ImageDifference::GetPrimaryFieldName ( ) const

inline

◆ GetSecondaryFieldAssociation()

vtkm::cont::Field::Association vtkm::filter::image_processing::ImageDifference::GetSecondaryFieldAssociation ( ) const

inline

◆ GetSecondaryFieldName()

std::string vtkm::filter::image_processing::ImageDifference::GetSecondaryFieldName ( ) const

inline

◆ GetThresholdFieldName()

std::string vtkm::filter::image_processing::ImageDifference::GetThresholdFieldName ( ) const

inline

◆ SetAllowedPixelErrorRatio()

void vtkm::filter::image_processing::ImageDifference::SetAllowedPixelErrorRatio ( const vtkm::FloatDefault & pixelErrorRatio )

inline

◆ SetAverageRadius()

void vtkm::filter::image_processing::ImageDifference::SetAverageRadius ( const vtkm::IdComponent & averageRadius )

inline

◆ SetPixelDiffThreshold()

void vtkm::filter::image_processing::ImageDifference::SetPixelDiffThreshold ( const vtkm::FloatDefault & threshold )

inline

◆ SetPixelShiftRadius()

void vtkm::filter::image_processing::ImageDifference::SetPixelShiftRadius ( const vtkm::IdComponent & pixelShiftRadius )

inline

◆ SetPrimaryField()

void vtkm::filter::image_processing::ImageDifference::SetPrimaryField	(	const std::string &	name,
		vtkm::cont::Field::Association	association = `vtkm::cont::Field::Association::Any`
	)

inline

Choose the primary field to operate on.

For Image difference A - B, A is the primary field.

◆ SetSecondaryField()

void vtkm::filter::image_processing::ImageDifference::SetSecondaryField	(	const std::string &	name,
		vtkm::cont::Field::Association	association = `vtkm::cont::Field::Association::Any`
	)

inline

Choose the secondary field to operate on.

For Image difference A - B, B is the secondary field.

◆ SetThresholdFieldName()

void vtkm::filter::image_processing::ImageDifference::SetThresholdFieldName ( const std::string & name )

inline

Member Data Documentation

◆ AllowedPixelErrorRatio

vtkm::FloatDefault vtkm::filter::image_processing::ImageDifference::AllowedPixelErrorRatio = 0.00025f

private

◆ AverageRadius

vtkm::IdComponent vtkm::filter::image_processing::ImageDifference::AverageRadius = 0

private

◆ ImageDiffWithinThreshold

bool vtkm::filter::image_processing::ImageDifference::ImageDiffWithinThreshold = true

private

◆ PixelDiffThreshold

vtkm::FloatDefault vtkm::filter::image_processing::ImageDifference::PixelDiffThreshold = 0.05f

private

◆ PixelShiftRadius

vtkm::IdComponent vtkm::filter::image_processing::ImageDifference::PixelShiftRadius = 0

private

◆ ThresholdFieldName

std::string vtkm::filter::image_processing::ImageDifference::ThresholdFieldName = "threshold-output"

private

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

ImageDifference.h

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ImageDifference()

Member Function Documentation

◆ DoExecute()

◆ GetAllowedPixelErrorRatio()

◆ GetAverageRadius()

◆ GetImageDiffWithinThreshold()

◆ GetPixelDiffThreshold()

◆ GetPixelShiftRadius()

◆ GetPrimaryFieldAssociation()

◆ GetPrimaryFieldName()

◆ GetSecondaryFieldAssociation()

◆ GetSecondaryFieldName()

◆ GetThresholdFieldName()

◆ SetAllowedPixelErrorRatio()

◆ SetAverageRadius()

◆ SetPixelDiffThreshold()

◆ SetPixelShiftRadius()

◆ SetPrimaryField()

◆ SetSecondaryField()

◆ SetThresholdFieldName()

Member Data Documentation

◆ AllowedPixelErrorRatio

◆ AverageRadius

◆ ImageDiffWithinThreshold

◆ PixelDiffThreshold

◆ PixelShiftRadius

◆ ThresholdFieldName