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

Represents a person. Contains information from analysis of face and identity information from SAFR services. More...

Public Member Functions

override string ToString ()
 
Uri GetUnmergedDisplayUrl ()
 
string GetDisplayName ()
 Returns the persons name, if present, otherwise returns the persons Id. More...
 
void UpdateSmileFromThreshold (double? smileConfidenceThreshold)
 Using the given smile threshold determine if we should override the smile flag and if so update it with the new value.
If a valid threshold was passed in and this person has a sentiment value then update the smile flag based on if the sentiment value is greater or equal to the smile threshold More...
 
void UpdateProfilePoseFromThreshold (double? profilePoseConfidenceThreshold)
 Using the given profile pose confidence threshold determine if we should override the profilePose flag and if so update it with the new value.
If a valid threshold was passed in then update the profilePose flag based on if the profilePoseConfidence value is greater or equal to the profilePoseConfidenceThreshold More...
 
void MergeRecognitionDetectedPropertiesFromPerson (Person person)
 Takes properties with values from the recognition process and merges them with the current person; Gender, Age, Sentiment, and Smile. More...
 
 Person (Person other)
 
Dictionary< string, object > JsonForPersonUpdatableProperties ()
 

Properties

string PersonId = null [get, set]
 The person's unique ID More...
 
Uri ImageUrl = null [get, set]
 A url to a best hosted image from all the merged person's face. More...
 
Uri UnmergedImageUrl = null [get, set]
 A url to a hosted image of the recognized person's face More...
 
DateTime? RootPersonAddDate = null [get, set]
 Unix Epoch time in milliseconds since root person was added to the system. More...
 
double? Sentiment = null [get, set]
 Estimated person sentiment. Range [-1, 1] More...
 
bool? Smile = null [get, set]
 Indicates whether the person is smiling or not. More...
 
double? Occlusion = null [get, set]
 Indicates whether person face is occluded. Range [0, 1] More...
 
double? CenterPoseQuality = null [get, set]
 
double? SharpnessQuality = null [get, set]
 
double? ContrastQuality = null [get, set]
 
string?? Name [get, set]
 The name of the person. More...
 
List< string >?? Tags [get, set]
 Arbitrary tags that may be set via Update Person API. More...
 
bool?? Ignore [get, set]
 a flag that may be set via Update Person API, also set when person's faces do not meet minimum criteria. More...
 
string MergedWithPersonId [get, set]
 personId of another person the identified person is merged with. More...
 
string???? RootPersonId [get, set]
 
Gender?? Gender [get, set]
 The person's gender stored in SAFR Cloud. If no stored value is present, an estimated value is used. More...
 
AgeAge [get, set]
 The person's age or age range. If Age has been previously stored in SAFR Cloud, then the stored value will be used. Otherwise an age is estimated. More...
 
string?? ExternalId [get, set]
 An id associated with a user through the Update Person Cloud API More...
 
string?? PersonType [get, set]
 Person type assigned with the Update Person API. More...
 
string?? ValidationPhone [get, set]
 Phone number that can be used to confirm identity of the person as a part of multi-factor identification scheme. associated with a user through the Update Person Cloud API. More...
 
string?? ValidationEmail [get, set]
 Email address that can be used to confirm identity of the person as a part of multi-factor identification scheme. associated with a user through the Update Person Cloud API.
More...
 
string?? HomeLocation [get, set]
 Gets or sets the home location. More...
 
string?? Company [get, set]
 Company name associated with a user through the Update Person Cloud API. More...
 
string?? Moniker [get, set]
 An alternative name, nickname, or informal name. More...
 
PersonIdClassIdClass [get, set]
 A person's classification
More...
 
DateTime? RootPersonExpirationDate [get, set]
 Unix Epoch time in milliseconds identifying when person record is expiring and will not be available for recognition. The date is Unix Epoch in milliseconds. More...
 
string[] Groups [get, set]
 
bool?? HasNotes [get, set]
 
string Notes [get, set]
 
