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

Performs multithreaded diagnostics of a grid. More...

#include <Diagnostics.h>

Public Types

using MaskType = typename GridT::template ValueConverter< bool >::Type
 

Public Member Functions

 Diagnose (const GridT &grid)
 
template<typename CheckT >
std::string check (const CheckT &check, bool updateMask=false, bool checkVoxels=true, bool checkTiles=true, bool checkBackground=true)
 
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 GridT & grid () const
 Return a const reference to the grid. More...
 
void clear ()
 Clear the mask and error counter. 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...
 

Detailed Description

template<typename GridT>
class openvdb::OPENVDB_VERSION_NAME::tools::Diagnose< GridT >

Performs multithreaded diagnostics of a grid.

Note
More documentation will be added soon!

Definition at line 643 of file Diagnostics.h.

Member Typedef Documentation

template<typename GridT>
using openvdb::OPENVDB_VERSION_NAME::tools::Diagnose< GridT >::MaskType = typename GridT::template ValueConverter<bool>::Type

Definition at line 646 of file Diagnostics.h.

Constructor & Destructor Documentation

template<typename GridT>
openvdb::OPENVDB_VERSION_NAME::tools::Diagnose< GridT >::Diagnose ( const GridT &  grid)
inline

Definition at line 648 of file Diagnostics.h.

Member Function Documentation

template<typename GridT>
template<typename CheckT >
std::string openvdb::OPENVDB_VERSION_NAME::tools::Diagnose< GridT >::check ( const CheckT &  check,
bool  updateMask = false,
bool  checkVoxels = true,
bool  checkTiles = true,
bool  checkBackground = true 
)
inline

Definition at line 654 of file Diagnostics.h.

template<typename GridT>
void openvdb::OPENVDB_VERSION_NAME::tools::Diagnose< GridT >::clear ( void  )
inline

Clear the mask and error counter.

Definition at line 691 of file Diagnostics.h.

template<typename GridT>
Index64 openvdb::OPENVDB_VERSION_NAME::tools::Diagnose< GridT >::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 685 of file Diagnostics.h.

template<typename GridT>
const GridT& openvdb::OPENVDB_VERSION_NAME::tools::Diagnose< GridT >::grid ( ) const
inline

Return a const reference to the grid.

Definition at line 688 of file Diagnostics.h.

template<typename GridT>
MaskType::ConstPtr openvdb::OPENVDB_VERSION_NAME::tools::Diagnose< GridT >::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 674 of file Diagnostics.h.

template<typename GridT>
MaskType::Ptr openvdb::OPENVDB_VERSION_NAME::tools::Diagnose< GridT >::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 675 of file Diagnostics.h.

template<typename GridT>
Index64 openvdb::OPENVDB_VERSION_NAME::tools::Diagnose< GridT >::valueCount ( ) const
inline

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

Definition at line 680 of file Diagnostics.h.


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