vtkm::cont::DataSetBuilderUniform Class Reference

#include <DataSetBuilderUniform.h>

Public Member Functions
	DataSetBuilderUniform ()

Static Public Member Functions
template<typename T >
static vtkm::cont::DataSet	Create (const vtkm::Id &dimension, const T &origin, const T &spacing, const std::string &coordNm="coords")
	Create a 1D uniform DataSet. More...
static vtkm::cont::DataSet	Create (const vtkm::Id &dimension, const std::string &coordNm="coords")
	Create a 1D uniform DataSet. More...
template<typename T >
static vtkm::cont::DataSet	Create (const vtkm::Id2 &dimensions, const vtkm::Vec< T, 2 > &origin, const vtkm::Vec< T, 2 > &spacing, const std::string &coordNm="coords")
	Create a 2D uniform DataSet. More...
static vtkm::cont::DataSet	Create (const vtkm::Id2 &dimensions, const std::string &coordNm="coords")
	Create a 2D uniform DataSet. More...
template<typename T >
static vtkm::cont::DataSet	Create (const vtkm::Id3 &dimensions, const vtkm::Vec< T, 3 > &origin, const vtkm::Vec< T, 3 > &spacing, const std::string &coordNm="coords")
	Create a 3D uniform DataSet. More...
static vtkm::cont::DataSet	Create (const vtkm::Id3 &dimensions, const std::string &coordNm="coords")
	Create a 3D uniform DataSet. More...

Private Types
using	VecType = vtkm::Vec3f

Static Private Member Functions
static vtkm::cont::DataSet	CreateDataSet (const vtkm::Id3 &dimensions, const vtkm::Vec3f &origin, const vtkm::Vec3f &spacing, const std::string &coordNm)

Member Typedef Documentation

VecType

using vtkm::cont::DataSetBuilderUniform::VecType = vtkm::Vec3f

private

Constructor & Destructor Documentation

DataSetBuilderUniform()

vtkm::cont::DataSetBuilderUniform::DataSetBuilderUniform

(

)

Member Function Documentation

Create() [1/6]

static vtkm::cont::DataSet vtkm::cont::DataSetBuilderUniform::Create ( const vtkm::Id &  dimension, const std::string &  coordNm = "coords"  )

static

Create a 1D uniform DataSet.

The origin is set to 0 and the spacing is set to 1.

Parameters

[in]	dimension	The size of the grid. The dimensions are specified based on the number of points (as opposed to the number of cells).
[in]	coordNm	(optional) The name to register the coordinates as.

Create() [2/6]

template<typename T >

static vtkm::cont::DataSet vtkm::cont::DataSetBuilderUniform::Create ( const vtkm::Id &  dimension, const T &  origin, const T &  spacing, const std::string &  coordNm = "coords"  )

inlinestatic

Create a 1D uniform DataSet.

Parameters

[in]	dimension	The size of the grid. The dimensions are specified based on the number of points (as opposed to the number of cells).
[in]	origin	The origin of the data. This is the point coordinate with the minimum value in all dimensions.
[in]	spacing	The uniform distance between adjacent points.
[in]	coordNm	(optional) The name to register the coordinates as.

Create() [3/6]

static vtkm::cont::DataSet vtkm::cont::DataSetBuilderUniform::Create ( const vtkm::Id2 &  dimensions, const std::string &  coordNm = "coords"  )

static

Create a 2D uniform DataSet.

The origin is set to (0,0) and the spacing is set to (1,1).

Parameters

[in]	dimensions	The size of the grid. The dimensions are specified based on the number of points (as opposed to the number of cells).
[in]	coordNm	(optional) The name to register the coordinates as.

Create() [4/6]

template<typename T >

static vtkm::cont::DataSet vtkm::cont::DataSetBuilderUniform::Create ( const vtkm::Id2 &  dimensions, const vtkm::Vec< T, 2 > &  origin, const vtkm::Vec< T, 2 > &  spacing, const std::string &  coordNm = "coords"  )

inlinestatic

Create a 2D uniform DataSet.

Parameters

[in]	dimensions	The size of the grid. The dimensions are specified based on the number of points (as opposed to the number of cells).
[in]	origin	The origin of the data. This is the point coordinate with the minimum value in all dimensions.
[in]	spacing	The uniform distance between adjacent points.
[in]	coordNm	(optional) The name to register the coordinates as.

Create() [5/6]

static vtkm::cont::DataSet vtkm::cont::DataSetBuilderUniform::Create ( const vtkm::Id3 &  dimensions, const std::string &  coordNm = "coords"  )

static

Create a 3D uniform DataSet.

The origin is set to (0,0,0) and the spacing is set to (1,1,1).

Parameters

[in]	dimensions	The size of the grid. The dimensions are specified based on the number of points (as opposed to the number of cells).
[in]	coordNm	(optional) The name to register the coordinates as.

Create() [6/6]

template<typename T >

static vtkm::cont::DataSet vtkm::cont::DataSetBuilderUniform::Create ( const vtkm::Id3 &  dimensions, const vtkm::Vec< T, 3 > &  origin, const vtkm::Vec< T, 3 > &  spacing, const std::string &  coordNm = "coords"  )

inlinestatic

Create a 3D uniform DataSet.

Parameters

[in]	dimensions	The size of the grid. The dimensions are specified based on the number of points (as opposed to the number of cells).
[in]	origin	The origin of the data. This is the point coordinate with the minimum value in all dimensions.
[in]	spacing	The uniform distance between adjacent points.
[in]	coordNm	(optional) The name to register the coordinates as.

CreateDataSet()

static vtkm::cont::DataSet vtkm::cont::DataSetBuilderUniform::CreateDataSet ( const vtkm::Id3 &  dimensions, const vtkm::Vec3f &  origin, const vtkm::Vec3f &  spacing, const std::string &  coordNm  )

staticprivate

---

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

• DataSetBuilderUniform.h