bool?? HasDocs [get, set]
 
bool? HasFaceId [get, set]
 
string AccessClearance [get, set]
 
int? AccessClearanceLevel [get, set]
 
long? AccessActivatedUntil [get, set]
 
string AccessCardFormat [get, set]
 
string AccessFacilityId [get, set]
 
string AccessCardId [get, set]
 
List< PersonSimilarPeople = null [get, set]
 List of person objects whom have similar faces. More...
 
double? SimilarityScore = null [get, set]
 Match percentage. Range is from zero to above one. 100% (value 1.0) means that distance between face matches the threshold exactly. 100.23% (value 1.0023) means distance between faces is smaller than the threshold. 97.63% (value 0.9763) means distance between faces is larger than the threshold. More...
 
double Confidence = 0.0 [get, set]
 A floating point number describing how close a face matches the person identified. This number is normally from 0 to above 1. More...
 
double ProfilePoseConfidence = 0.0 [get, set]
 Used to determine if a face is a profile pose. e.g. confidence > profilePoseThreshold. More...
 
bool HasMergedPeople = false [get, set]
 Indicator if the root person has merged people. More...
 
bool ProfilePose = false [get, set]
 True if the person was detected based on a profile face image. More...
 
bool? ConfirmedDetect = null [get, set]
 Indicator if Face Service confirmed the detection. More...
 
double? Liveness = null [get, set]
 3D Liveness score. More...
 
bool? LivenessConfirmed = null [get, set]
 3D Liveness Confirmed. More...
 
bool? Mask = null [get, set]
 Is mask detected. More...
 
double? MaskConfidence = null [get, set]
 Mask confidence. More...
 
bool IsSpeculated [get]
 Set when similarity score is less than 0. More...
 
bool IsStranger [get]
 Returns true if the person is classified as a stranger More...
 
bool IsConcern [get]
 Returns true if the person is classified as a concern More...
 
bool IsThreat [get]
 Returns true if the person is classified as a threat More...
 
Sentiment SentimentRepresentation [get]
 A Sentiment object containing information related to the sentiment of the person such as whether they are smiling, sentiment thresholds, etc. More...
 

Detailed Description

Represents a person. Contains information from analysis of face and identity information from SAFR services.

Constructor & Destructor Documentation

◆ Person()

RealNetworks.ArgusKit.Person.Person ( Person  other)

Member Function Documentation

◆ GetDisplayName()

string RealNetworks.ArgusKit.Person.GetDisplayName ( )

Returns the persons name, if present, otherwise returns the persons Id.

◆ GetUnmergedDisplayUrl()

Uri RealNetworks.ArgusKit.Person.GetUnmergedDisplayUrl ( )

◆ JsonForPersonUpdatableProperties()

Dictionary<string, object> RealNetworks.ArgusKit.Person.JsonForPersonUpdatableProperties ( )

◆ MergeRecognitionDetectedPropertiesFromPerson()

void RealNetworks.ArgusKit.Person.MergeRecognitionDetectedPropertiesFromPerson ( Person  person)

Takes properties with values from the recognition process and merges them with the current person; Gender, Age, Sentiment, and Smile.

Parameters
personThe person data to merge from.

◆ ToString()

override string RealNetworks.ArgusKit.Person.ToString ( )

◆ UpdateProfilePoseFromThreshold()

void RealNetworks.ArgusKit.Person.UpdateProfilePoseFromThreshold ( double?  profilePoseConfidenceThreshold)

Using the given profile pose confidence threshold determine if we should override the profilePose flag and if so update it with the new value.
If a valid threshold was passed in then update the profilePose flag based on if the profilePoseConfidence value is greater or equal to the profilePoseConfidenceThreshold

Parameters
profilePoseConfidenceThresholdThe profile pose confidence threshold.

◆ UpdateSmileFromThreshold()

void RealNetworks.ArgusKit.Person.UpdateSmileFromThreshold ( double?  smileConfidenceThreshold)

