Beta Feature. Requires an Enterprise license to use. Please note that this API can change at any time while it is in beta. More...

Public Member Functions
	ValidationInfo (ValidationStatus validationStatus, string label, float confidence, Vector3 recommendedViewerDirection, float recommendedViewerAngle, float recommendedViewerDistance, long validationTimestamp)

Properties
float	Confidence `[get]`
	The confidence of the prediction between 0 and 1. Higher is better.

string	Label `[get]`
	The label name of the observed Validation Area state.

float	RecommendedViewerAngle `[get]`
	Angular guidance around recommendedViewerDirection in degrees. This angle around recommendedViewerDirection delimits the set of possible viewpoints. The angle will be 0 if there is no recommendedViewerDirection.

Vector3	RecommendedViewerDirection `[get]`
	Recommended direction in which the viewer should position its viewpoint to observe the Validation Area. The direction is in the coordinate system of the Validation Area, from the Validation Area origin towards the viewer. The direction will always be a unit vector or (0, 0, 0) if no direction is available.

float	RecommendedViewerDistance `[get]`
	Distance guidance for recommendedViewerDirection in meters. This is the recommended viewer distance when observing the Validation Area from recommendedViewerDirection. The distance will be 0 if there is no recommendedViewerDirection.

ValidationStatus	ValidationStatus `[get]`
	Validation status.

long	ValidationTimestamp `[get]`
	The timestamp of the camera frame the prediction was performed on (in nanoseconds)

Detailed Description

Beta Feature. Requires an Enterprise license to use. Please note that this API can change at any time while it is in beta.

Validation-related infos of a Validation Area observation

Constructor & Destructor Documentation

◆ ValidationInfo()

ValidationInfo	(	ValidationStatus	validationStatus,
		string	label,
		float	confidence,
		Vector3	recommendedViewerDirection,
		float	recommendedViewerAngle,
		float	recommendedViewerDistance,
		long	validationTimestamp )

inline

Property Documentation

◆ Confidence

float Confidence

get

The confidence of the prediction between 0 and 1. Higher is better.

◆ Label

string Label

get

The label name of the observed Validation Area state.

The lifetime of the returned string is bound to the lifetime of the observation.

◆ RecommendedViewerAngle

float RecommendedViewerAngle

get

Angular guidance around recommendedViewerDirection in degrees. This angle around recommendedViewerDirection delimits the set of possible viewpoints. The angle will be 0 if there is no recommendedViewerDirection.

The recommendedViewerAngle is never available for ValidationStatus.NO_VALID_POSE.

◆ RecommendedViewerDirection

Vector3 RecommendedViewerDirection

get

Recommended direction in which the viewer should position its viewpoint to observe the Validation Area. The direction is in the coordinate system of the Validation Area, from the Validation Area origin towards the viewer. The direction will always be a unit vector or (0, 0, 0) if no direction is available.

No viewing direction will be available for ValidationStatus.NO_VALID_POSE.

◆ RecommendedViewerDistance

float RecommendedViewerDistance

get

Distance guidance for recommendedViewerDirection in meters. This is the recommended viewer distance when observing the Validation Area from recommendedViewerDirection. The distance will be 0 if there is no recommendedViewerDirection.

The recommendedViewerDistance is never available for ValidationStatus.NO_VALID_POSE.

◆ ValidationStatus

ValidationStatus ValidationStatus

get

Validation status.

The values of Label and Confidence are valid only when validation status is ValidationStatus.NORMAL.

◆ ValidationTimestamp

long ValidationTimestamp

get

The timestamp of the camera frame the prediction was performed on (in nanoseconds)

Public Member Functions

Properties