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 619 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 622 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 624 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 630 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 667 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 661 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 664 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 650 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 651 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 656 of file Diagnostics.h.

---

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

• openvdb/tools/Diagnostics.h