OpenVDB 10.0.1
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
LeafData< Fp4, CoordT, MaskT, LOG2DIM > Struct Template Reference

Stuct with all the member data of the LeafNode (useful during serialization of an openvdb LeafNode) More...

#include <nanovdb/NanoVDB.h>

Inheritance diagram for LeafData< Fp4, CoordT, MaskT, LOG2DIM >:
LeafFnBase< CoordT, MaskT, LOG2DIM >

Public Types

using BaseT = LeafFnBase< CoordT, MaskT, LOG2DIM >
 
using BuildType = Fp4
 
using ArrayType = uint8_t
 
using ValueType = float
 
using FloatType = float
 

Public Member Functions

float getValue (uint32_t i) const
 
 LeafData ()=delete
 This class cannot be constructed or deleted. More...
 
 LeafData (const LeafData &)=delete
 
LeafDataoperator= (const LeafData &)=delete
 
 ~LeafData ()=delete
 
void init (float min, float max, uint8_t bitWidth)
 
float getMin () const
 return the quantized minimum of the active values in this node More...
 
float getMax () const
 return the quantized maximum of the active values in this node More...
 
float getAvg () const
 return the quantized average of the active values in this node More...
 
float getDev () const
 return the quantized standard deviation of the active values in this node More...
 
void setMin (float min)
 
void setMax (float max)
 
void setAvg (float avg)
 
void setDev (float dev)
 
template<typename T >
void setOrigin (const T &ijk)
 

Static Public Member Functions

static constexpr uint64_t memUsage ()
 
static constexpr uint32_t padding ()
 
static constexpr uint8_t bitWidth ()
 

Public Attributes

uint8_t mCode [1u<<(3 *LOG2DIM - 1)]
 
CoordT mBBoxMin
 
uint8_t mBBoxDif [3]
 
uint8_t mFlags
 
MaskT< LOG2DIM > mValueMask
 
float mMinimum
 
float mQuantum
 
uint16_t mMin
 
uint16_t mMax
 
uint16_t mAvg
 
uint16_t mDev
 

Static Public Attributes

static constexpr bool FIXED_SIZE = true
 

Detailed Description

template<typename CoordT, template< uint32_t > class MaskT, uint32_t LOG2DIM>
struct nanovdb::LeafData< Fp4, CoordT, MaskT, LOG2DIM >

Stuct with all the member data of the LeafNode (useful during serialization of an openvdb LeafNode)

Note
No client code should (or can) interface with this struct so it can safely be ignored!

Member Typedef Documentation

◆ ArrayType

using ArrayType = uint8_t

◆ BaseT

using BaseT = LeafFnBase<CoordT, MaskT, LOG2DIM>

◆ BuildType

using BuildType = Fp4

◆ FloatType

using FloatType = float
inherited

◆ ValueType

using ValueType = float
inherited

Constructor & Destructor Documentation

◆ LeafData() [1/2]

LeafData ( )
delete

This class cannot be constructed or deleted.

◆ LeafData() [2/2]

LeafData ( const LeafData< Fp4, CoordT, MaskT, LOG2DIM > &  )
delete

◆ ~LeafData()

~LeafData ( )
delete

Member Function Documentation

◆ bitWidth()

static constexpr uint8_t bitWidth ( )
inlinestaticconstexpr

◆ getAvg()

float getAvg ( ) const
inlineinherited

return the quantized average of the active values in this node

◆ getDev()

float getDev ( ) const
inlineinherited

return the quantized standard deviation of the active values in this node

Note
0 <= StdDev <= max-min or 0 <= StdDev/(max-min) <= 1

◆ getMax()

float getMax ( ) const
inlineinherited

return the quantized maximum of the active values in this node

◆ getMin()

float getMin ( ) const
inlineinherited

return the quantized minimum of the active values in this node

◆ getValue()

float getValue ( uint32_t  i) const
inline

◆ init()

void init ( float  min,
float  max,
uint8_t  bitWidth 
)
inlineinherited

◆ memUsage()

static constexpr uint64_t memUsage ( )
inlinestaticconstexpr

◆ operator=()

LeafData & operator= ( const LeafData< Fp4, CoordT, MaskT, LOG2DIM > &  )
delete

◆ padding()

static constexpr uint32_t padding ( )
inlinestaticconstexpr

◆ setAvg()

void setAvg ( float  avg)
inlineinherited
Note
min <= avg <= max or 0 <= (avg-min)/(min-max) <= 1

◆ setDev()

void setDev ( float  dev)
inlineinherited
Note
0 <= StdDev <= max-min or 0 <= StdDev/(max-min) <= 1

◆ setMax()

void setMax ( float  max)
inlineinherited
Note
min <= X <= max or 0 <= (X-min)/(min-max) <= 1

◆ setMin()

void setMin ( float  min)
inlineinherited
Note
min <= X <= max or 0 <= (X-min)/(min-max) <= 1

◆ setOrigin()

void setOrigin ( const T &  ijk)
inlineinherited

Member Data Documentation

◆ FIXED_SIZE

constexpr bool FIXED_SIZE = true
staticconstexpr

◆ mAvg

uint16_t mAvg
inherited

◆ mBBoxDif

uint8_t mBBoxDif[3]
inherited

◆ mBBoxMin

CoordT mBBoxMin
inherited

◆ mCode

uint8_t mCode[1u<<(3 *LOG2DIM - 1)]

◆ mDev

uint16_t mDev
inherited

◆ mFlags

uint8_t mFlags
inherited

◆ mMax

uint16_t mMax
inherited

◆ mMin

uint16_t mMin
inherited

◆ mMinimum

float mMinimum
inherited

◆ mQuantum

float mQuantum
inherited

◆ mValueMask

MaskT<LOG2DIM> mValueMask
inherited