Class ObjectAnalyticsSettings

Namespace

VisioForge.Core.Types.X.AI

Assembly

VisioForge.Core.dll

Aggregate settings for the object analytics block, combining detector, tracker, filter, overlay, line-zone, and polygon-zone configuration.

public sealed class ObjectAnalyticsSettings

Inheritance

object

ObjectAnalyticsSettings

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object?, object?)

object.ToString()

Remarks

The detector's VisioForge.Core.Types.X.AI.YoloDetectorSettings.ConfidenceThreshold is overridden at runtime by VisioForge.Core.Types.X.AI.ByteTrackerSettings.LowConfidenceThreshold (default 0.1f). ByteTrack requires low-confidence detections for its second association pass — high-confidence-only detection would miss recovering temporarily occluded tracks. Set VisioForge.Core.Types.X.AI.ObjectAnalyticsSettings.Tracker's LowConfidenceThreshold to a higher value if you want fewer low-confidence candidates fed to the tracker.

Constructors

ObjectAnalyticsSettings(YoloDetectorSettings)

Initializes a new instance of the VisioForge.Core.Types.X.AI.ObjectAnalyticsSettings class.

public ObjectAnalyticsSettings(YoloDetectorSettings detector)

Parameters

detector YoloDetectorSettings

The YOLO detector settings. Must not be null.

Exceptions

ArgumentNullException

detector is null.

ObjectAnalyticsSettings(OpenVocabularyDetectorSettings)

Initializes a new instance of the VisioForge.Core.Types.X.AI.ObjectAnalyticsSettings class that runs the analytics on top of an open-vocabulary detector (OWLv2 / Grounding DINO).

public ObjectAnalyticsSettings(OpenVocabularyDetectorSettings detector)

Parameters

detector OpenVocabularyDetectorSettings

The open-vocabulary detector settings. Must not be null.

Exceptions

ArgumentNullException

detector is null.

Properties

Detector

Gets the YOLO detector settings, or null when the analytics run on an open-vocabulary detector (see VisioForge.Core.Types.X.AI.ObjectAnalyticsSettings.OpenVocabularyDetector). Exactly one of VisioForge.Core.Types.X.AI.ObjectAnalyticsSettings.Detector and VisioForge.Core.Types.X.AI.ObjectAnalyticsSettings.OpenVocabularyDetector is non-null. This reference is the customer's configuration contract and must not be mutated by the analytics runtime.

public YoloDetectorSettings Detector { get; }

Property Value

YoloDetectorSettings

Filter

Gets or sets the detection filter settings. Defaults to a new VisioForge.Core.Types.X.AI.DetectionFilterSettings instance.

public DetectionFilterSettings Filter { get; set; }

Property Value

DetectionFilterSettings

Lines

Gets the configured line (tripwire) zones.

public List<LineZoneSettings> Lines { get; }

Property Value

List<LineZoneSettings>

OpenVocabularyDetector

Gets the open-vocabulary detector settings, or null when the analytics run on a YOLO detector (see VisioForge.Core.Types.X.AI.ObjectAnalyticsSettings.Detector). Exactly one of VisioForge.Core.Types.X.AI.ObjectAnalyticsSettings.Detector and VisioForge.Core.Types.X.AI.ObjectAnalyticsSettings.OpenVocabularyDetector is non-null.

public OpenVocabularyDetectorSettings OpenVocabularyDetector { get; }

Property Value

OpenVocabularyDetectorSettings

Overlay

Gets or sets the overlay rendering settings. Defaults to a new VisioForge.Core.Types.X.AI.ObjectAnalyticsOverlaySettings instance.

public ObjectAnalyticsOverlaySettings Overlay { get; set; }

Property Value

ObjectAnalyticsOverlaySettings

Tracker

Gets or sets the ByteTrack multi-object tracker settings. Defaults to a new VisioForge.Core.Types.X.AI.ByteTrackerSettings instance.

public ByteTrackerSettings Tracker { get; set; }

Property Value

ByteTrackerSettings

Zones

Gets the configured polygon zones.

public List<PolygonZoneSettings> Zones { get; }

Property Value

List<PolygonZoneSettings>