Class DetectSingleFaceTask

Hierarchy

DetectFacesTaskBase<FaceDetection | undefined>
- DetectSingleFaceTask

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DetectSingleFaceTask(input: TNetInput, options?: FaceDetectionOptions): DetectSingleFaceTask

Inherited from DetectFacesTaskBase.constructor
- Defined in face-api.js/src/globalApi/DetectFacesTasks.ts:14
Parameters
- input: TNetInput
- Default value options: FaceDetectionOptions = new SsdMobilenetv1Options()
Returns DetectSingleFaceTask

Properties

Protected input

input: TNetInput

Protected options

options: FaceDetectionOptions

Methods

run

run(): Promise<FaceDetection | undefined>

Overrides ComposableTask.run
- Defined in face-api.js/src/globalApi/DetectFacesTasks.ts:78
Returns Promise<FaceDetection | undefined>

then

then(onfulfilled: function): Promise<FaceDetection | undefined>

Inherited from ComposableTask.then
- Defined in face-api.js/src/globalApi/ComposableTask.ts:3
Parameters
- onfulfilled: function
  - - (value: FaceDetection | undefined): FaceDetection | undefined | PromiseLike<FaceDetection | undefined>
    - Parameters
      - value: FaceDetection | undefined
      Returns FaceDetection | undefined | PromiseLike<FaceDetection | undefined>
Returns Promise<FaceDetection | undefined>

withFaceExpressions

withFaceExpressions(): PredictSingleFaceExpressionTask<WithFaceDetection<__type>>

- Defined in face-api.js/src/globalApi/DetectFacesTasks.ts:104
Returns PredictSingleFaceExpressionTask<WithFaceDetection<__type>>

withFaceLandmarks

withFaceLandmarks(useTinyLandmarkNet?: boolean): DetectSingleFaceLandmarksTask<WithFaceDetection<__type>>

- Defined in face-api.js/src/globalApi/DetectFacesTasks.ts:96
Parameters
- Default value useTinyLandmarkNet: boolean = false
Returns DetectSingleFaceLandmarksTask<WithFaceDetection<__type>>

Generated using TypeDoc