2021-09-12 05:54:35 +02:00
<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
2021-09-12 06:30:11 +02:00
< title > FaceConfig | @vladmandic/human - v2.2.0< / title >
< meta name = "description" content = "Documentation for @vladmandic/human - v2.2.0" >
2021-09-12 05:54:35 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "stylesheet" href = "../assets/css/main.css" >
< script async src = "../assets/js/search.js" id = "search-script" > < / script >
< / head >
< body >
< header >
< div class = "tsd-page-toolbar" >
< div class = "container" >
< div class = "table-wrap" >
< div class = "table-cell" id = "tsd-search" data-index = "../assets/js/search.json" data-base = ".." >
< div class = "field" >
< label for = "tsd-search-field" class = "tsd-widget search no-caption" > Search< / label >
< input id = "tsd-search-field" type = "text" / >
< / div >
< ul class = "results" >
< li class = "state loading" > Preparing search index...< / li >
< li class = "state failure" > The search index is not available< / li >
< / ul >
2021-09-12 06:30:11 +02:00
< a href = "../index.html" class = "title" > @vladmandic/human - v2.2.0< / a >
2021-09-12 05:54:35 +02:00
< / div >
< div class = "table-cell" id = "tsd-widgets" >
< div id = "tsd-filter" >
< a href = "#" class = "tsd-widget options no-caption" data-toggle = "options" > Options< / a >
< div class = "tsd-filter-group" >
< div class = "tsd-select" id = "tsd-filter-visibility" >
< span class = "tsd-select-label" > All< / span >
< ul class = "tsd-select-list" >
< li data-value = "public" > Public< / li >
< li data-value = "protected" > Public/Protected< / li >
< li data-value = "private" class = "selected" > All< / li >
< / ul >
< / div >
< input type = "checkbox" id = "tsd-filter-inherited" checked / >
< label class = "tsd-widget" for = "tsd-filter-inherited" > Inherited< / label >
< / div >
< / div >
< a href = "#" class = "tsd-widget menu no-caption" data-toggle = "menu" > Menu< / a >
< / div >
< / div >
< / div >
< / div >
< div class = "tsd-page-title" >
< div class = "container" >
< ul class = "tsd-breadcrumb" >
< li >
2021-09-12 06:30:11 +02:00
< a href = "../index.html" > @vladmandic/human - v2.2.0< / a >
2021-09-12 05:54:35 +02:00
< / li >
< li >
< a href = "FaceConfig.html" > FaceConfig< / a >
< / li >
< / ul >
< h1 > Interface FaceConfig< / h1 >
< / div >
< / div >
< / header >
< div class = "container container-main" >
< div class = "row" >
< div class = "col-8 col-content" >
< section class = "tsd-panel tsd-comment" >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Controlls and configures all face-specific options:< / p >
< ul >
< li > face detection, face mesh detection, age, gender, emotion detection and face description
Parameters:< / li >
< li > enabled: true/false< / li >
< li > modelPath: path for each of face models< / li >
< li > minConfidence: threshold for discarding a prediction< / li >
< li > iouThreshold: ammount of overlap between two detected objects before one object is removed< / li >
< li > maxDetected: maximum number of faces detected in the input, should be set to the minimum number for performance< / li >
< li > rotation: use calculated rotated face image or just box with rotation as-is, false means higher performance, but incorrect mesh mapping on higher face angles< / li >
< li > return: return extracted face as tensor for futher user processing, in which case user is reponsible for manually disposing the tensor< / li >
< / ul >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > Hierarchy< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > FaceConfig< / span >
< / li >
< / ul >
< / section >
< section class = "tsd-panel-group tsd-index-group" >
< h2 > Index< / h2 >
< section class = "tsd-panel tsd-index-panel" >
< div class = "tsd-index-content" >
< section class = "tsd-index-section " >
< h3 > Properties< / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "FaceConfig.html#description" class = "tsd-kind-icon" > description< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "FaceConfig.html#detector" class = "tsd-kind-icon" > detector< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "FaceConfig.html#emotion" class = "tsd-kind-icon" > emotion< / a > < / li >
2021-09-12 06:05:06 +02:00
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "FaceConfig.html#enabled" class = "tsd-kind-icon" > enabled< / a > < / li >
2021-09-12 05:54:35 +02:00
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "FaceConfig.html#iris" class = "tsd-kind-icon" > iris< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "FaceConfig.html#mesh" class = "tsd-kind-icon" > mesh< / a > < / li >
< / ul >
< / section >
< / div >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Properties< / h2 >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "description" class = "tsd-anchor" > < / a >
< h3 > description< / h3 >
2021-09-12 06:05:06 +02:00
< div class = "tsd-signature tsd-kind-icon" > description< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "FaceDescriptionConfig.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > FaceDescriptionConfig< / a > < span class = "tsd-signature-symbol" > > < / span > < / div >
2021-09-12 05:54:35 +02:00
< aside class = "tsd-sources" >
< ul >
2021-09-12 06:30:11 +02:00
< li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L54" > config.ts:54< / a > < / li >
2021-09-12 05:54:35 +02:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "detector" class = "tsd-anchor" > < / a >
< h3 > detector< / h3 >
2021-09-12 06:05:06 +02:00
< div class = "tsd-signature tsd-kind-icon" > detector< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "FaceDetectorConfig.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > FaceDetectorConfig< / a > < span class = "tsd-signature-symbol" > > < / span > < / div >
2021-09-12 05:54:35 +02:00
< aside class = "tsd-sources" >
< ul >
2021-09-12 06:30:11 +02:00
< li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L51" > config.ts:51< / a > < / li >
2021-09-12 05:54:35 +02:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "emotion" class = "tsd-anchor" > < / a >
< h3 > emotion< / h3 >
2021-09-12 06:05:06 +02:00
< div class = "tsd-signature tsd-kind-icon" > emotion< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "FaceEmotionConfig.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > FaceEmotionConfig< / a > < span class = "tsd-signature-symbol" > > < / span > < / div >
2021-09-12 05:54:35 +02:00
< aside class = "tsd-sources" >
< ul >
2021-09-12 06:30:11 +02:00
< li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L55" > config.ts:55< / a > < / li >
2021-09-12 05:54:35 +02:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
2021-09-12 06:05:06 +02:00
< a name = "enabled" class = "tsd-anchor" > < / a >
2021-09-12 05:54:35 +02:00
< h3 > enabled< / h3 >
< div class = "tsd-signature tsd-kind-icon" > enabled< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div >
< aside class = "tsd-sources" >
< ul >
2021-09-12 06:30:11 +02:00
< li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L50" > config.ts:50< / a > < / li >
2021-09-12 05:54:35 +02:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "iris" class = "tsd-anchor" > < / a >
< h3 > iris< / h3 >
2021-09-12 06:05:06 +02:00
< div class = "tsd-signature tsd-kind-icon" > iris< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "FaceIrisConfig.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > FaceIrisConfig< / a > < span class = "tsd-signature-symbol" > > < / span > < / div >
2021-09-12 05:54:35 +02:00
< aside class = "tsd-sources" >
< ul >
2021-09-12 06:30:11 +02:00
< li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L53" > config.ts:53< / a > < / li >
2021-09-12 05:54:35 +02:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "mesh" class = "tsd-anchor" > < / a >
< h3 > mesh< / h3 >
2021-09-12 06:05:06 +02:00
< div class = "tsd-signature tsd-kind-icon" > mesh< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "FaceMeshConfig.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > FaceMeshConfig< / a > < span class = "tsd-signature-symbol" > > < / span > < / div >
2021-09-12 05:54:35 +02:00
< aside class = "tsd-sources" >
< ul >
2021-09-12 06:30:11 +02:00
< li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L52" > config.ts:52< / a > < / li >
2021-09-12 05:54:35 +02:00
< / ul >
< / aside >
< / section >
< / section >
< / div >
< div class = "col-4 col-menu menu-sticky-wrap menu-highlight" >
< nav class = "tsd-navigation primary" >
< ul >
< li class = " " >
< a href = "../index.html" > Exports< / a >
< / li >
< / ul >
< / nav >
< nav class = "tsd-navigation secondary menu-sticky" >
< ul class = "before-current" >
< li class = " tsd-kind-reference" >
< a href = "../index.html#default" class = "tsd-kind-icon" > default< / a >
< / li >
< li class = " tsd-kind-class" >
< a href = "../classes/Human.html" class = "tsd-kind-icon" > Human< / a >
< / li >
< li class = " tsd-kind-interface" >
< a href = "BodyConfig.html" class = "tsd-kind-icon" > Body< wbr > Config< / a >
< / li >
< li class = " tsd-kind-interface" >
< a href = "BodyResult.html" class = "tsd-kind-icon" > Body< wbr > Result< / a >
< / li >
< li class = " tsd-kind-interface" >
< a href = "Config.html" class = "tsd-kind-icon" > Config< / a >
< / li >
< li class = " tsd-kind-interface" >
< a href = "DrawOptions.html" class = "tsd-kind-icon" > Draw< wbr > Options< / a >
< / li >
< / ul >
< ul class = "current" >
< li class = "current tsd-kind-interface" >
< a href = "FaceConfig.html" class = "tsd-kind-icon" > Face< wbr > Config< / a >
< ul >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "FaceConfig.html#description" class = "tsd-kind-icon" > description< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "FaceConfig.html#detector" class = "tsd-kind-icon" > detector< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "FaceConfig.html#emotion" class = "tsd-kind-icon" > emotion< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
2021-09-12 06:05:06 +02:00
< a href = "FaceConfig.html#enabled" class = "tsd-kind-icon" > enabled< / a >
2021-09-12 05:54:35 +02:00
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "FaceConfig.html#iris" class = "tsd-kind-icon" > iris< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "FaceConfig.html#mesh" class = "tsd-kind-icon" > mesh< / a >
< / li >
< / ul >
< / li >
< / ul >
< ul class = "after-current" >
2021-09-12 06:05:06 +02:00
< li class = " tsd-kind-interface" >
< a href = "FaceDescriptionConfig.html" class = "tsd-kind-icon" > Face< wbr > Description< wbr > Config< / a >
< / li >
< li class = " tsd-kind-interface" >
< a href = "FaceDetectorConfig.html" class = "tsd-kind-icon" > Face< wbr > Detector< wbr > Config< / a >
< / li >
< li class = " tsd-kind-interface" >
< a href = "FaceEmotionConfig.html" class = "tsd-kind-icon" > Face< wbr > Emotion< wbr > Config< / a >
< / li >
< li class = " tsd-kind-interface" >
< a href = "FaceIrisConfig.html" class = "tsd-kind-icon" > Face< wbr > Iris< wbr > Config< / a >
< / li >
< li class = " tsd-kind-interface" >
< a href = "FaceMeshConfig.html" class = "tsd-kind-icon" > Face< wbr > Mesh< wbr > Config< / a >
< / li >
2021-09-12 05:54:35 +02:00
< li class = " tsd-kind-interface" >
< a href = "FaceResult.html" class = "tsd-kind-icon" > Face< wbr > Result< / a >
< / li >
< li class = " tsd-kind-interface" >
< a href = "FilterConfig.html" class = "tsd-kind-icon" > Filter< wbr > Config< / a >
< / li >
< li class = " tsd-kind-interface" >
< a href = "GestureConfig.html" class = "tsd-kind-icon" > Gesture< wbr > Config< / a >
< / li >
< li class = " tsd-kind-interface" >
< a href = "HandConfig.html" class = "tsd-kind-icon" > Hand< wbr > Config< / a >
< / li >
< li class = " tsd-kind-interface" >
< a href = "HandResult.html" class = "tsd-kind-icon" > Hand< wbr > Result< / a >
< / li >
< li class = " tsd-kind-interface" >
< a href = "ObjectConfig.html" class = "tsd-kind-icon" > Object< wbr > Config< / a >
< / li >
< li class = " tsd-kind-interface" >
< a href = "ObjectResult.html" class = "tsd-kind-icon" > Object< wbr > Result< / a >
< / li >
< li class = " tsd-kind-interface" >
< a href = "PersonResult.html" class = "tsd-kind-icon" > Person< wbr > Result< / a >
< / li >
< li class = " tsd-kind-interface" >
< a href = "Result.html" class = "tsd-kind-icon" > Result< / a >
< / li >
< li class = " tsd-kind-interface" >
< a href = "SegmentationConfig.html" class = "tsd-kind-icon" > Segmentation< wbr > Config< / a >
< / li >
< li class = " tsd-kind-type-alias" >
< a href = "../index.html#Error" class = "tsd-kind-icon" > Error< / a >
< / li >
2021-09-12 06:30:11 +02:00
< li class = " tsd-kind-type-alias" >
< a href = "../index.html#Events" class = "tsd-kind-icon" > Events< / a >
< / li >
2021-09-12 05:54:35 +02:00
< li class = " tsd-kind-type-alias" >
< a href = "../index.html#GestureResult" class = "tsd-kind-icon" > Gesture< wbr > Result< / a >
< / li >
< li class = " tsd-kind-type-alias" >
< a href = "../index.html#Input" class = "tsd-kind-icon" > Input< / a >
< / li >
< li class = " tsd-kind-type-alias" >
< a href = "../index.html#TensorFlow" class = "tsd-kind-icon" > Tensor< wbr > Flow< / a >
< / li >
< li class = " tsd-kind-variable" >
< a href = "../index.html#defaults" class = "tsd-kind-icon" > defaults< / a >
< / li >
2021-09-12 18:42:17 +02:00
< li class = " tsd-kind-variable" >
< a href = "../index.html#env" class = "tsd-kind-icon" > env< / a >
< / li >
2021-09-12 05:54:35 +02:00
< / ul >
< / nav >
< / div >
< / div >
< / div >
< footer >
< div class = "container" >
< h2 > Legend< / h2 >
< div class = "tsd-legend-group" >
< ul class = "tsd-legend" >
< li class = "tsd-kind-constructor tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Constructor< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< / ul >
< / div >
< / div >
< / footer >
< div class = "overlay" > < / div >
< script src = "../assets/js/main.js" > < / script >
< / body >
< / html >
