Package com.libremobileos.yifan.face

Class FaceScanner

java.lang.Object

com.libremobileos.yifan.face.FaceScanner

public class FaceScanner
extends Object

Raw wrapper around AI model that scans ONE Face inside a perfectly cropped Bitmap and returns facial features. Most likely, specialized classes like FaceRecognizer or FaceFinder fit your use case better.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FaceScanner.Face	An immutable result returned by a FaceDetector describing what was recognized.
static class	FaceScanner.InputImage	Wrapper around Bitmap to avoid user passing unprocessed data
static class	FaceScanner.InputImageProcessor	Processes Bitmaps to compatible format.

Method Summary

Modifier and Type	Method	Description
static FaceScanner	create(Context context)	Create FaceScanner instance with sensible defaults regarding hardware acceleration (CPU, XNNPACK, 4 threads).
static FaceScanner	create(Context context, boolean hwAcceleration, boolean enhancedHwAcceleration, int numThreads)	Create FaceScanner instance.
FaceScanner.Face	detectFace(FaceScanner.InputImage input, boolean allowPostprocessing)	Scan the face inside the FaceScanner.InputImage.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static FaceScanner create(Context context,
                                 boolean hwAcceleration,
                                 boolean enhancedHwAcceleration,
                                 int numThreads)

Create FaceScanner instance.

Parameters:

context - Android Context object, may be in background.

hwAcceleration - Enable hardware acceleration (NNAPI/GPU)

enhancedHwAcceleration - if hwAcceleration is enabled, use NNAPI instead of GPU. if not, this toggles XNNPACK

numThreads - How many threads to use, if running on CPU or with XNNPACK

Returns:

FaceScanner instance.

See Also:

create(Context)

create

public static FaceScanner create(Context context)

Create FaceScanner instance with sensible defaults regarding hardware acceleration (CPU, XNNPACK, 4 threads).

Parameters:

context - Android Context object, may be in background.

Returns:

FaceScanner instance.

See Also:

create(Context, boolean, boolean, int)

detectFace

public FaceScanner.Face detectFace(FaceScanner.InputImage input,
                                   boolean allowPostprocessing)

Scan the face inside the FaceScanner.InputImage.

Parameters:

input - The FaceScanner.InputImage to process

allowPostprocessing - Allow postprocessing to improve detection quality. Undesirable when registering faces.

Returns:

FaceScanner.Face