Using the given smile threshold determine if we should override the smile flag and if so update it with the new value.
If a valid threshold was passed in and this person has a sentiment value then update the smile flag based on if the sentiment value is greater or equal to the smile threshold

Parameters
smileConfidenceThresholdThe smile confidence threshold.

Property Documentation

◆ AccessActivatedUntil

long? RealNetworks.ArgusKit.Person.AccessActivatedUntil
getset

◆ AccessCardFormat

string RealNetworks.ArgusKit.Person.AccessCardFormat
getset

◆ AccessCardId

string RealNetworks.ArgusKit.Person.AccessCardId
getset

◆ AccessClearance

string RealNetworks.ArgusKit.Person.AccessClearance
getset

◆ AccessClearanceLevel

int? RealNetworks.ArgusKit.Person.AccessClearanceLevel
getset

◆ AccessFacilityId

string RealNetworks.ArgusKit.Person.AccessFacilityId
getset

◆ Age

Age? RealNetworks.ArgusKit.Person.Age
getset

The person's age or age range. If Age has been previously stored in SAFR Cloud, then the stored value will be used. Otherwise an age is estimated.

◆ CenterPoseQuality

double? RealNetworks.ArgusKit.Person.CenterPoseQuality = null
getset

◆ Company

string?? RealNetworks.ArgusKit.Person.Company
getset

Company name associated with a user through the Update Person Cloud API.

◆ Confidence

double RealNetworks.ArgusKit.Person.Confidence = 0.0
getset

A floating point number describing how close a face matches the person identified. This number is normally from 0 to above 1.

◆ ConfirmedDetect

bool? RealNetworks.ArgusKit.Person.ConfirmedDetect = null
getset

Indicator if Face Service confirmed the detection.

◆ ContrastQuality

double? RealNetworks.ArgusKit.Person.ContrastQuality = null
getset

◆ ExternalId

string?? RealNetworks.ArgusKit.Person.ExternalId
getset

An id associated with a user through the Update Person Cloud API

◆ Gender

Gender?? RealNetworks.ArgusKit.Person.Gender
getset

The person's gender stored in SAFR Cloud. If no stored value is present, an estimated value is used.

◆ Groups

string [] RealNetworks.ArgusKit.Person.Groups
getset

◆ HasDocs

bool?? RealNetworks.ArgusKit.Person.HasDocs
getset

◆ HasFaceId

bool? RealNetworks.ArgusKit.Person.HasFaceId
getset

◆ HasMergedPeople

bool RealNetworks.ArgusKit.Person.HasMergedPeople = false
getset

Indicator if the root person has merged people.

◆ HasNotes

bool?? RealNetworks.ArgusKit.Person.HasNotes
getset

◆ HomeLocation

string?? RealNetworks.ArgusKit.Person.HomeLocation
getset

Gets or sets the home location.

◆ IdClass

PersonIdClass? RealNetworks.ArgusKit.Person.IdClass
getset

A person's classification

Unknown, Unidentified, Stranger, NoConcern, Concern, Threat

◆ Ignore

bool?? RealNetworks.ArgusKit.Person.Ignore
getset

a flag that may be set via Update Person API, also set when person's faces do not meet minimum criteria.

◆ ImageUrl

Uri RealNetworks.ArgusKit.Person.ImageUrl = null
getset

A url to a best hosted image from all the merged person's face.

◆ IsConcern

bool RealNetworks.ArgusKit.Person.IsConcern
get

Returns true if the person is classified as a concern

◆ IsSpeculated

bool RealNetworks.ArgusKit.Person.IsSpeculated
get

Set when similarity score is less than 0.

◆ IsStranger

bool RealNetworks.ArgusKit.Person.IsStranger
get

Returns true if the person is classified as a stranger

◆ IsThreat

bool RealNetworks.ArgusKit.Person.IsThreat
get

Returns true if the person is classified as a threat

◆ Liveness

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

3D Liveness score.

◆ LivenessConfirmed

bool? RealNetworks.ArgusKit.Person.LivenessConfirmed = null
getset

