net.idrnd.facesdk

Class Pipeline

java.lang.Object

net.idrnd.facesdk.FaceSdkNativePeer

net.idrnd.facesdk.Pipeline

All Implemented Interfaces:

java.lang.AutoCloseable

public class Pipeline
extends FaceSdkNativePeer

Pipeline of liveness detection.

Constructor Summary

Constructors

Constructor and Description
Pipeline(java.lang.String pipelineName, InitConfig config) Constructor.

Method Summary

Modifier and Type	Method and Description
PipelineResult	checkLiveness(Image image)
PipelineResult	checkLiveness(ImageBatch imageBatch)
PipelineResult	checkLiveness(ImageBatch imageBatch, Meta meta) Perform liveness check on a sequence of photos (image batch).
PipelineResult	checkLiveness(Image image, Meta meta) Check liveness of face from input image.
OptionalResult<PipelineResult>[]	checkLivenessBatch(Image[] images) Deprecated. Using this method has no benefits compared to the usual checkLiveness method.
OptionalResult<PipelineResult>[]	checkLivenessBatch(Image[] images, Meta[] meta) Deprecated. Using this method has no benefits compared to the usual checkLiveness 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

Pipeline

public Pipeline(java.lang.String pipelineName,
                InitConfig config)

Constructor.

Parameters:

pipelineName - name of pipeline.

config - configuration of pipeline.

Throws:

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

Method Detail

checkLiveness

public PipelineResult checkLiveness(Image image,
                                    Meta meta)

Check liveness of face from input image.

Parameters:

image - image in FaceSDK format to check.

meta - meta information provided for FaceSDK calibration.

Returns:

result of liveness detection and the quality estimation.

Throws:

FaceException - if null argument passed, the license has expired, face detection step failed or image didn't pass validations. See FaceException.Status for codes of possible errors.

checkLiveness

public PipelineResult checkLiveness(Image image)

checkLiveness

public PipelineResult checkLiveness(ImageBatch imageBatch,
                                    Meta meta)

Perform liveness check on a sequence of photos (image batch). A single results corresponding to the whole image batch will be produced.

Parameters:

imageBatch - input batch of images (a sequence of photos).

meta - meta information provided for FaceSDK calibration.

Returns:

a single liveness result for a given sequence of photos.

Throws:

FaceException - if null argument passed, the license has expired or if for all images detection step or image validation are failed. See FaceException.Status for codes of possible errors.

checkLiveness

public PipelineResult checkLiveness(ImageBatch imageBatch)

checkLivenessBatch

@Deprecated
public OptionalResult<PipelineResult>[] checkLivenessBatch(Image[] images,
                                                                       Meta[] meta)

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

Perform liveness check on am image batch.

Parameters:

images - input image batch.

meta - meta information provided for FaceSDK calibration.

Returns:

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

Throws:

FaceException - if null argument passed or the license has expired.

checkLivenessBatch

@Deprecated
public OptionalResult<PipelineResult>[] checkLivenessBatch(Image[] images)

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