FaceParams
Parameters of FaceProcessor
Extends
Section titled “Extends”Properties
Section titled “Properties”backproj?
Section titled “backproj?”
optionalbackproj:boolean
cache?
Section titled “cache?”
optionalcache:boolean
Cache computational modules (experimental)
Inherited from
Section titled “Inherited from”highP?
Section titled “highP?”
optionalhighP:boolean
Evaluate with higher precision for lips, eyes and irises. When enabled computation is slower, but contours of lips are much more accurate and eye/iris detection is enabled.
optionalmask:MaskParam
Evaluate body segmentation mask. Segmentation mask is a monochrome image where every pixel has value from 0 to 1 denoting the probability of it being a foreground pixel. Default resolution of a segmentation mask is 128x128.
maskExt?
Section titled “maskExt?”
optionalmaskExt:number
Extent of a segmentation mask box around detected face box. This fraction of width/height will be added to the face rect on all sides and mask will be evaluated in the extented rect. If undefined segmentation will be done for the whole image.
maskSize?
Section titled “maskSize?”
optionalmaskSize:256|192|128
Size of a segmentation mask. Available sizes are 256, 192, 128;
256x256 is the default. If maskExt is defined a square mask of
maskSize size will be evaluated, otherwise mask size will be
adjusted according to aspect ratio preserving the longer side.
metric?
Section titled “metric?”
optionalmetric:boolean
Evaluate metric 3D points - points within 3D space of perspective camera located at the space origin and pointed in the negative direction of the Z-axis. These points can be used to apply texture face mask.
rateRoI()?
Section titled “rateRoI()?”
optionalrateRoI: (roi,ratio) =>number
Rate face detection
Method evaluating measure of priority for face detection. Detections with higher rates will be considered first for further tracking. For example, this method may guide selection of tracking targets to prioritize bigger or cenetred detections, downweight score according to some rulles. Default implementation forwards score as rate. Targets with rate <= 0.0 will be completely ignored.
Parameters
Section titled “Parameters”Face detection
number
Image aspect ratio
Returns
Section titled “Returns”number
Priority rate of the detection
optionalroot:string
Root path to computational modules (statically served wasms). The SDK requires access to wasm modules provided within its packages. By default, the root path is the current url ”./”. Root can be set on Engine#init | Engine initialization.
Inherited from
Section titled “Inherited from”token:
string
The SDK access token. Mandatory parameter authenticating your user account and providing access to the SDK on the current url. You can create tokens for required urls on your account page. Token must be provided to initialize Engine#init | Engine. More.
Inherited from
Section titled “Inherited from”transform?
Section titled “transform?”
optionaltransform:boolean
Evaluate transformation aligning reference face 3D model with the measured one. Applying this transformation one can align 3D object with the current pose (translation+rotation) of the head. If the model’s initial position is aligned with the reference face, relative transformation will be preserved