Class FaceInfo

Namespace

TCSystem.MetaData

Assembly

TCSystem.MetaData.dll

Provides flattened face, file, and person information returned by metadata database queries.

public sealed class FaceInfo : IEquatable<FaceInfo>

Inheritance

object

FaceInfo

Implements

IEquatable<FaceInfo>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

FaceInfo(long, long, long, FaceMode, FaceQuality, IReadOnlyList<FixedPoint64>)

Provides flattened face, file, and person information returned by metadata database queries.

public FaceInfo(long _fileId, long _faceId, long _personId, FaceMode _faceMode, FaceQuality _faceQuality, IReadOnlyList<FixedPoint64> _faceDescriptor)

Parameters

_fileId long

The file identifier.

_faceId long

The face identifier.

_personId long

The associated person identifier.

_faceMode FaceMode

The detector that found the face.

_faceQuality FaceQuality

The face quality classification.

_faceDescriptor IReadOnlyList<FixedPoint64>

The optional face descriptor.

Properties

FaceDescriptor

Gets the face descriptor, or an empty list when none is available.

public IReadOnlyList<FixedPoint64> FaceDescriptor { get; }

Property Value

IReadOnlyList<FixedPoint64>

FaceId

Gets the face identifier.

public long FaceId { get; }

Property Value

long

FaceMode

Gets the detector that found the face.

public FaceMode FaceMode { get; }

Property Value

FaceMode

FaceQuality

Gets the face quality classification.

public FaceQuality FaceQuality { get; }

Property Value

FaceQuality

FileId

Gets the file identifier.

public long FileId { get; }

Property Value

long

PersonId

Gets the person identifier, mapping the reserved empty-person identifier to InvalidId .

public long PersonId { get; }

Property Value

long

Methods

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

Equals(FaceInfo)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(FaceInfo other)

Parameters

other FaceInfo

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

FromJsonString(string)

Deserializes face information from JSON.

public static FaceInfo FromJsonString(string jsonString)

Parameters

jsonString string

The JSON to deserialize.

Returns

FaceInfo

The information, or null for null or empty input.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

ToJsonString()

Serializes the information to compact JSON.

public string ToJsonString()

Returns

string

The serialized value.

ToJsonStringArray(IEnumerable<FaceInfo>)

Serializes a sequence of face information to a compact JSON array.

public static string ToJsonStringArray(IEnumerable<FaceInfo> faceInfos)

Parameters

faceInfos IEnumerable<FaceInfo>

The values to serialize.

Returns

string

The serialized JSON array.

ToString()

Serializes the information to indented JSON.

public override string ToString()

Returns

string

The formatted JSON.