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

Represents a face that was detected. More...

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

Public Member Functions

override string ToString ()
 Returns a debug description. More...
 
- Public Member Functions inherited from RealNetworks.ArgusKit.DetectedObject
void Dispose ()
 
void Dispose (bool disposing)
 

Properties

Double Occlusion = 0 [get, set]
 The occlusion score of the image that was used for detection. More...
 
bool IsConfirmed = false [get, set]
 Indicates whether or not the detection has been confirmed by the server. More...
 
Double ValidatorConfidence = 0 [get, set]
 How confident the validator is that this is a real human face. 0 means that this is not a real world face; 1 means that the validator is 100% sure that this is a real world face. More...
 
IFaceLandmarks Landmarks = null [get, set]
 The face landmarks. E.g. eyes and mouth location. Nil if none of the landmarks can be computed. More...
 
double? Liveness = null [get, set]
 Detector confirmed liveness of the face. More...
 
- Properties inherited from RealNetworks.ArgusKit.DetectedObject
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...
 

Additional Inherited Members

- Public Attributes inherited from RealNetworks.ArgusKit.DetectedObject
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...
 

Detailed Description

Represents a face that was detected.

Member Function Documentation

◆ ToString()

override string RealNetworks.ArgusKit.DetectedFace.ToString ( )

Returns a debug description.

Returns
the description

Property Documentation

◆ IsConfirmed

bool RealNetworks.ArgusKit.DetectedFace.IsConfirmed = false
getset

Indicates whether or not the detection has been confirmed by the server.

◆ Landmarks

IFaceLandmarks RealNetworks.ArgusKit.DetectedFace.Landmarks = null
getset

The face landmarks. E.g. eyes and mouth location. Nil if none of the landmarks can be computed.

◆ Liveness

double? RealNetworks.ArgusKit.DetectedFace.Liveness = null
getset

Detector confirmed liveness of the face.

◆ Occlusion

Double RealNetworks.ArgusKit.DetectedFace.Occlusion = 0
getset

The occlusion score of the image that was used for detection.

◆ ValidatorConfidence

Double RealNetworks.ArgusKit.DetectedFace.ValidatorConfidence = 0
getset

How confident the validator is that this is a real human face. 0 means that this is not a real world face; 1 means that the validator is 100% sure that this is a real world face.