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

Height field specific query modes to determine the data localities of height field patches. More...

#include <idistributed_data_locality.h>

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

Public Types

enum  Height_field_locality_query_mode {
  HEIGHT_FIELD_LOCALITY_QUERY_SUBSETS_UNIQUE_CLUSTER = 0x01u ,
  HEIGHT_FIELD_LOCALITY_QUERY_SUBSETS_UNIQUE_PER_HOST = 0x02u
}
 Height field data locality query modes. More...
 

Public Member Functions

virtual Height_field_locality_query_mode get_query_mode () const =0
 The height field query mode defines if globally or locally unique data subsets shall be considered for the data locality. More...
 
virtual const mi::math::Bbox_struct< mi::Float32, 2 > & get_spatial_coverage () const =0
 Spatial query methods let determine data localities based on a 2D spatial coverage. More...
 

Detailed Description

Height field specific query modes to determine the data localities of height field patches.

Deriving a data locality from the data distribution for a height field dataset based on the 2D bounding box. A data locality determined using this query method will include all data subsets that are contained inside or just intersect the region of interest.

In contrast to a sparse volume dataset (see ISparse_volume_scene_element) a height field is defined in 2.5D and its 2D support may intersect multiple subregion in 3D space along the height fields height-axis. Analysis techniques that merely inspect height field data, e.g., to calculate an average height value only need to determine a single patch. For processing techniques that change the elevation values, all patches that along the z axis need to be considered and updated after the operation. To consider both, a height field query exposes to modes: globally unique or locally unique height field data subsets.

Member Enumeration Documentation

 Height_field_locality_query_mode

Height field data locality query modes.

This mode allows to query the height-field data locality of the data subsets which are either globally unique or unique per host. Globally unique mode will reference a single subset only once, while in per-host unique mode the locality potentially references a subset multiple times, but only once per host.

Enumerator
HEIGHT_FIELD_LOCALITY_QUERY_SUBSETS_UNIQUE_CLUSTER 

! Data locality considers globally unique data subsets only.

HEIGHT_FIELD_LOCALITY_QUERY_SUBSETS_UNIQUE_PER_HOST 

! Data locality considers locally unique data subsets only.

Member Function Documentation

 get_query_mode()

virtual Height_field_locality_query_mode nv::index::IDistributed_height_field_locality_query_mode::get_query_mode ( ) const
pure virtual

The height field query mode defines if globally or locally unique data subsets shall be considered for the data locality.

Returns
Returns if locally or globally unique data subsets shall be considered.

 get_spatial_coverage()

virtual const mi::math::Bbox_struct< mi::Float32, 2 > & nv::index::IDistributed_height_field_locality_query_mode::get_spatial_coverage ( ) const
pure virtual

Spatial query methods let determine data localities based on a 2D spatial coverage.

The bounding box represented by mi::math::Bbox_struct<mi::Float32, 2> specifies a 2D area of interest. Only data subsets that are covered at least partially, will be considered in a data locality.

Returns
Returns the a bounding box that represents a area of interest for determining the data locality.

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