# Face Pipeline

Action parameters for the field face_image:

Parameter	Type	Description	Required	Value range
performTemplateExtraction	bool	Extract biometric template from the face on the image	no
faceDetectorConfidence	float	Face detector confidence	no	`(0.0, 1.0)`
faceSelectorAlg	int	Parameter adds Face selection logic (using face selector module of T5-Face SDK), if there are more than 1 face is detected on `face_image`. If the parameter not specified, method Enroll returns an error, if there are more than 1 face founded on the `face_image`.	no	`0` - the widest face will be chosen; `1` - face with the biggest confidence will be chosen; `2` - face closest to the image center will be chosen
performCompression	bool	Performs image compression using face compression module of T5-Face SDK	no
compressionLevel	int	Image compression level	no	`[1, 5]` where `1` - less size, low quality; `5` - bigger size, higher quality

◽ Notice: if one of parameter is not specified system default value will be used.

# Sample pipelines

detect faces with confidence 0.6;
select face if more than 1 face is detected using face selector 1 ("biggest confidence");
extract template from selected face;
perform image compression with compression level 2 on selected face

{
  "facePipeline": 
  {
      "performTemplateExtraction": true,
      "faceDetectorConfidence": 0.6,
      "faceSelectorAlg": 1,
      "performCompression": true,
      "compressionLevel": 2
  }  
}

1
2
3
4
5
6
7
8
9
10

detect faces with system default confidence
abort processing if none or more than one faces detected
skip template extraction
perform image compression with compression level 1 on detected face

{
  "facePipeline": 
  {
      "performTemplateExtraction": false,      
      "performCompression": true,
      "compressionLevel": 1
  }  
}

1
2
3
4
5
6
7
8

detect faces with system default confidence
abort processing if none or more than one faces detected
extract template from detected face
skip image compression

{
  "facePipeline": 
  {      
      "performCompression": false      
  }  
}

1
2
3
4
5
6

# Default Face Pipeline

This pipeline will be generated automatically if not explicitly specified in pipeline request field.

{
  "facePipeline": 
  {
      "performTemplateExtraction": true,
      "performCompression": true
  }  
}

1
2
3
4
5
6
7