3D Liveness Confirmed.

◆ Mask

bool? RealNetworks.ArgusKit.Person.Mask = null
getset

Is mask detected.

◆ MaskConfidence

double? RealNetworks.ArgusKit.Person.MaskConfidence = null
getset

Mask confidence.

◆ MergedWithPersonId

string RealNetworks.ArgusKit.Person.MergedWithPersonId
getset

personId of another person the identified person is merged with.

◆ Moniker

string?? RealNetworks.ArgusKit.Person.Moniker
getset

An alternative name, nickname, or informal name.

◆ Name

string?? RealNetworks.ArgusKit.Person.Name
getset

The name of the person.

◆ Notes

string RealNetworks.ArgusKit.Person.Notes
getset

◆ Occlusion

double? RealNetworks.ArgusKit.Person.Occlusion = null
getset

Indicates whether person face is occluded. Range [0, 1]

◆ PersonId

string RealNetworks.ArgusKit.Person.PersonId = null
getset

The person's unique ID

◆ PersonType

string?? RealNetworks.ArgusKit.Person.PersonType
getset

Person type assigned with the Update Person API.

◆ ProfilePose

bool RealNetworks.ArgusKit.Person.ProfilePose = false
getset

True if the person was detected based on a profile face image.

◆ ProfilePoseConfidence

double RealNetworks.ArgusKit.Person.ProfilePoseConfidence = 0.0
getset

Used to determine if a face is a profile pose. e.g. confidence > profilePoseThreshold.

◆ RootPersonAddDate

DateTime? RealNetworks.ArgusKit.Person.RootPersonAddDate = null
getset

Unix Epoch time in milliseconds since root person was added to the system.

◆ RootPersonExpirationDate

DateTime? RealNetworks.ArgusKit.Person.RootPersonExpirationDate
getset

Unix Epoch time in milliseconds identifying when person record is expiring and will not be available for recognition. The date is Unix Epoch in milliseconds.

The root person expiration date.

◆ RootPersonId

string???? RealNetworks.ArgusKit.Person.RootPersonId
getset

◆ Sentiment

double? RealNetworks.ArgusKit.Person.Sentiment = null
getset

Estimated person sentiment. Range [-1, 1]

◆ SentimentRepresentation

Sentiment RealNetworks.ArgusKit.Person.SentimentRepresentation
get

A Sentiment object containing information related to the sentiment of the person such as whether they are smiling, sentiment thresholds, etc.

◆ SharpnessQuality

double? RealNetworks.ArgusKit.Person.SharpnessQuality = null
getset

◆ SimilarityScore

double? RealNetworks.ArgusKit.Person.SimilarityScore = null
getset

Match percentage. Range is from zero to above one. 100% (value 1.0) means that distance between face matches the threshold exactly. 100.23% (value 1.0023) means distance between faces is smaller than the threshold. 97.63% (value 0.9763) means distance between faces is larger than the threshold.

◆ SimilarPeople

List<Person> RealNetworks.ArgusKit.Person.SimilarPeople = null
getset

List of person objects whom have similar faces.

◆ Smile

bool? RealNetworks.ArgusKit.Person.Smile = null
getset

Indicates whether the person is smiling or not.

◆ Tags

List<string>?? RealNetworks.ArgusKit.Person.Tags
getset

Arbitrary tags that may be set via Update Person API.

◆ UnmergedImageUrl

Uri RealNetworks.ArgusKit.Person.UnmergedImageUrl = null
getset

A url to a hosted image of the recognized person's face

◆ ValidationEmail

string?? RealNetworks.ArgusKit.Person.ValidationEmail
getset

Email address that can be used to confirm identity of the person as a part of multi-factor identification scheme. associated with a user through the Update Person Cloud API.

◆ ValidationPhone

string?? RealNetworks.ArgusKit.Person.ValidationPhone
getset

Phone number that can be used to confirm identity of the person as a part of multi-factor identification scheme. associated with a user through the Update Person Cloud API.