SAFR Windows SDK
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
RealNetworks.ArgusKit.DetectedObject Class Reference

Base class for Face / Badge / RecognizedObject. More...

Inheritance diagram for RealNetworks.ArgusKit.DetectedObject:
RealNetworks.ArgusKit.IDetectedObject RealNetworks.ArgusKit.DetectedBadge RealNetworks.ArgusKit.DetectedFace RealNetworks.ArgusKit.DetectedRecognizedObject

Public Member Functions

void Dispose ()
 
void Dispose (bool disposing)
 

Public Attributes

BitmapSource Thumbnail => ThumbnailConverter?.ToBitmapSource()
 The object thumbnail. More...
 
BitmapSource SizedThumbnail => SizedThumbnailConverter?.ToBitmapSource()
 Alternatively sized thumbnail (for events). More...
 
BitmapSource SceneThumbnail => SceneThumbnailConverter?.ToBitmapSource()
 The scene image. This is the image of the scene from which the object thumbnail was extracted. More...
 

Properties

DetectedObjectType ObjectType [get, protected set]
 
Int64 LocalId [get, protected set]
 
RectangleF NormalizedBounds = RectangleF.Empty [get, set]
 
Double ThumbnailBoundsExpansionFactor = 1 [get, set]
 
Double Confidence = 0 [get, set]
 
Double CenterPoseQuality = 0 [get, set]
 
Double ImageSharpnessQuality = 0 [get, set]
 
Double ImageContrastQuality = 0 [get, set]
 
Double Yaw = 0 [get, set]
 
Double Pitch = 0 [get, set]
 
Double Roll = 0 [get, set]
 
IDepthData DepthData = null [get, set]
 
String RecognizerHint = null [get, set]
 
Double ClipRatio = 0 [get, set]
 
RectangleF PixelBounds = RectangleF.Empty [get, set]
 
string RegionName = null [get, set]
 
- Properties inherited from RealNetworks.ArgusKit.IDetectedObject
DetectedObjectType ObjectType [get]
 The type of the object. More...
 
Int64 LocalId [get]
 The local ID of the object. Local IDs for detected objects are only unique with respect to the single frame in which the object was detected. More...
 
RectangleF NormalizedBounds [get]
 The bounding box of the object inside of the image in which it was detected. Note that the bounding box is in normalized coordinates [0, 1] x [0, 1]. More...
 
Double ThumbnailBoundsExpansionFactor [get]
 Returns the expansion factor by which the object bounds have been expanded to cut out the object thumbnail. Note that the face thumbnail is usually bigger than the area enclosed by the normalized bounds. This is the factor by which it was expanded. More...
 
Double Confidence [get]
 How confident the object detector is that this is actually an object. More...
 
Double CenterPoseQuality [get]
 How suitable is this object for object recognition? More...
 
Double ImageSharpnessQuality [get]
 What is the sharpness score of the image that was used for detection? More...
 
Double ImageContrastQuality [get]
 What is the contrast quality of the image from which this object was taken? More...
 
Double Yaw [get]
 The yaw of the object measured as the object is moves left-right. -1 for left, 0 for center and +1 for right. More...
 
Double Pitch [get]
 The pitch of the object measured as the object moves up/down. -1 for straight down, 0 for center and +1 for straight up. More...
 
Double Roll [get]
 The roll of the object is measured as the object is tilted left-right. -1 for left, 0 for center and +1 for the right. More...
 
BitmapSource Thumbnail [get]
 The object thumbnail. More...
 
BitmapSource SizedThumbnail [get]
 The object thumbnail. More...
 
BitmapSource SceneThumbnail [get]
 The scene image. This is the image of the scene from which the object thumbnail was extracted. More...
 
IDepthData DepthData [get]
 Returns the depth data for the face. Null if no depth data exists. More...
 
String RecognizerHint [get]
 Data that may be passed to the face recognizer to speed up recognition. More...
 
Double ClipRatio [get]
 Max ratio of clipping on either side: if the object is a potentially partial object which means that its bounding box extends beyond the video frame boundaries. More...
 
RectangleF PixelBounds [get]
 The object bounding box in pixels, expanded by thumbnail expansion factor (default 50%). More...
 
string RegionName [get, set]
 Name of a region (from RegionMap) containing the detected object. More...
 

Detailed Description

Base class for Face / Badge / RecognizedObject.

Member Function Documentation

◆ Dispose() [1/2]

void RealNetworks.ArgusKit.DetectedObject.Dispose ( )

◆ Dispose() [2/2]

void RealNetworks.ArgusKit.DetectedObject.Dispose ( bool  disposing)

Member Data Documentation

◆ SceneThumbnail

BitmapSource RealNetworks.ArgusKit.DetectedObject.SceneThumbnail => SceneThumbnailConverter?.ToBitmapSource()

The scene image. This is the image of the scene from which the object thumbnail was extracted.

◆ SizedThumbnail

BitmapSource RealNetworks.ArgusKit.DetectedObject.SizedThumbnail => SizedThumbnailConverter?.ToBitmapSource()

Alternatively sized thumbnail (for events).

◆ Thumbnail

BitmapSource RealNetworks.ArgusKit.DetectedObject.Thumbnail => ThumbnailConverter?.ToBitmapSource()

The object thumbnail.

Property Documentation

◆ CenterPoseQuality

Double RealNetworks.ArgusKit.DetectedObject.CenterPoseQuality = 0
getset

◆ ClipRatio

Double RealNetworks.ArgusKit.DetectedObject.ClipRatio = 0
getset

◆ Confidence

Double RealNetworks.ArgusKit.DetectedObject.Confidence = 0
getset

◆ DepthData

IDepthData RealNetworks.ArgusKit.DetectedObject.DepthData = null
getset

◆ ImageContrastQuality

Double RealNetworks.ArgusKit.DetectedObject.ImageContrastQuality = 0
getset

◆ ImageSharpnessQuality

Double RealNetworks.ArgusKit.DetectedObject.ImageSharpnessQuality = 0
getset

◆ LocalId

Int64 RealNetworks.ArgusKit.DetectedObject.LocalId
getprotected set

◆ NormalizedBounds

RectangleF RealNetworks.ArgusKit.DetectedObject.NormalizedBounds = RectangleF.Empty
getset

◆ ObjectType

DetectedObjectType RealNetworks.ArgusKit.DetectedObject.ObjectType
getprotected set

◆ Pitch

Double RealNetworks.ArgusKit.DetectedObject.Pitch = 0
getset

◆ PixelBounds

RectangleF RealNetworks.ArgusKit.DetectedObject.PixelBounds = RectangleF.Empty
getset

◆ RecognizerHint

String RealNetworks.ArgusKit.DetectedObject.RecognizerHint = null
getset

◆ RegionName

string RealNetworks.ArgusKit.DetectedObject.RegionName = null
getset

◆ Roll

Double RealNetworks.ArgusKit.DetectedObject.Roll = 0
getset

◆ ThumbnailBoundsExpansionFactor

Double RealNetworks.ArgusKit.DetectedObject.ThumbnailBoundsExpansionFactor = 1
getset

◆ Yaw

Double RealNetworks.ArgusKit.DetectedObject.Yaw = 0
getset