#include <ParticleDensityBase.h>

Inheritance diagram for vtkm::filter::density_estimate::ParticleDensityBase:

Public Member Functions
VTKM_CONT void	SetComputeNumberDensity (bool yes)

VTKM_CONT bool	GetComputeNumberDensity () const

VTKM_CONT void	SetDivideByVolume (bool yes)

VTKM_CONT bool	GetDivideByVolume () const


VTKM_CONT void	SetDimension (const vtkm::Id3 &dimension)
	The number of bins in the grid used as regions to estimate density. More...

VTKM_CONT vtkm::Id3	GetDimension () const
	The number of bins in the grid used as regions to estimate density. More...


VTKM_CONT void	SetOrigin (const vtkm::Vec3f &origin)
	The lower-left (minimum) corner of the domain of density estimation. More...

VTKM_CONT vtkm::Vec3f	GetOrigin () const
	The lower-left (minimum) corner of the domain of density estimation. More...


VTKM_CONT void	SetSpacing (const vtkm::Vec3f &spacing)
	The spacing of the grid points used to form the grid for density estimation. More...

VTKM_CONT vtkm::Vec3f	GetSpacing () const
	The spacing of the grid points used to form the grid for density estimation. More...


VTKM_CONT void	SetBounds (const vtkm::Bounds &bounds)
	The bounds of the region where density estimation occurs. More...

VTKM_CONT vtkm::Bounds	GetBounds () const
	The bounds of the region where density estimation occurs. 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)

Protected Member Functions
	ParticleDensityBase ()=default

VTKM_CONT void	DoDivideByVolume (const vtkm::cont::UnknownArrayHandle &array) const

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::DataSet	DoExecute (const vtkm::cont::DataSet &inData)=0

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
vtkm::Id3	Dimension = { 100, 100, 100 }

vtkm::Vec3f	Origin = { 0.0f, 0.0f, 0.0f }

vtkm::Vec3f	Spacing = { 1.0f, 1.0f, 1.0f }

bool	ComputeNumberDensity = false

bool	DivideByVolume = true

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

Constructor & Destructor Documentation

◆ ParticleDensityBase()

vtkm::filter::density_estimate::ParticleDensityBase::ParticleDensityBase ( )

protecteddefault

Member Function Documentation

◆ DoDivideByVolume()

VTKM_CONT void vtkm::filter::density_estimate::ParticleDensityBase::DoDivideByVolume ( const vtkm::cont::UnknownArrayHandle & array ) const

protected

◆ GetBounds()

VTKM_CONT vtkm::Bounds vtkm::filter::density_estimate::ParticleDensityBase::GetBounds ( ) const

inline

The bounds of the region where density estimation occurs.

The dimensions must be set before the bounds are set. Calling SetDimension will change the ranges of the bounds.

◆ GetComputeNumberDensity()

VTKM_CONT bool vtkm::filter::density_estimate::ParticleDensityBase::GetComputeNumberDensity ( ) const

inline

◆ GetDimension()

VTKM_CONT vtkm::Id3 vtkm::filter::density_estimate::ParticleDensityBase::GetDimension ( ) const

inline

The number of bins in the grid used as regions to estimate density.

To estimate particle density, this filter defines a uniform grid in space. The Dimension is the number of grid particles in each direction.

◆ GetDivideByVolume()

VTKM_CONT bool vtkm::filter::density_estimate::ParticleDensityBase::GetDivideByVolume ( ) const

inline

◆ GetOrigin()

VTKM_CONT vtkm::Vec3f vtkm::filter::density_estimate::ParticleDensityBase::GetOrigin ( ) const

inline

The lower-left (minimum) corner of the domain of density estimation.

◆ GetSpacing()

VTKM_CONT vtkm::Vec3f vtkm::filter::density_estimate::ParticleDensityBase::GetSpacing ( ) const

inline

The spacing of the grid points used to form the grid for density estimation.

◆ SetBounds()

VTKM_CONT void vtkm::filter::density_estimate::ParticleDensityBase::SetBounds ( const vtkm::Bounds & bounds )

inline

The bounds of the region where density estimation occurs.

The dimensions must be set before the bounds are set. Calling SetDimension will change the ranges of the bounds.

◆ SetComputeNumberDensity()

VTKM_CONT void vtkm::filter::density_estimate::ParticleDensityBase::SetComputeNumberDensity ( bool yes )

inline

◆ SetDimension()

VTKM_CONT void vtkm::filter::density_estimate::ParticleDensityBase::SetDimension ( const vtkm::Id3 & dimension )

inline

The number of bins in the grid used as regions to estimate density.

To estimate particle density, this filter defines a uniform grid in space. The Dimension is the number of grid particles in each direction.

◆ SetDivideByVolume()

VTKM_CONT void vtkm::filter::density_estimate::ParticleDensityBase::SetDivideByVolume ( bool yes )

inline

◆ SetOrigin()

VTKM_CONT void vtkm::filter::density_estimate::ParticleDensityBase::SetOrigin ( const vtkm::Vec3f & origin )

inline

The lower-left (minimum) corner of the domain of density estimation.

◆ SetSpacing()

VTKM_CONT void vtkm::filter::density_estimate::ParticleDensityBase::SetSpacing ( const vtkm::Vec3f & spacing )

inline

The spacing of the grid points used to form the grid for density estimation.

Member Data Documentation

◆ ComputeNumberDensity

bool vtkm::filter::density_estimate::ParticleDensityBase::ComputeNumberDensity = false

protected

◆ Dimension

vtkm::Id3 vtkm::filter::density_estimate::ParticleDensityBase::Dimension = { 100, 100, 100 }

protected

◆ DivideByVolume

bool vtkm::filter::density_estimate::ParticleDensityBase::DivideByVolume = true

protected

◆ Origin

vtkm::Vec3f vtkm::filter::density_estimate::ParticleDensityBase::Origin = { 0.0f, 0.0f, 0.0f }

protected

◆ Spacing

vtkm::Vec3f vtkm::filter::density_estimate::ParticleDensityBase::Spacing = { 1.0f, 1.0f, 1.0f }

protected

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

ParticleDensityBase.h

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ ParticleDensityBase()

Member Function Documentation

◆ DoDivideByVolume()

◆ GetBounds()

◆ GetComputeNumberDensity()

◆ GetDimension()

◆ GetDivideByVolume()

◆ GetOrigin()

◆ GetSpacing()

◆ SetBounds()

◆ SetComputeNumberDensity()

◆ SetDimension()

◆ SetDivideByVolume()

◆ SetOrigin()

◆ SetSpacing()

Member Data Documentation

◆ ComputeNumberDensity

◆ Dimension

◆ DivideByVolume

◆ Origin

◆ Spacing