2021-04-10 03:53:48 +02:00
<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > Config | @vladmandic/human< / title >
< meta name = "description" content = "Documentation for @vladmandic/human" >
< 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 >
< a href = "../index.html" class = "title" > @vladmandic/human< / a >
< / 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 >
< a href = "../index.html" > @vladmandic/human< / a >
< / li >
< li >
< a href = "config.html" > Config< / a >
< / li >
< / ul >
< h1 > Interface Config< / 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 > Configuration interface definition for < strong > Human< / strong > library< / p >
< / div >
< p > Contains all configurable parameters< / p >
< / div >
< / section >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > Hierarchy< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > Config< / 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 = "config.html#async" class = "tsd-kind-icon" > async< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "config.html#backend" class = "tsd-kind-icon" > backend< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "config.html#body" class = "tsd-kind-icon" > body< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "config.html#deallocate" class = "tsd-kind-icon" > deallocate< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "config.html#debug" class = "tsd-kind-icon" > debug< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "config.html#face" class = "tsd-kind-icon" > face< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "config.html#filter" class = "tsd-kind-icon" > filter< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "config.html#gesture" class = "tsd-kind-icon" > gesture< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "config.html#hand" class = "tsd-kind-icon" > hand< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "config.html#modelbasepath" class = "tsd-kind-icon" > model< wbr > Base< wbr > Path< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "config.html#object" class = "tsd-kind-icon" > object< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "config.html#profile" class = "tsd-kind-icon" > profile< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "config.html#scoped" class = "tsd-kind-icon" > scoped< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "config.html#videooptimized" class = "tsd-kind-icon" > video< wbr > Optimized< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "config.html#warmup" class = "tsd-kind-icon" > warmup< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "config.html#wasmpath" class = "tsd-kind-icon" > wasm< wbr > Path< / 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 = "async" class = "tsd-anchor" > < / a >
< h3 > async< / h3 >
< div class = "tsd-signature tsd-kind-icon" > async< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Perform model loading and inference concurrently or sequentially< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "backend" class = "tsd-anchor" > < / a >
< h3 > backend< / h3 >
2021-04-13 17:05:52 +02:00
< div class = "tsd-signature tsd-kind-icon" > backend< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " " < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " cpu" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " wasm" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " webgl" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " humangl" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " tensorflow" < / span > < / div >
2021-04-10 03:53:48 +02:00
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Backend used for TFJS operations< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "body" class = "tsd-anchor" > < / a >
< h3 > body< / h3 >
< div class = "tsd-signature tsd-kind-icon" > body< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > { < / span > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > maxDetections< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > modelPath< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > nmsRadius< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > scoreThreshold< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > }< / span > < / div >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Controlls and configures all body detection specific options< / p >
< ul >
< li > enabled: true/false< / li >
< li > modelPath: paths for both hand detector model and hand skeleton model< / li >
< li > maxDetections: maximum number of people detected in the input, should be set to the minimum number for performance< / li >
< li > scoreThreshold: threshold for deciding when to remove people based on score in non-maximum suppression< / li >
< li > nmsRadius: threshold for deciding whether body parts overlap too much in non-maximum suppression< / li >
< / ul >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > max< wbr > Detections< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > model< wbr > Path< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > nms< wbr > Radius< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > score< wbr > Threshold< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< / ul >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "deallocate" class = "tsd-anchor" > < / a >
< h3 > deallocate< / h3 >
< div class = "tsd-signature tsd-kind-icon" > deallocate< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Internal: Use aggressive GPU memory deallocator when backend is set to < code > webgl< / code > or < code > humangl< / code > < / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "debug" class = "tsd-anchor" > < / a >
< h3 > debug< / h3 >
< div class = "tsd-signature tsd-kind-icon" > debug< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Print debug statements to console< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "face" class = "tsd-anchor" > < / a >
< h3 > face< / h3 >
< div class = "tsd-signature tsd-kind-icon" > face< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > { < / span > age< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > modelPath< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > skipFrames< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > ; < / span > description< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > modelPath< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > skipFrames< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > ; < / span > detector< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > iouThreshold< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > maxFaces< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > minConfidence< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > modelPath< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > return< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > rotation< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > scoreThreshold< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > skipFrames< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > skipInitial< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > ; < / span > embedding< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > modelPath< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > ; < / span > emotion< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > minConfidence< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > modelPath< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > skipFrames< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > ; < / span > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > gender< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > enab
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< 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 individual face model< / 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 > maxFaces: maximum number of faces detected in the input, should be set to the minimum number for performance< / li >
< li > skipFrames: how many frames to go without re-running the face detector and just run modified face mesh analysis, only valid if videoOptimized is set to true< / li >
< li > skipInitial: if previous detection resulted in no faces detected, should skipFrames be reset immediately to force new detection cycle< / li >
< li > minConfidence: threshold for discarding a prediction< / li >
< li > iouThreshold: threshold for deciding whether boxes overlap too much in non-maximum suppression< / li >
< li > scoreThreshold: threshold for deciding when to remove boxes based on score in non-maximum suppression< / li >
< li > return extracted face as tensor for futher user processing< / li >
< / ul >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > age< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > modelPath< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > skipFrames< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > }< / span > < / h5 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > model< wbr > Path< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > skip< wbr > Frames< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< / ul >
< / li >
< li class = "tsd-parameter" >
< h5 > description< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > modelPath< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > skipFrames< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > }< / span > < / h5 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > model< wbr > Path< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > skip< wbr > Frames< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< / ul >
< / li >
< li class = "tsd-parameter" >
< h5 > detector< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > iouThreshold< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > maxFaces< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > minConfidence< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > modelPath< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > return< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > rotation< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > scoreThreshold< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > skipFrames< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > skipInitial< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > }< / span > < / h5 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > iou< wbr > Threshold< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > max< wbr > Faces< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > min< wbr > Confidence< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > model< wbr > Path< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > return< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > rotation< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > score< wbr > Threshold< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > skip< wbr > Frames< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > skip< wbr > Initial< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< / ul >
< / li >
< li class = "tsd-parameter" >
< h5 > embedding< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > modelPath< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > }< / span > < / h5 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > model< wbr > Path< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< / ul >
< / li >
< li class = "tsd-parameter" >
< h5 > emotion< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > minConfidence< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > modelPath< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > skipFrames< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > }< / span > < / h5 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > min< wbr > Confidence< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > model< wbr > Path< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > skip< wbr > Frames< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< / ul >
< / li >
< li class = "tsd-parameter" >
< h5 > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > gender< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > minConfidence< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > modelPath< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > skipFrames< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > }< / span > < / h5 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > min< wbr > Confidence< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > model< wbr > Path< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > skip< wbr > Frames< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< / ul >
< / li >
< li class = "tsd-parameter" >
< h5 > iris< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > modelPath< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > }< / span > < / h5 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > model< wbr > Path< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< / ul >
< / li >
< li class = "tsd-parameter" >
< h5 > mesh< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > modelPath< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > }< / span > < / h5 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > model< wbr > Path< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "filter" class = "tsd-anchor" > < / a >
< h3 > filter< / h3 >
2021-04-19 22:19:03 +02:00
< div class = "tsd-signature tsd-kind-icon" > filter< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > { < / span > blur< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > brightness< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > contrast< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > flip< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > height< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > hue< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > kodachrome< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > negative< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > pixelate< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > polaroid< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > return< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > saturation< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > sepia< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > sharpness< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > technicolor< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > vintage< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > width< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > }< / span > < / div >
2021-04-10 03:53:48 +02:00
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Run input through image filters before inference< / p >
< ul >
< li > image filters run with near-zero latency as they are executed on the GPU< / li >
< / ul >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > blur< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Range: 0 (no blur) to N (blur radius in pixels)< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / li >
< li class = "tsd-parameter" >
< h5 > brightness< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Range: -1 (darken) to 1 (lighten)< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / li >
< li class = "tsd-parameter" >
< h5 > contrast< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Range: -1 (reduce contrast) to 1 (increase contrast)< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / li >
< li class = "tsd-parameter" >
< h5 > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
2021-04-19 22:19:03 +02:00
< li class = "tsd-parameter" >
< h5 > flip< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Flip input as mirror image< / p >
< / div >
< / div >
< / li >
2021-04-10 03:53:48 +02:00
< li class = "tsd-parameter" >
< h5 > height< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Resize input height< / p >
< ul >
< li > if both width and height are set to 0, there is no resizing< / li >
< li > if just one is set, second one is scaled automatically< / li >
< li > if both are set, values are used as-is< / li >
< / ul >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / li >
< li class = "tsd-parameter" >
< h5 > hue< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Range: 0 (no change) to 360 (hue rotation in degrees)< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / li >
< li class = "tsd-parameter" >
< h5 > kodachrome< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Image kodachrome colors< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / li >
< li class = "tsd-parameter" >
< h5 > negative< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Image negative< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / li >
< li class = "tsd-parameter" >
< h5 > pixelate< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Range: 0 (no pixelate) to N (number of pixels to pixelate)< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / li >
< li class = "tsd-parameter" >
< h5 > polaroid< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Image polaroid camera effect< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / li >
< li class = "tsd-parameter" >
< h5 > return< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Return processed canvas imagedata in result< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / li >
< li class = "tsd-parameter" >
< h5 > saturation< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Range: -1 (reduce saturation) to 1 (increase saturation)< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / li >
< li class = "tsd-parameter" >
< h5 > sepia< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Image sepia colors< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / li >
< li class = "tsd-parameter" >
< h5 > sharpness< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Range: 0 (no sharpening) to 1 (maximum sharpening)< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / li >
< li class = "tsd-parameter" >
< h5 > technicolor< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Image technicolor colors< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / li >
< li class = "tsd-parameter" >
< h5 > vintage< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Image vintage colors< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / li >
< li class = "tsd-parameter" >
< h5 > width< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Resize input width< / p >
< ul >
< li > if both width and height are set to 0, there is no resizing< / li >
< li > if just one is set, second one is scaled automatically< / li >
< li > if both are set, values are used as-is< / li >
< / ul >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / li >
< / ul >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "gesture" class = "tsd-anchor" > < / a >
< h3 > gesture< / h3 >
< div class = "tsd-signature tsd-kind-icon" > gesture< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > { < / span > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > }< / span > < / div >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Controlls gesture detection< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< / ul >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "hand" class = "tsd-anchor" > < / a >
< h3 > hand< / h3 >
< div class = "tsd-signature tsd-kind-icon" > hand< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > { < / span > detector< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > modelPath< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > ; < / span > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > iouThreshold< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > landmarks< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > maxHands< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > minConfidence< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > rotation< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > scoreThreshold< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > skeleton< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > modelPath< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > ; < / span > skipFrames< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > skipInitial< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > }< / span > < / div >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Controlls and configures all hand detection specific options< / p >
< ul >
< li > enabled: true/false< / li >
< li > modelPath: paths for both hand detector model and hand skeleton model< / li >
< li > rotation: use best-guess rotated hand image or just box with rotation as-is, false means higher performance, but incorrect finger mapping if hand is inverted< / li >
< li > skipFrames: how many frames to go without re-running the hand bounding box detector and just run modified hand skeleton detector, only valid if videoOptimized is set to true< / li >
< li > skipInitial: if previous detection resulted in no hands detected, should skipFrames be reset immediately to force new detection cycle< / li >
< li > minConfidence: threshold for discarding a prediction< / li >
< li > iouThreshold: threshold for deciding whether boxes overlap too much in non-maximum suppression< / li >
< li > scoreThreshold: threshold for deciding when to remove boxes based on score in non-maximum suppression< / li >
< li > maxHands: maximum number of hands detected in the input, should be set to the minimum number for performance< / li >
< li > landmarks: detect hand landmarks or just hand boundary box< / li >
< / ul >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > detector< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > modelPath< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > }< / span > < / h5 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > model< wbr > Path< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< / ul >
< / li >
< li class = "tsd-parameter" >
< h5 > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > iou< wbr > Threshold< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > landmarks< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > max< wbr > Hands< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > min< wbr > Confidence< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > rotation< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > score< wbr > Threshold< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > skeleton< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > modelPath< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > }< / span > < / h5 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > model< wbr > Path< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< / ul >
< / li >
< li class = "tsd-parameter" >
< h5 > skip< wbr > Frames< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > skip< wbr > Initial< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< / ul >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "modelbasepath" class = "tsd-anchor" > < / a >
< h3 > model< wbr > Base< wbr > Path< / h3 >
< div class = "tsd-signature tsd-kind-icon" > model< wbr > Base< wbr > Path< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Base model path (typically starting with file://, http:// or https://) for all models< / p >
< ul >
< li > individual modelPath values are joined to this path< / li >
< / ul >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "object" class = "tsd-anchor" > < / a >
< h3 > object< / h3 >
< div class = "tsd-signature tsd-kind-icon" > object< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > { < / span > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > iouThreshold< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > maxResults< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > minConfidence< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > modelPath< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > skipFrames< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > }< / span > < / div >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Controlls and configures all object detection specific options< / p >
< ul >
< li > minConfidence: minimum score that detection must have to return as valid object< / li >
< li > iouThreshold: ammount of overlap between two detected objects before one object is removed< / li >
< li > maxResults: maximum number of detections to return< / li >
< li > skipFrames: run object detection every n input frames, only valid if videoOptimized is set to true< / li >
< / ul >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > enabled< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > iou< wbr > Threshold< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > max< wbr > Results< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > min< wbr > Confidence< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > model< wbr > Path< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > skip< wbr > Frames< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< / ul >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "profile" class = "tsd-anchor" > < / a >
< h3 > profile< / h3 >
< div class = "tsd-signature tsd-kind-icon" > profile< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Collect and print profiling data during inference operations< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "scoped" class = "tsd-anchor" > < / a >
< h3 > scoped< / h3 >
< div class = "tsd-signature tsd-kind-icon" > scoped< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Internal: Run all inference operations in an explicit local scope run to avoid memory leaks< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "videooptimized" class = "tsd-anchor" > < / a >
< h3 > video< wbr > Optimized< / h3 >
< div class = "tsd-signature tsd-kind-icon" > video< wbr > Optimized< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Perform additional optimizations when input is video,< / p >
< ul >
< li > must be disabled for images< / li >
< li > automatically disabled for Image, ImageData, ImageBitmap and Tensor inputs< / li >
< li > skips boundary detection for every < code > skipFrames< / code > frames specified for each model< / li >
< li > while maintaining in-box detection since objects don' t change definition as fast< / li >
< / ul >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "warmup" class = "tsd-anchor" > < / a >
< h3 > warmup< / h3 >
2021-04-13 17:05:52 +02:00
< div class = "tsd-signature tsd-kind-icon" > warmup< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > " none" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " face" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " full" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " body" < / span > < / div >
2021-04-10 03:53:48 +02:00
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > What to use for < code > human.warmup()< / code > < / p >
< ul >
< li > warmup pre-initializes all models for faster inference but can take significant time on startup< / li >
< li > only used for < code > webgl< / code > and < code > humangl< / code > backends< / li >
< / ul >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "wasmpath" class = "tsd-anchor" > < / a >
< h3 > wasm< wbr > Path< / h3 >
< div class = "tsd-signature tsd-kind-icon" > wasm< wbr > Path< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Path to *.wasm files if backend is set to < code > wasm< / code > < / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / 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 >
< / ul >
< ul class = "current" >
< li class = "current tsd-kind-interface" >
< a href = "config.html" class = "tsd-kind-icon" > Config< / a >
< ul >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "config.html#async" class = "tsd-kind-icon" > async< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "config.html#backend" class = "tsd-kind-icon" > backend< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "config.html#body" class = "tsd-kind-icon" > body< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "config.html#deallocate" class = "tsd-kind-icon" > deallocate< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "config.html#debug" class = "tsd-kind-icon" > debug< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "config.html#face" class = "tsd-kind-icon" > face< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "config.html#filter" class = "tsd-kind-icon" > filter< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "config.html#gesture" class = "tsd-kind-icon" > gesture< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "config.html#hand" class = "tsd-kind-icon" > hand< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "config.html#modelbasepath" class = "tsd-kind-icon" > model< wbr > Base< wbr > Path< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "config.html#object" class = "tsd-kind-icon" > object< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "config.html#profile" class = "tsd-kind-icon" > profile< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "config.html#scoped" class = "tsd-kind-icon" > scoped< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "config.html#videooptimized" class = "tsd-kind-icon" > video< wbr > Optimized< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "config.html#warmup" class = "tsd-kind-icon" > warmup< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "config.html#wasmpath" class = "tsd-kind-icon" > wasm< wbr > Path< / a >
< / li >
< / ul >
< / li >
< / ul >
< ul class = "after-current" >
2021-04-13 17:05:52 +02:00
< li class = " tsd-kind-interface" >
< a href = "drawoptions.html" class = "tsd-kind-icon" > Draw< wbr > Options< / a >
< / li >
2021-04-10 03:53:48 +02:00
< li class = " tsd-kind-interface" >
< a href = "result.html" class = "tsd-kind-icon" > Result< / a >
< / li >
< li class = " tsd-kind-type-alias" >
< a href = "../index.html#error" class = "tsd-kind-icon" > Error< / 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#tensor" class = "tsd-kind-icon" > Tensor< / a >
< / li >
< li class = " tsd-kind-type-alias" >
< a href = "../index.html#tensorflow" class = "tsd-kind-icon" > Tensor< wbr > Flow< / a >
< / li >
< / 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 >
