axom::spin Namespace Reference

Namespaces
	internal

Classes
class	BlockData
	Minimal implementation of a BlockDataType for an OctreeBase. More...
struct	Brood
struct	Brood< GridPt, GridPt >
struct	BroodRepresentationTraits
	Traits class to manage types for different point representations in a SparseOctreeLevel. More...
struct	BroodRepresentationTraits< CoordType, DIM, BroodDataType, primal::Point< CoordType, DIM > >
	Traits class to manage types for different point representations in a SparseOctreeLevel. More...
class	BVH
	Defines a Bounding Volume Hierarchy (BVH) spatial acceleration data structure over a set of geometric entities. More...
class	BVHTree
	The BVHTree class provides functionality for generating a Bounding Volume Hierarchy (BVH) of axis-aligned bounding boxes, i.e., buckets that spatially partitions a set of objects. Each object is defined by its bounding box and user-supplied data-structure specified as a template argument. Once generated, the BVHTree can then be used as an acceleration structure to speed up the performance of point queries on the given objects, e.g., minimum distance, closest point, orientation, etc. More...
class	DenseOctreeLevel
class	ImplicitGrid
	An implicit grid is an occupancy-based spatial index over an indexed set of objects in space. More...
struct	MortonBase
class	Mortonizer
	Helper class for MortonIndexing of a point's coordinate. More...
struct	Mortonizer< CoordType, MortonIndexType, 2 >
struct	Mortonizer< CoordType, MortonIndexType, 3 >
class	OctreeBase
	Handles the non-geometric operations for our octree such as refinement, finding the parents and children of a node and determining whether a leaf node exists. More...
class	OctreeLevel
struct	PointHash
class	RectangularLattice
	A rectangular lattice maps all of space (of dimension NDIMS) into a rectangular grid of cells identified by integer coordinates. More...
class	SparseOctreeLevel
class	SpatialOctree
	Adds spatial extents to an OctreeBase, allowing point location. More...
class	UniformGrid
	A spatial index defined by origin, spacing, and resolution. More...

Enumerations
enum	BVHReturnCodes { BVH_BUILD_FAILED = -1, BVH_BUILD_OK }
	Enumerates the list of return codes for various BVH operations. More...
enum	TreeBlockStatus { BlockNotInTree, LeafBlock, InternalBlock }
	Helper enumeration for status of a BlockIndex within an OctreeLevel instance. More...

Functions
template<typename MortonIndexType , typename CoordType , int DIM>
MortonIndexType	convertPointToMorton (const primal::Point< CoordType, DIM > &pt)
	A helper function to convert a point directly to a MortonIndex. More...
template<typename CoordType , int DIM, typename MortonIndexType >
primal::Point< CoordType, DIM >	convertMortonToPoint (MortonIndexType idx)
	A helper function to convert a MortonIndex back to a point. More...
template<int NDIMS, typename SpaceCoordType , typename CellCoordType >
RectangularLattice< NDIMS, SpaceCoordType, CellCoordType >	rectangular_lattice_from_bounding_box (const primal::BoundingBox< SpaceCoordType, NDIMS > &bbox, const primal::NumericArray< CellCoordType, NDIMS > &gridRes)
	Helper function to create a Rectangular Lattice from a supplied bounding box and grid resolution. More...
template<int NDIMS, typename SpaceCoordType , typename CellCoordType >
bool	operator== (const RectangularLattice< NDIMS, SpaceCoordType, CellCoordType > &lhs, const RectangularLattice< NDIMS, SpaceCoordType, CellCoordType > &rhs)
template<int NDIMS, typename SpaceCoordType , typename CellCoordType >
bool	operator!= (const RectangularLattice< NDIMS, SpaceCoordType, CellCoordType > &lhs, const RectangularLattice< NDIMS, SpaceCoordType, CellCoordType > &rhs)
template<int NDIMS, typename SpaceCoordType , typename CellCoordType >
std::ostream &	operator<< (std::ostream &os, const RectangularLattice< NDIMS, SpaceCoordType, CellCoordType > &lattice)

Enumeration Type Documentation

