RootNode< ChildT > Class Template Reference

Top-most node of the VDB tree structure. More...

#include <nanovdb/NanoVDB.h>

Inherits RootData< ChildT >.

Classes
class	BaseIter
class	ChildIter
class	DenseIter
class	ValueIter
class	ValueOnIter

Public Types
using	DataType = RootData< ChildT >
using	ChildNodeType = ChildT
using	RootType = RootNode< ChildT >
using	RootNodeType = RootType
using	UpperNodeType = ChildT
using	LowerNodeType = typename UpperNodeType::ChildNodeType
using	LeafNodeType = typename ChildT::LeafNodeType
using	ValueType = typename DataType::ValueT
using	FloatType = typename DataType::StatsT
using	BuildType = typename DataType::BuildT
using	CoordType = typename ChildT::CoordType
using	BBoxType = BBox< CoordType >
using	AccessorType = DefaultReadAccessor< BuildType >
using	Tile = typename DataType::Tile
using	ChildIterator = ChildIter< RootNode >
using	ConstChildIterator = ChildIter< const RootNode >
using	ValueIterator = ValueIter< RootNode >
using	ConstValueIterator = ValueIter< const RootNode >
using	ValueOnIterator = ValueOnIter< RootNode >
using	ConstValueOnIterator = ValueOnIter< const RootNode >
using	DenseIterator = DenseIter< RootNode >
using	ConstDenseIterator = DenseIter< const RootNode >
using	ValueT = typename ChildT::ValueType
using	BuildT = typename ChildT::BuildType
using	CoordT = typename ChildT::CoordType
using	StatsT = typename ChildT::FloatType
using	KeyT = uint64_t
	Return a key based on the coordinates of a voxel. More...

Public Member Functions
ChildIterator	beginChild ()
ConstChildIterator	cbeginChild () const
ValueIterator	beginValue ()
ConstValueIterator	cbeginValueAll () const
ValueOnIterator	beginValueOn ()
ConstValueOnIterator	cbeginValueOn () const
DenseIterator	beginDense ()
ConstDenseIterator	cbeginDense () const
ConstDenseIterator	cbeginChildAll () const
	RootNode ()=delete
	This class cannot be constructed or deleted. More...
	RootNode (const RootNode &)=delete
RootNode &	operator= (const RootNode &)=delete
	~RootNode ()=delete
AccessorType	getAccessor () const
DataType *	data ()
const DataType *	data () const
const BBoxType &	bbox () const
	Return a const reference to the index bounding box of all the active values in this tree, i.e. in all nodes of the tree. More...
const ValueType &	background () const
	Return the total number of active voxels in the root and all its child nodes. More...
const uint32_t &	tileCount () const
	Return the number of tiles encoded in this root node. More...
const uint32_t &	getTableSize () const
const ValueType &	minimum () const
	Return a const reference to the minimum active value encoded in this root node and any of its child nodes. More...
const ValueType &	maximum () const
	Return a const reference to the maximum active value encoded in this root node and any of its child nodes. More...
const FloatType &	average () const
	Return a const reference to the average of all the active values encoded in this root node and any of its child nodes. More...
FloatType	variance () const
	Return the variance of all the active values encoded in this root node and any of its child nodes. More...
const FloatType &	stdDeviation () const
	Return a const reference to the standard deviation of all the active values encoded in this root node and any of its child nodes. More...
uint64_t	memUsage () const
	Return the actual memory footprint of this root node. More...
bool	isEmpty () const
	Return true if this RootNode is empty, i.e. contains no values or nodes. More...
ValueType	getValue (const CoordType &ijk) const
	Return the value of the given voxel. More...
ValueType	getValue (int i, int j, int k) const
bool	isActive (const CoordType &ijk) const
bool	probeValue (const CoordType &ijk, ValueType &v) const
	return the state and updates the value of the specified voxel More...
const LeafNodeType *	probeLeaf (const CoordType &ijk) const
const ChildNodeType *	probeChild (const CoordType &ijk) const
ChildNodeType *	probeChild (const CoordType &ijk)
template<typename OpT , typename... ArgsT>
auto	get (const CoordType &ijk, ArgsT &&...args) const
const Tile *	tile (uint32_t n) const
	Returns a non-const reference to the tile at the specified linear offset. More...
