2021-10-19 14:09:46 +02:00
<!DOCTYPE html> < html class = "default no-js" > < head > < meta charSet = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > HandConfig | @vladmandic/human - v2.3.4< / title > < meta name = "description" content = "Documentation for @vladmandic/human - v2.3.4" / > < meta name = "viewport" content = "width=device-width, initial-scale=1" / > < link rel = "stylesheet" href = "../assets/style.css" / > < link rel = "stylesheet" href = "../assets/highlight.css" / > < script async src = "../assets/search.js" id = "search-script" > < / script > < / head > < body > < script > document . body . classList . add ( localStorage . getItem ( & quot ; tsd - theme & quot ; ) || & quot ; os & quot ; ) < / script > < header > < div class = "tsd-page-toolbar" > < div class = "container" > < div class = "table-wrap" > < div class = "table-cell" id = "tsd-search" data-base = ".." > < div class = "field" > < label for = "tsd-search-field" class = "tsd-widget search no-caption" > Search< / label > < input type = "text" id = "tsd-search-field" / > < / 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 - v2.3.4< / 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 - v2.3.4< / a > < / li > < li > < a href = "HandConfig.html" > HandConfig< / a > < / li > < / ul > < h1 > Interface HandConfig< / 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" >
2021-09-19 01:09:02 +02:00
< p > Controlls and configures all hand detection specific options< / p >
2021-09-22 22:00:43 +02:00
< / div > < div > < p > Parameters:< / p >
2021-09-19 01:09:02 +02:00
< ul >
< li > enabled: true/false< / li >
< li > landmarks: detect hand landmarks or just hand boundary box< / li >
< li > modelPath: paths for hand detector and hand skeleton models, can be absolute path or relative to modelBasePath< / 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 hands detected in the input, should be set to the minimum number for performance< / 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 >
< / ul >
2021-09-26 01:14:03 +02:00
< p > < code > maxDetected< / code > can be set to -1 to auto-detect based on number of detected faces< / p >
2021-09-22 22:00:43 +02:00
< p > Changing < code > detector.modelPath< / code > will change module responsible for hand detection and tracking
Allowed values are < code > handdetect.json< / code > and < code > handtrack.json< / code > < / p >
2021-10-19 13:58:51 +02:00
< / div > < / div > < / section > < section class = "tsd-panel tsd-hierarchy" > < h3 > Hierarchy< / h3 > < ul class = "tsd-hierarchy" > < li > < span class = "target" > HandConfig< / 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 = "HandConfig.html#detector" class = "tsd-kind-icon" > detector< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "HandConfig.html#enabled" class = "tsd-kind-icon" > enabled< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "HandConfig.html#iouThreshold" class = "tsd-kind-icon" > iou< wbr / > Threshold< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "HandConfig.html#landmarks" class = "tsd-kind-icon" > landmarks< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "HandConfig.html#maxDetected" class = "tsd-kind-icon" > max< wbr / > Detected< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "HandConfig.html#minConfidence" class = "tsd-kind-icon" > min< wbr / > Confidence< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "HandConfig.html#rotation" class = "tsd-kind-icon" > rotation< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "HandConfig.html#skeleton" class = "tsd-kind-icon" > skeleton< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "HandConfig.html#skipFrames" class = "tsd-kind-icon" > skip< wbr / > Frames< / 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 id = "detector" class = "tsd-anchor" > < / a > < h3 > detector< / h3 > < div class = "tsd-signature tsd-kind-icon" > 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 > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L124" > config.ts:124< / a > < / li > < / ul > < / aside > < div class = "tsd-type-declaration" > < h4 > Type declaration< / h4 > < ul class = "tsd-parameters" > < li class = "tsd-parameter" > < h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > model< wbr / > Path< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < / h5 > < / li > < / ul > < / div > < / section > < section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" > < a id = "enabled" class = "tsd-anchor" > < / a > < 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 > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L117" > config.ts:117< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" > < a id = "iouThreshold" class = "tsd-anchor" > < / a > < h3 > iou< wbr / > Threshold< / h3 > < div class = "tsd-signature tsd-kind-icon" > iou< wbr / > Threshold< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > number< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L121" > config.ts:121< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" > < a id = "landmarks" class = "tsd-anchor" > < / a > < h3 > landmarks< / h3 > < div class = "tsd-signature tsd-kind-icon" > landmarks< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L123" > config.ts:123< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" > < a id = "maxDetected" class =
