HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
openvdb::OPENVDB_VERSION_NAME::tools::CheckFogVolume< GridType > Class Template Reference

Class that performs various types of checks on fog volumes. More...

#include <Diagnostics.h>

Public Types

using ValueType = typename GridType::ValueType
 
using MaskType = typename GridType::template ValueConverter< bool >::Type
 

Public Member Functions

 CheckFogVolume (const GridType &grid)
 
Index64 valueCount () const
 Return the number of values (i.e. background, tiles or voxels) that have failed one or more checks. More...
 
Index64 failureCount () const
 Return total number of failed checks. More...
 
const GridType & grid () const
 Return a const reference to the grid. More...
 
void clear ()
 Clear the mask and error counter. More...
 
std::string checkClassType () const
 Return a nonempty message if the grid's class is a level set. More...
 
std::string checkBackground () const
 Return a nonempty message if the background value is not zero. More...
 
std::string checkFinite (bool updateMask=false)
 Return a nonempty message if any of the values are not finite. i.e. NaN or inf. More...
 
std::string checkInactiveValues (bool updateMask=false)
 Return a nonempty message if any of the inactive values are not zero. More...
 
std::string checkRange (bool updateMask=false)
 Return a nonempty message if the active voxel values are out-of-range, i.e. not in the range [0,1]. More...
 
std::string check (size_t n=6, bool updateMask=false)
 Return a nonempty message if an error or issue is detected. Only runs tests with a number lower than or equal to n, where: More...
 
MaskType::ConstPtr mask () const
 Return a boolean mask of all the values (i.e. tiles and/or voxels) that have failed one or more checks. More...
 
MaskType::Ptr mask ()
 Return a boolean mask of all the values (i.e. tiles and/or voxels) that have failed one or more checks. More...
 

Static Public Member Functions

static std::string checkValueType ()
 Return a nonempty message if the grid's value type is a floating point. More...
 

Detailed Description

template<class GridType>
class openvdb::OPENVDB_VERSION_NAME::tools::CheckFogVolume< GridType >

Class that performs various types of checks on fog volumes.

Note
The most common usage is to simply call CheckFogVolume::check()

Definition at line 986 of file Diagnostics.h.

Member Typedef Documentation

template<class GridType>
using openvdb::OPENVDB_VERSION_NAME::tools::CheckFogVolume< GridType >::MaskType = typename GridType::template ValueConverter<bool>::Type

Definition at line 990 of file Diagnostics.h.

template<class GridType>
using openvdb::OPENVDB_VERSION_NAME::tools::CheckFogVolume< GridType >::ValueType = typename GridType::ValueType

Definition at line 989 of file Diagnostics.h.

Constructor & Destructor Documentation

template<class GridType>
openvdb::OPENVDB_VERSION_NAME::tools::CheckFogVolume< GridType >::CheckFogVolume ( const GridType &  grid)
inline

Definition at line 992 of file Diagnostics.h.

Member Function Documentation

template<class GridType>
std::string openvdb::OPENVDB_VERSION_NAME::tools::CheckFogVolume< GridType >::check ( size_t  n = 6,
bool  updateMask = false 
)
inline

Return a nonempty message if an error or issue is detected. Only runs tests with a number lower than or equal to n, where:

Fast checks 1: value type is floating point 2: has FOG volume class type 3: background value is zero

Slower checks 4: all the values are finite, i.e not NaN or infinite 5: inactive values are zero 6: active values are in the range [0,1]

Definition at line 1088 of file Diagnostics.h.

template<class GridType>
std::string openvdb::OPENVDB_VERSION_NAME::tools::CheckFogVolume< GridType >::checkBackground ( ) const
inline

Return a nonempty message if the background value is not zero.

Note
Small run-time overhead

Definition at line 1038 of file Diagnostics.h.

template<class GridType>
std::string openvdb::OPENVDB_VERSION_NAME::tools::CheckFogVolume< GridType >::checkClassType ( ) const
inline

Return a nonempty message if the grid's class is a level set.

Note
Small run-time overhead

Definition at line 1029 of file Diagnostics.h.

template<class GridType>
std::string openvdb::OPENVDB_VERSION_NAME::tools::CheckFogVolume< GridType >::checkFinite ( bool  updateMask = false)
inline

Return a nonempty message if any of the values are not finite. i.e. NaN or inf.

Note
Medium run-time overhead

Definition at line 1051 of file Diagnostics.h.

template<class GridType>
std::string openvdb::OPENVDB_VERSION_NAME::tools::CheckFogVolume< GridType >::checkInactiveValues ( bool  updateMask = false)
inline

Return a nonempty message if any of the inactive values are not zero.

Note
Medium run-time overhead

Definition at line 1060 of file Diagnostics.h.

template<class GridType>
std::string openvdb::OPENVDB_VERSION_NAME::tools::CheckFogVolume< GridType >::checkRange ( bool  updateMask = false)
inline

Return a nonempty message if the active voxel values are out-of-range, i.e. not in the range [0,1].

Note
Medium run-time overhead

Definition at line 1070 of file Diagnostics.h.

template<class GridType>
static std::string openvdb::OPENVDB_VERSION_NAME::tools::CheckFogVolume< GridType >::checkValueType ( )
inlinestatic

Return a nonempty message if the grid's value type is a floating point.

Note
No run-time overhead

Definition at line 1020 of file Diagnostics.h.

template<class GridType>
void openvdb::OPENVDB_VERSION_NAME::tools::CheckFogVolume< GridType >::clear ( void  )
inline

Clear the mask and error counter.

Definition at line 1015 of file Diagnostics.h.

template<class GridType>
Index64 openvdb::OPENVDB_VERSION_NAME::tools::CheckFogVolume< GridType >::failureCount ( ) const
inline

Return total number of failed checks.

Note
If only one check was performed and the mask was updated failureCount equals valueCount.

Definition at line 1009 of file Diagnostics.h.

template<class GridType>
const GridType& openvdb::OPENVDB_VERSION_NAME::tools::CheckFogVolume< GridType >::grid ( ) const
inline

Return a const reference to the grid.

Definition at line 1012 of file Diagnostics.h.

template<class GridType>
MaskType::ConstPtr openvdb::OPENVDB_VERSION_NAME::tools::CheckFogVolume< GridType >::mask ( ) const
inline

Return a boolean mask of all the values (i.e. tiles and/or voxels) that have failed one or more checks.

Definition at line 998 of file Diagnostics.h.

template<class GridType>
MaskType::Ptr openvdb::OPENVDB_VERSION_NAME::tools::CheckFogVolume< GridType >::mask ( )
inline

Return a boolean mask of all the values (i.e. tiles and/or voxels) that have failed one or more checks.

Definition at line 999 of file Diagnostics.h.

template<class GridType>
Index64 openvdb::OPENVDB_VERSION_NAME::tools::CheckFogVolume< GridType >::valueCount ( ) const
inline

Return the number of values (i.e. background, tiles or voxels) that have failed one or more checks.

Definition at line 1004 of file Diagnostics.h.


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