OpenXRMlMarkerDetectorSettings

Experimental: Marked as experimental due to lack of community validation on Magic Leap devices.

Inherits: Resource

Inherited By: OpenXRMlMarkerDetectorAprilTagSettings, OpenXRMlMarkerDetectorArucoSettings, OpenXRMlMarkerDetectorCode128Settings, OpenXRMlMarkerDetectorEan13Settings, OpenXRMlMarkerDetectorQrSettings, OpenXRMlMarkerDetectorUpcASettings

Abstract base class for marker detector settings.

Description

Abstract base class for marker detector settings.

Properties

MarkerDetectorProfile

marker_detector_profile

0

OpenXRMlMarkerDetectorProfileSettings

marker_detector_profile_settings

Methods

MarkerType

get_marker_type ( ) const


Enumerations

enum MarkerType:

MarkerType MARKER_TYPE_ARUCO = 0

Aruco Marker detection and localization. The marker id of the Aruco marker is available via OpenXRMlMarkerTracker.get_marker_number.

MarkerType MARKER_TYPE_APRIL_TAG = 1

AprilTag detection and localization. The marker id of the AprilTags is available via OpenXRMlMarkerTracker.get_marker_number.

MarkerType MARKER_TYPE_QR = 2

QR code detection and localization. The contents of the QR code is available via OpenXRMlMarkerTracker.get_marker_string.

MarkerType MARKER_TYPE_EAN_13 = 3

EAN-13, detection only, not locatable. The contents of the barcode is available via OpenXRMlMarkerTracker.get_marker_string.

MarkerType MARKER_TYPE_UPC_A = 4

UPC-A, detection only, not locatable. The contents of the barcode is available via OpenXRMlMarkerTracker.get_marker_string.

MarkerType MARKER_TYPE_CODE_128 = 5

Code 128, detection only, not locatable. The contents of the barcode is available via OpenXRMlMarkerTracker.get_marker_string.


enum MarkerDetectorProfile:

MarkerDetectorProfile MARKER_DETECTOR_PROFILE_DEFAULT = 0

Tracker profile that covers standard use cases. If this does not suite the needs of the application try the other profiles listed below.

MarkerDetectorProfile MARKER_DETECTOR_PROFILE_SPEED = 1

Optimized for speed. Use this profile to reduce the compute load and increase detection/tracker speed. This can result in low accuracy poses.

MarkerDetectorProfile MARKER_DETECTOR_PROFILE_ACCURACY = 2

Optimized for accuracy. Use this profile to optimize for accurate marker poses. This can cause increased load on the compute.

MarkerDetectorProfile MARKER_DETECTOR_PROFILE_SMALL_TARGETS = 3

Optimized for small targets. Use this profile to optimize for markers that are small or for larger markers that need to be detected from afar.

MarkerDetectorProfile MARKER_DETECTOR_PROFILE_LARGE_FOV = 4

Optimized for FoV. Use this profile to be able to detect markers across a larger FoV. The marker tracker system will attempt to use multiple cameras to detect the markers.

MarkerDetectorProfile MARKER_DETECTOR_PROFILE_CUSTOM = 5

Custom Tracker Profile. See marker_detector_profile_settings for more details.


Property Descriptions

MarkerDetectorProfile marker_detector_profile = 0


OpenXRMlMarkerDetectorProfileSettings marker_detector_profile_settings

The custom profile to be used when marker_detector_profile is set to MARKER_DETECTOR_PROFILE_CUSTOM.


Method Descriptions

MarkerType get_marker_type ( ) const