BVHReturnCodes

enum axom::spin::BVHReturnCodes

Enumerates the list of return codes for various BVH operations.

Enumerator
BVH_BUILD_FAILED	indicates that generation of the BVH failed
BVH_BUILD_OK	indicates that the BVH was generated successfully

TreeBlockStatus

enum axom::spin::TreeBlockStatus

Helper enumeration for status of a BlockIndex within an OctreeLevel instance.

Enumerator
BlockNotInTree
LeafBlock	Status of blocks that are not in the tree
InternalBlock	Status of blocks that are leaves in the tree Status of blocks that are internal to the tree

Function Documentation

convertPointToMorton()

template<typename MortonIndexType , typename CoordType , int DIM>

MortonIndexType axom::spin::convertPointToMorton ( const primal::Point< CoordType, DIM > &  pt )

inline

A helper function to convert a point directly to a MortonIndex.

Returns

The Morton index of the point

convertMortonToPoint()

template<typename CoordType , int DIM, typename MortonIndexType >

primal::Point<CoordType, DIM> axom::spin::convertMortonToPoint ( MortonIndexType  idx )

inline

A helper function to convert a MortonIndex back to a point.

Returns

The demortonized Point

rectangular_lattice_from_bounding_box()

template<int NDIMS, typename SpaceCoordType , typename CellCoordType >

RectangularLattice<NDIMS, SpaceCoordType, CellCoordType> axom::spin::rectangular_lattice_from_bounding_box	(	const primal::BoundingBox< SpaceCoordType, NDIMS > &	bbox,
		const primal::NumericArray< CellCoordType, NDIMS > &	gridRes
	)

Helper function to create a Rectangular Lattice from a supplied bounding box and grid resolution.

Parameters

bbox	The bounding box from which to construct a RectangularLattice
gridRes	The resolution of the input grid

This is a convenience function to simplify working with bounding boxes. It extracts the lattice spacing from the supplied bounding box and resolution, and sets the lattice origin to the bounding box's minimum corner position.

Note

If the bounding box range along a dimension is near zero (i.e. smaller than 1E-50, the grid resolution in that dimension will be set to zero in that dimension.

References axom::primal::BoundingBox< T, NDIMS >::getMax(), axom::primal::BoundingBox< T, NDIMS >::getMin(), and axom::spin::RectangularLattice< NDIMS, SpaceCoordType, CellCoordType >::spacing().

Referenced by axom::spin::ImplicitGrid< NDIMS, TheIndexType >::initialize(), and axom::spin::UniformGrid< T, NDIMS >::UniformGrid().

operator==()

template<int NDIMS, typename SpaceCoordType , typename CellCoordType >

bool axom::spin::operator==	(	const RectangularLattice< NDIMS, SpaceCoordType, CellCoordType > &	lhs,
		const RectangularLattice< NDIMS, SpaceCoordType, CellCoordType > &	rhs
	)

---

Free functions implementing comparison and arithmetic operators

Equality operator on two RectangularLattices

References axom::spin::RectangularLattice< NDIMS, SpaceCoordType, CellCoordType >::origin(), and axom::spin::RectangularLattice< NDIMS, SpaceCoordType, CellCoordType >::spacing().

Referenced by axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIterator< OctreeLevel, IterHelper, DataType >::operator!=().

operator!=()

template<int NDIMS, typename SpaceCoordType , typename CellCoordType >

bool axom::spin::operator!=	(	const RectangularLattice< NDIMS, SpaceCoordType, CellCoordType > &	lhs,
		const RectangularLattice< NDIMS, SpaceCoordType, CellCoordType > &	rhs
	)

Inequality operator on two RectangularLattices

operator<<()

template<int NDIMS, typename SpaceCoordType , typename CellCoordType >

std::ostream& axom::spin::operator<<	(	std::ostream &	os,
		const RectangularLattice< NDIMS, SpaceCoordType, CellCoordType > &	lattice
	)

Stream output operator on a RectangularLattice

References axom::spin::RectangularLattice< NDIMS, SpaceCoordType, CellCoordType >::print().