NVIDIA IndeX API nvidia_logo_transpbg.gif Up
nv::index::ISparse_volume_compute_task Class Referenceabstract

Compute tasks operating on sparse-volume subsets. More...

#include <isparse_volume_compute_task.h>

Inherits mi::base::Interface_declare< 0xc9f68e21, ... >.

Public Member Functions

virtual bool compute (const mi::math::Bbox_struct< mi::Sint32, 3 > &subset_data_bbox, ISparse_volume_subset *subset_data, mi::neuraylib::IDice_transaction *dice_transaction) const =0
 Callback that performs a user-defined operations on distributed sparse-volume subset data. More...
 

Detailed Description

Compute tasks operating on sparse-volume subsets.

An application can derive from the interface class ISparse_volume_compute_task to implement tailor-made data processing and analysis techniques. Then passing an instance of the derived class to the
IData_subset_compute_task_processing::execute_compute_task() method executes the callback compute(..) for each data subset of the sparse volume that is stored locally, e.g., on the cluster machine.

Member Function Documentation

 compute()

virtual bool nv::index::ISparse_volume_compute_task::compute ( const mi::math::Bbox_struct< mi::Sint32, 3 > &  subset_data_bbox,
ISparse_volume_subset subset_data,
mi::neuraylib::IDice_transaction *  dice_transaction 
) const
pure virtual

Callback that performs a user-defined operations on distributed sparse-volume subset data.

The user-defined implementation of the compute(..) callback is invoked for each subset of a distributed dataset. The implementation may either inspect or analyze the subset data or perform operations and modifications to the data. The NVIDIA IndeX system ensure data integrity when applying modifications.

Parameters
[in]subset_data_bboxThe 3D bounding box that contains the voxel values of the sparse-volume subset. The bounding box is given in the volume's local space.
[in,out]subset_dataAn instance of ISparse_volume_subset grants access to the volume data defined in the given 3D bounding box. The ISparse_volume_subset interface provides dedicated functionalities to query, access and edit specific to the sparse volume data and its internal representations in either host or CUDA device memory.
[in]dice_transactionThe current DiCE transaction.
Returns
Return true to signal the NVIDIA IndeX subsystem that modifications to the sparse-volume subset data have been applied and return false otherwise. If modifications have been applied the NVIDIA IndeX subsystem automatically updates all internal data structures and representation of the sparse volume on both the host and the CUDA device.

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