Skip to main content

struct XRObjectCategorization

(Niantic.Lightship.AR.XRSubsystems.XRObjectCategorization)

Overview​

A structure representing an object detection categorization. The object detection algorithm surfaces at least one categorization per detected object, but usually there are multiple categorizations.

struct XRObjectCategorization {
        // fields
    
         readonly string CategoryName;
         readonly int CategoryIndex;
         readonly float Confidence;

        // methods
    
        XRObjectCategorization(string name, int index, float confidence);
    };

Detailed Documentation​

A structure representing an object detection categorization. The object detection algorithm surfaces at least one categorization per detected object, but usually there are multiple categorizations.

This is an experimental API. Experimental features are subject to breaking changes, not officially supported, and may be deprecated without notice.

Fields​

CategoryName​

readonly string CategoryName

The category's name.

CategoryIndex​

readonly int CategoryIndex

The category's index in the list of category names obtained from the XRObjectDetectionSubsystem.TryGetCategoryNames method.

Confidence​

readonly float Confidence

The probability that the detected object this categorization belong to is actually of the class described by CategoryName.