Python API Reference

NeuralVDB extension (omni.vdb.neuralvdb) provides a set of APIs to encode and decode VDB volumes.

Module Summary:

Module	Description
`omni.vdb.neuralvdb`	This module contains bindings to C++ omni::vdb::neuralvdb::INeuralVDB interface.

omni.vdb.neuralvdb

Methods Summary:

Method	Description
`initialize`	Initializes NeuralVDB module interface.
`finalize`	Finalizes NeuralVDB module interface.
`decode_grids`	Decode input NeuralVDB data to a VDB grid data.
`decode_grids_to_buffer`	Decode input NeuralVDB data to a binary VDB grid buffer.
`encode_grids`	Encode a VDB grid data to NeuralVDB data.
`batch_encode_grids`	Batch-encode a series of VDB grid data to NeuralVDB data.
`encode_grids_from_buffer`	Encode a binary VDB grid buffer to NeuralVDB data.
`batch_encode_grids_from_buffer`	Batch-encode a series of binary VDB grid buffers to NeuralVDB data.
`auto_config_encode_params`	Auto-generate encode parameters from a given VDB grid data.
`encode_grids_with_auto_config`	Encode a VDB grid data to NeuralVDB data using auto-configuration.
`batch_encode_grids_with_auto_config`	Batch-encode a series of VDB grid data to NeuralVDB data using auto-configuration.
`encode_grids_from_buffer_with_auto_config`	Encode a binary VDB grid buffer to NeuralVDB data using auto-configuration.
`batch_encode_grids_from_buffer_with_auto_config`	Batch-encode a series of binary VDB grid buffers to NeuralVDB data using auto-configuration.

Classes Summary:

Class	Description
`ActivationParams`	Activation layer parameters
`CompressionParams`	Compression parameters
`DecodeParams`	Parameter set for decoding NeuralVDB volumes
`DeviceType`	Enums for device types
`DomainDecompParams`	Domain decomposition parameters
`EncodeParams`	Parameter set for encoding VDB volumes
`FeatureMappingParams`	Feature mapping parameters
`NeuralGridParams`	Neural grid general encoding parameters
`NeuralNetBackend`	Enums for neural network backends
`OptimParams`	Neural network optimization parameters
`TrainClassifierParams`	Parameters for training classification network
`TrainRegressorParams`	Parameters for training regression network