Construct the histogram of a given Field. More...

#include <Histogram.h>

Inheritance diagram for vtkm::filter::density_estimate::Histogram:

Public Member Functions
VTKM_CONT	Histogram ()

VTKM_CONT void	SetNumberOfBins (vtkm::Id count)

VTKM_CONT vtkm::Id	GetNumberOfBins () const

VTKM_CONT vtkm::Float64	GetBinDelta () const
	Returns the bin delta of the last computed field. More...

VTKM_CONT vtkm::Range	GetComputedRange () const
	Returns the range used for most recent execute. More...


VTKM_CONT void	SetRange (const vtkm::Range &range)

const VTKM_CONT vtkm::Range &	GetRange () 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

VTKM_CONT vtkm::cont::PartitionedDataSet	DoExecutePartitions (const vtkm::cont::PartitionedDataSet &inData) override


VTKM_CONT void	PreExecute (const vtkm::cont::PartitionedDataSet &input)

VTKM_CONT void	PostExecute (const vtkm::cont::PartitionedDataSet &input, vtkm::cont::PartitionedDataSet &output)

Private Attributes
vtkm::Id	NumberOfBins = 10

vtkm::Float64	BinDelta = 0

vtkm::Range	ComputedRange

vtkm::Range	Range

bool	InExecutePartitions = 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...

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

Construct the histogram of a given Field.

Construct a histogram with a default of 10 bins.

Constructor & Destructor Documentation

◆ Histogram()

VTKM_CONT vtkm::filter::density_estimate::Histogram::Histogram ( )

Member Function Documentation

◆ DoExecute()

VTKM_CONT vtkm::cont::DataSet vtkm::filter::density_estimate::Histogram::DoExecute ( const vtkm::cont::DataSet & input )

overrideprivatevirtual

Implements vtkm::filter::Filter.

◆ DoExecutePartitions()

VTKM_CONT vtkm::cont::PartitionedDataSet vtkm::filter::density_estimate::Histogram::DoExecutePartitions ( const vtkm::cont::PartitionedDataSet & inData )

overrideprivatevirtual

Reimplemented from vtkm::filter::Filter.

◆ GetBinDelta()

VTKM_CONT vtkm::Float64 vtkm::filter::density_estimate::Histogram::GetBinDelta ( ) const

inline

Returns the bin delta of the last computed field.

◆ GetComputedRange()

VTKM_CONT vtkm::Range vtkm::filter::density_estimate::Histogram::GetComputedRange ( ) const

inline

Returns the range used for most recent execute.

If SetRange is used to specify and non-empty range, then this will be same as the range after the Execute call.

◆ GetNumberOfBins()

VTKM_CONT vtkm::Id vtkm::filter::density_estimate::Histogram::GetNumberOfBins ( ) const

inline

◆ GetRange()

const VTKM_CONT vtkm::Range& vtkm::filter::density_estimate::Histogram::GetRange ( ) const

inline

Get/Set the range to use to generate the histogram. If range is set to empty, the field's global range (computed using vtkm::cont::FieldRangeGlobalCompute) will be used.

◆ PostExecute()

VTKM_CONT void vtkm::filter::density_estimate::Histogram::PostExecute	(	const vtkm::cont::PartitionedDataSet &	input,
		vtkm::cont::PartitionedDataSet &	output
	)

private

when operating on vtkm::cont::PartitionedDataSet, we want to do processing across ranks as well. Just adding pre/post handles for the same does the trick.

◆ PreExecute()

VTKM_CONT void vtkm::filter::density_estimate::Histogram::PreExecute ( const vtkm::cont::PartitionedDataSet & input )

private

when operating on vtkm::cont::PartitionedDataSet, we want to do processing across ranks as well. Just adding pre/post handles for the same does the trick.

◆ SetNumberOfBins()

VTKM_CONT void vtkm::filter::density_estimate::Histogram::SetNumberOfBins ( vtkm::Id count )

inline

◆ SetRange()

VTKM_CONT void vtkm::filter::density_estimate::Histogram::SetRange ( const vtkm::Range & range )

inline

Get/Set the range to use to generate the histogram. If range is set to empty, the field's global range (computed using vtkm::cont::FieldRangeGlobalCompute) will be used.

Member Data Documentation

◆ BinDelta

vtkm::Float64 vtkm::filter::density_estimate::Histogram::BinDelta = 0

private

◆ ComputedRange

vtkm::Range vtkm::filter::density_estimate::Histogram::ComputedRange

private

◆ InExecutePartitions

bool vtkm::filter::density_estimate::Histogram::InExecutePartitions = false

private

◆ NumberOfBins

vtkm::Id vtkm::filter::density_estimate::Histogram::NumberOfBins = 10

private

◆ Range

vtkm::Range vtkm::filter::density_estimate::Histogram::Range

private

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

Histogram.h

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Histogram()

Member Function Documentation

◆ DoExecute()

◆ DoExecutePartitions()

◆ GetBinDelta()

◆ GetComputedRange()

◆ GetNumberOfBins()

◆ GetRange()

◆ PostExecute()

◆ PreExecute()

◆ SetNumberOfBins()

◆ SetRange()

Member Data Documentation

◆ BinDelta

◆ ComputedRange

◆ InExecutePartitions

◆ NumberOfBins

◆ Range