Tile *	tile (uint32_t n)
Tile *	probeTile (const CoordT &ijk)
const Tile *	probeTile (const CoordT &ijk) const
ChildT *	getChild (const Tile *tile)
	Returns a const reference to the child node in the specified tile. More...
const ChildT *	getChild (const Tile *tile) const
const ValueT &	getMin () const
const ValueT &	getMax () const
void	setMin (const ValueT &v)
void	setMax (const ValueT &v)
void	setAvg (const StatsT &v)
void	setDev (const StatsT &v)

Static Public Member Functions
static uint64_t	memUsage (uint32_t tableSize)
	Return the expected memory footprint in bytes with the specified number of tiles. More...
template<typename CoordType >
static KeyT	CoordToKey (const CoordType &ijk)
static CoordT	KeyToCoord (const KeyT &key)
static constexpr uint32_t	padding ()
	Return padding of this class in bytes, due to aliasing and 32B alignment. More...

Public Attributes
template<typename OpT , typename... ArgsT>
decltype(OpT::set(std::declval< Tile & >(), std::declval< ArgsT >()...))	set (const CoordType &ijk, ArgsT &&...args)
BBox< CoordT >	mBBox
uint32_t	mTableSize
ValueT	mBackground
ValueT	mMinimum
ValueT	mMaximum
StatsT	mAverage
StatsT	mStdDevi

Static Public Attributes
static constexpr bool	FIXED_SIZE = DataType::FIXED_SIZE
static constexpr uint32_t	LEVEL = 1 + ChildT::LEVEL

Friends
template<typename , int , int , int >
class	ReadAccessor
template<typename >
class	Tree

Detailed Description

template<typename ChildT>
class nanovdb::RootNode< ChildT >

Top-most node of the VDB tree structure.

Member Typedef Documentation

using AccessorType = DefaultReadAccessor<BuildType>

using BBoxType = BBox<CoordType>

using BuildT = typename ChildT::BuildType

inherited

using BuildType = typename DataType::BuildT

using ChildIterator = ChildIter<RootNode>

using ChildNodeType = ChildT

using ConstChildIterator = ChildIter<const RootNode>

using ConstDenseIterator = DenseIter<const RootNode>

using ConstValueIterator = ValueIter<const RootNode>

using ConstValueOnIterator = ValueOnIter<const RootNode>

using CoordT = typename ChildT::CoordType

inherited

using CoordType = typename ChildT::CoordType

using DataType = RootData<ChildT>

using DenseIterator = DenseIter<RootNode>

using FloatType = typename DataType::StatsT

using KeyT = uint64_t

inherited

Return a key based on the coordinates of a voxel.

using LeafNodeType = typename ChildT::LeafNodeType

using LowerNodeType = typename UpperNodeType::ChildNodeType

using RootNodeType = RootType

using RootType = RootNode<ChildT>

using StatsT = typename ChildT::FloatType

inherited

using Tile = typename DataType::Tile

using UpperNodeType = ChildT

using ValueIterator = ValueIter<RootNode>

using ValueOnIterator = ValueOnIter<RootNode>

using ValueT = typename ChildT::ValueType

inherited

using ValueType = typename DataType::ValueT

Constructor & Destructor Documentation

RootNode ( )

delete

This class cannot be constructed or deleted.

RootNode ( const RootNode< ChildT > &  )

delete

~RootNode ( )

delete

Member Function Documentation

const FloatType& average ( ) const

inline

Return a const reference to the average of all the active values encoded in this root node and any of its child nodes.

const ValueType& background ( ) const

inline

Return the total number of active voxels in the root and all its child nodes.

Return a const reference to the background value, i.e. the value associated with any coordinate location that has not been set explicitly.

const BBoxType& bbox ( ) const

inline

Return a const reference to the index bounding box of all the active values in this tree, i.e. in all nodes of the tree.

ChildIterator beginChild ( )

inline

DenseIterator beginDense ( )

inline

ValueIterator beginValue ( )

inline

ValueOnIterator beginValueOn ( )

inline

ConstChildIterator cbeginChild ( ) const

