Skip to main content
Version: 20 Mar 2024

CustomProfile

Public Methods

CustomProfile Create

public static CustomProfile Create(
FPSHint fpsHint =FPSHint.Medium,
ResolutionHint resolutionHint =ResolutionHint.Low,
CameraHint cameraHint =CameraHint.RGB,
FullAnalysisIntervalHint fullAnalysisIntervalHint =FullAnalysisIntervalHint.Medium,
CornerRefineMethod cornerRefineMethod =CornerRefineMethod.None,
bool useEdgeRefinement =false
)

Parameters

TypeNameDescription
FPSHintfpsHintUsed to hint to the back-end the max frames per second that should be analyzed. This is set in the MLMarkerTrackerCustomProfile structure and this setting applies to all enabled trackers.
ResolutionHintresolutionHintThe ResolutionHint enum values are used to hint to the back-end the resolution that should be used. This is set in the MLMarkerTracker.CustomProfile structure and this setting currently only applies to the QR, UPC and EAN detectors.
CameraHintcameraHintThe CameraHint enum values are used to hint to the camera that should be used. This is set in the MLMarkerTracker.CustomProfile structure and this setting currently only applies to the aruco detectors.
FullAnalysisIntervalHintfullAnalysisIntervalHintIn order to improve performance, the detectors don't always run on the full frame. Full frame analysis is however necessary to detect new markers that weren't detected before. Use this option to control how often the detector may detect new markers and its impact on tracking performance.
CornerRefineMethodcornerRefineMethodThe Aruco/April tag detector comes with several corner refinement methods. Choosing the right corner refinement method has an impact on the accuracy and speed trade-off that comes with each detection pipeline. Corner refinement only applies to Aruco and April tags, not QR codes.
booluseEdgeRefinement

override string ToString

public override string ToString()

Public Attributes

CameraHint

A hint to the back-end for what cameras should be used.


public CameraHint CameraHint;

TypeDescription
CameraHintThe CameraHint enum values are used to hint to the camera that should be used. This is set in the MLMarkerTracker.CustomProfile structure and this setting currently only applies to the aruco detectors.

CornerRefineMethod

This option provides control over corner refinement methods and a way to balance detection rate, speed and pose accuracy. Always available and applicable for Aruco and April tags.


public CornerRefineMethod CornerRefineMethod;

TypeDescription
CornerRefineMethodThe Aruco/April tag detector comes with several corner refinement methods. Choosing the right corner refinement method has an impact on the accuracy and speed trade-off that comes with each detection pipeline. Corner refinement only applies to Aruco and April tags, not QR codes.

FPSHint

A hint to the back-end the max frames per second hat should be analyzed.


public FPSHint FPSHint;

TypeDescription
FPSHintUsed to hint to the back-end the max frames per second that should be analyzed. This is set in the MLMarkerTrackerCustomProfile structure and this setting applies to all enabled trackers.

FullAnalysisIntervalHint

In order to improve performance, the detectors don't always run on the full frame.Full frame analysis is however necessary to detect new markers that weren't detected before. Use this option to control how often the detector may detect new markers and its impact on tracking performance.


public FullAnalysisIntervalHint FullAnalysisIntervalHint;

TypeDescription
FullAnalysisIntervalHintIn order to improve performance, the detectors don't always run on the full frame. Full frame analysis is however necessary to detect new markers that weren't detected before. Use this option to control how often the detector may detect new markers and its impact on tracking performance.

ResolutionHint

A hint to the back-end the resolution that should be used.


public ResolutionHint ResolutionHint;

TypeDescription
ResolutionHintThe ResolutionHint enum values are used to hint to the back-end the resolution that should be used. This is set in the MLMarkerTracker.CustomProfile structure and this setting currently only applies to the QR, UPC and EAN detectors.

UseEdgeRefinement

Run refinement step that uses marker edges to generate even more accurate corners, but slow down tracking rate overall by consuming more compute. Aruco/April tags only.


public bool UseEdgeRefinement;