net.idrnd.facesdk

Class DetectEngine

java.lang.Object

net.idrnd.facesdk.FaceSdkNativePeer

net.idrnd.facesdk.DetectEngine

All Implemented Interfaces:

java.lang.AutoCloseable

public class DetectEngine
extends FaceSdkNativePeer

Engine of face detection.

Constructor Summary

Constructors

Constructor and Description
DetectEngine(java.lang.String engineName, InitConfig config) Constructor.

Method Summary

Modifier and Type	Method and Description
DetectionResult	detect(Image image) Detect faces from input image.
OptionalResult<DetectionResult>[]	detectBatch(Image[] images) Deprecated. Using this method has no benefits compared to the usual detect method.
BoundingBox[]	detectOnlyBoundingBox(Image image) Detect faces bounding box from input image.
OptionalResult<BoundingBox[]>[]	detectOnlyBoundingBoxBatch(Image[] images) Deprecated. Using this method has no benefits compared to the usual detectOnlyBoundingBox method.

Methods inherited from class net.idrnd.facesdk.FaceSdkNativePeer

close, equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DetectEngine

public DetectEngine(java.lang.String engineName,
                    InitConfig config)

Constructor.

Parameters:

engineName - name of engine.

config - configuration of engine.

Throws:

FaceException - if the provided engine name is invalid or null argument passed.

Method Detail

detect

public DetectionResult detect(Image image)

Detect faces from input image.

Parameters:

image - image in FaceSDK format.

Returns:

detected faces from input image.

Throws:

FaceException - if null argument passed.

detectBatch

@Deprecated
public OptionalResult<DetectionResult>[] detectBatch(Image[] images)

Deprecated. Using this method has no benefits compared to the usual detect method.

Detect faces from input image batch.

Parameters:

images - input image batch.

Returns:

optional results of face detection. The size of the result array is guaranteed equal to `images` array size.

Throws:

FaceException - if null argument passed.

detectOnlyBoundingBox

public BoundingBox[] detectOnlyBoundingBox(Image image)

Detect faces bounding box from input image.

Parameters:

image - image in FaceSDK format.

Returns:

detected faces bounding box from input image.

Throws:

FaceException - if null argument passed.

detectOnlyBoundingBoxBatch

@Deprecated
public OptionalResult<BoundingBox[]>[] detectOnlyBoundingBoxBatch(Image[] images)

Deprecated. Using this method has no benefits compared to the usual detectOnlyBoundingBox method.

Detect faces bounding boxes from input image batch.

Parameters:

images - input image batch.

Returns:

optional detected bounding boxes. The size of the result array is guaranteed equal to `images` array size.

Throws:

FaceException - if null argument passed.