inline

ConstDenseIterator cbeginChildAll ( ) const

inline

ConstDenseIterator cbeginDense ( ) const

inline

ConstValueIterator cbeginValueAll ( ) const

inline

ConstValueOnIterator cbeginValueOn ( ) const

inline

static KeyT CoordToKey ( const CoordType &  ijk )

inlinestaticinherited

DataType* data ( )

inline

const DataType* data ( ) const

inline

auto get ( const CoordType &  ijk, ArgsT &&...  args  ) const

inline

AccessorType getAccessor ( ) const

inline

ChildT* getChild ( const Tile *  tile )

inlineinherited

Returns a const reference to the child node in the specified tile.

Warning

A child node is assumed to exist in the specified tile

const ChildT* getChild ( const Tile *  tile ) const

inlineinherited

const ValueT& getMax ( ) const

inlineinherited

const ValueT& getMin ( ) const

inlineinherited

const uint32_t& getTableSize ( ) const

inline

ValueType getValue ( const CoordType &  ijk ) const

inline

Return the value of the given voxel.

ValueType getValue ( int  i, int  j, int  k  ) const

inline

bool isActive ( const CoordType &  ijk ) const

inline

bool isEmpty ( ) const

inline

Return true if this RootNode is empty, i.e. contains no values or nodes.

static CoordT KeyToCoord ( const KeyT &  key )

inlinestaticinherited

const ValueType& maximum ( ) const

inline

Return a const reference to the maximum active value encoded in this root node and any of its child nodes.

static uint64_t memUsage ( uint32_t  tableSize )

inlinestatic

Return the expected memory footprint in bytes with the specified number of tiles.

uint64_t memUsage ( ) const

inline

Return the actual memory footprint of this root node.

const ValueType& minimum ( ) const

inline

Return a const reference to the minimum active value encoded in this root node and any of its child nodes.

RootNode& operator= ( const RootNode< ChildT > &  )

delete

static constexpr uint32_t padding ( )

inlinestaticinherited

Return padding of this class in bytes, due to aliasing and 32B alignment.

Note

The extra bytes are not necessarily at the end, but can come from aliasing of individual data members.

const ChildNodeType* probeChild ( const CoordType &  ijk ) const

inline

ChildNodeType* probeChild ( const CoordType &  ijk )

inline

const LeafNodeType* probeLeaf ( const CoordType &  ijk ) const

inline

Tile* probeTile ( const CoordT &  ijk )

inlineinherited

const Tile* probeTile ( const CoordT &  ijk ) const

inlineinherited

bool probeValue ( const CoordType &  ijk, ValueType &  v  ) const

inline

return the state and updates the value of the specified voxel

void setAvg ( const StatsT &  v )

inlineinherited

void setDev ( const StatsT &  v )

inlineinherited

void setMax ( const ValueT &  v )

inlineinherited

void setMin ( const ValueT &  v )

inlineinherited

const FloatType& stdDeviation ( ) const

inline

Return a const reference to the standard deviation of all the active values encoded in this root node and any of its child nodes.

const Tile* tile ( uint32_t  n ) const

inlineinherited

Returns a non-const reference to the tile at the specified linear offset.

Warning

The linear offset is assumed to be in the valid range

Tile* tile ( uint32_t  n )

inlineinherited

const uint32_t& tileCount ( ) const

inline

Return the number of tiles encoded in this root node.

FloatType variance ( ) const

inline

Return the variance of all the active values encoded in this root node and any of its child nodes.

Friends And Related Function Documentation

friend class ReadAccessor

friend

friend class Tree

friend

Member Data Documentation

constexpr bool FIXED_SIZE = DataType::FIXED_SIZE

static

constexpr uint32_t LEVEL = 1 + ChildT::LEVEL

static

StatsT mAverage

inherited

ValueT mBackground

inherited

BBox<CoordT> mBBox

inherited

ValueT mMaximum

inherited

ValueT mMinimum

inherited

StatsT mStdDevi

inherited

uint32_t mTableSize

inherited

decltype(OpT::set(std::declval<Tile&>(), std::declval<ArgsT>()...)) set(const CoordType &ijk, ArgsT &&...args)

inline