C# Face Detector API

OneML model to detect faces in images, returning their confident score, bounding box, face landmarks and poses.

OneML.Face.FaceDetector : public global.SystemIDisposable

Public Functions

inline void Dispose()

Gracefully destroy the object and free memory.

inline FaceDetector(LicenseManager manager)

Construct a FaceDetector object.

Parameters
  • manager: LicenseManager instance.

inline FaceDetectorResultList Detect(ImageBatch imgs)

Detect faces in images.

Return

an instance of FaceDetectorResultList.

Parameters

inline FaceDetectorResultList Detect(ImageBatch imgs, float score_threshold)

Detect faces in images.

Return

an instance of FaceDetectorResultList.

Parameters
  • imgs: an instance of ImageBatch.

  • score_threshold: score threshold

inline FaceDetectorResult Detect(Image img)

Detect faces in an image.

Return

an instance of FaceDetectorResult.

Parameters
  • img: an instance of Image.

inline FaceDetectorResult Detect(Image img, float score_threshold)

Detect faces in an image.

Return

an instance of FaceDetectorResult.

Parameters
  • img: an instance of Image.

  • score_threshold: score threshold

OneML.Face.FaceDetectorResult : public global.SystemIDisposable

Public Functions

inline void Dispose()

Gracefully destroy the object and free memory.

inline int GetSize()

Get number of detections.

Return

an integer.

inline BBoxList GetBBoxes()

Get result Bounding Boxes.

Return

an instance of BBoxList.

inline FloatList GetScores()

Get result scores.

Return

an instance of FloatList.

inline Landmark5List GetLandmarks()

Get result landmarks.

Return

an instance of Landmark5List.

inline FacePoseList GetPoses()

Get result face poses.

Return

an instance of FacePostList.

inline StatusCodeList GetReturnStatus()

Get result status code.

Return

an instance of StatusCodeList.

OneML.Face.FaceDetectorResultList : public global.SystemIDisposable , public global.SystemCollections.IEnumerable , public global::SystemCollections::Generic::IEnumerable< FaceDetectorResult >

Public Functions

inline void Dispose()

Gracefully destroy the object and free memory.

FaceDetectorResultListEnumerator : public global.SystemCollections.IEnumerator , public global::SystemCollections::Generic::IEnumerator< FaceDetectorResult >

Note that the IEnumerator documentation requires an InvalidOperationException to be thrown whenever the collection is modified.

This has been done for changes in the size of the collection but not when one of the elements of the collection is modified as it is a bit tricky to detect unmanaged code that modifies the collection under our feet.

Enums

enum FaceDetectorStatus

Values:

enumerator Empty
enumerator Success
enumerator Fail