2023-12-06 21:00:47 +01:00
<!DOCTYPE html> < html class = "default" lang = "en" > < head > < meta charSet = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > Human | @vladmandic/human - v3.2.0< / title > < meta name = "description" content = "Documentation for @vladmandic/human" / > < 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 defer src = "../assets/main.js" > < / script > < script async src = "../assets/search.js" id = "tsd-search-script" > < / script > < script async src = "../assets/navigation.js" id = "tsd-nav-script" > < / script > < / head > < body > < script > document . documentElement . dataset . theme = localStorage . getItem ( "tsd-theme" ) || "os" < / script > < header class = "tsd-page-toolbar" > < div class = "tsd-toolbar-contents container" > < div class = "table-cell" id = "tsd-search" data-base = ".." > < div class = "field" > < label for = "tsd-search-field" class = "tsd-widget tsd-toolbar-icon search no-caption" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" > < use href = "#icon-search" > < / use > < / svg > < / label > < input type = "text" id = "tsd-search-field" aria-label = "Search" / > < / div > < div class = "field" > < div id = "tsd-toolbar-links" > < / div > < / 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 - v3.2.0< / a > < / div > < div class = "table-cell" id = "tsd-widgets" > < a href = "#" class = "tsd-widget tsd-toolbar-icon menu no-caption" data-toggle = "menu" aria-label = "Menu" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" > < use href = "#icon-menu" > < / use > < / svg > < / a > < / div > < / div > < / header > < div class = "container container-main" > < div class = "col-content" > < div class = "tsd-page-title" > < ul class = "tsd-breadcrumb" > < li > < a href = "../index.html" > @vladmandic/human< / a > < / li > < li > < a href = "Human.html" > Human< / a > < / li > < / ul > < h1 > Class Human< / h1 > < / div > < section class = "tsd-panel tsd-comment" > < div class = "tsd-comment tsd-typography" > < p > < em > Human< / em > * library main class< / p >
2022-11-18 17:13:29 +01:00
< p > All methods and properties are available only as members of Human class< / p >
< ul >
2023-12-06 21:00:47 +01:00
< li > Configuration object definition: < a href = "../interfaces/Config.html" class = "tsd-kind-interface" > Config< / a > < / li >
< li > Results object definition: < a href = "../interfaces/Result.html" class = "tsd-kind-interface" > Result< / a > < / li >
< li > Possible inputs: < a href = "../types/Input.html" class = "tsd-kind-type-alias" > Input< / a > < / li >
2022-11-18 17:13:29 +01:00
< / ul >
2023-12-06 21:00:47 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < h4 > Param: userConfig< / h4 > < p > < a href = "../interfaces/Config.html" class = "tsd-kind-interface" > Config< / a > < / p >
< h4 > Returns< / h4 > < p > instance of < a href = "Human.html" class = "tsd-kind-class" > Human< / a > < / p >
< / div > < / section > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L58" > src/human.ts:58< / a > < / li > < / ul > < / aside > < section class = "tsd-panel-group tsd-index-group" > < section class = "tsd-panel tsd-index-panel" > < details class = "tsd-index-content tsd-index-accordion" open > < summary class = "tsd-accordion-summary tsd-index-summary" > < h5 class = "tsd-index-heading uppercase" role = "button" aria-expanded = "false" tabIndex = "0" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" > < use href = "#icon-chevronSmall" > < / use > < / svg > Index< / h5 > < / summary > < div class = "tsd-accordion-details" > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Constructors< / h3 > < div class = "tsd-index-list" > < a href = "Human.html#constructor" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-512" > < / use > < / svg > < span > constructor< / span > < / a >
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Properties< / h3 > < div class = "tsd-index-list" > < a href = "Human.html#config" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > config< / span > < / a >
< a href = "Human.html#draw" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > draw< / span > < / a >
< a href = "Human.html#env" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > env< / span > < / a >
< a href = "Human.html#events" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > events< / span > < / a >
< a href = "Human.html#faceTriangulation" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > face< wbr / > Triangulation< / span > < / a >
< a href = "Human.html#faceUVMap" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > faceUVMap< / span > < / a >
< a href = "Human.html#match" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > match< / span > < / a >
< a href = "Human.html#performance" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > performance< / span > < / a >
< a href = "Human.html#process" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > process< / span > < / a >
< a href = "Human.html#result" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > result< / span > < / a >
< a href = "Human.html#state" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > state< / span > < / a >
< a href = "Human.html#tf" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > tf< / span > < / a >
< a href = "Human.html#version" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > version< / span > < / a >
< a href = "Human.html#webcam" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > webcam< / span > < / a >
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Methods< / h3 > < div class = "tsd-index-list" > < a href = "Human.html#analyze" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > analyze< / span > < / a >
< a href = "Human.html#compare" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > compare< / span > < / a >
< a href = "Human.html#detect" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > detect< / span > < / a >
< a href = "Human.html#emit" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > emit< / span > < / a >
< a href = "Human.html#image" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > image< / span > < / a >
< a href = "Human.html#init" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > init< / span > < / a >
< a href = "Human.html#load" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > load< / span > < / a >
< a href = "Human.html#next" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > next< / span > < / a >
< a href = "Human.html#now" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > now< / span > < / a >
< a href = "Human.html#profile" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > profile< / span > < / a >
< a href = "Human.html#reset" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > reset< / span > < / a >
< a href = "Human.html#segmentation" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > segmentation< / span > < / a >
< a href = "Human.html#sleep" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > sleep< / span > < / a >
< a href = "Human.html#validate" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > validate< / span > < / a >
< a href = "Human.html#video" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > video< / span > < / a >
< a href = "Human.html#warmup" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > warmup< / span > < / a >
< / div > < / section > < / div > < / details > < / section > < / section > < section class = "tsd-panel-group tsd-member-group" > < h2 > Constructors< / h2 > < section class = "tsd-panel tsd-member" > < a id = "constructor" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > constructor< / span > < a href = "#constructor" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "constructor.new_Human" class = "tsd-anchor" > < / a > < span class = "tsd-kind-constructor-signature" > new < wbr / > Human< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > userConfig< / span > < span class = "tsd-signature-symbol" > ?< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "Human.html" class = "tsd-signature-type tsd-kind-class" > Human< / a > < a href = "#constructor.new_Human" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Constructor for < strong > Human< / strong > library that is futher used for all operations< / p >
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < h5 > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span class = "tsd-kind-parameter" > userConfig< / span > : < span class = "tsd-signature-type " > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../interfaces/Config.html" class = "tsd-signature-type tsd-kind-interface" > Config< / a > < span class = "tsd-signature-symbol" > > < / span > < / h5 > < div class = "tsd-comment tsd-typography" > < p > user configuration object < a href = "../interfaces/Config.html" class = "tsd-kind-interface" > Config< / a > < / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < a href = "Human.html" class = "tsd-signature-type tsd-kind-class" > Human< / a > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L135" > src/human.ts:135< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < / section > < section class = "tsd-panel-group tsd-member-group" > < h2 > Properties< / h2 > < section class = "tsd-panel tsd-member" > < a id = "config" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > config< / span > < a href = "#config" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > config< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "../interfaces/Config.html" class = "tsd-signature-type tsd-kind-interface" > Config< / a > < / div > < div class = "tsd-comment tsd-typography" > < p > Current configuration< / p >
2022-11-18 17:13:29 +01:00
< ul >
< li > Defaults: < a href = "https://github.com/vladmandic/human/blob/main/src/config.ts#L262" > config< / a > < / li >
< / ul >
2023-12-06 21:00:47 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L65" > src/human.ts:65< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "draw" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > draw< / span > < a href = "#draw" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > draw< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "../modules/draw.html" class = "tsd-signature-type tsd-kind-namespace" > draw< / a > < span class = "tsd-signature-symbol" > = draw< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Draw helper classes that can draw detected objects on canvas using specified draw< / p >
2022-11-18 17:13:29 +01:00
< ul >
< li > canvas: draws input to canvas< / li >
2023-12-06 21:00:47 +01:00
< li > options: are global settings for all draw operations, can be overriden for each draw method < a href = "../interfaces/DrawOptions.html" class = "tsd-kind-interface" > DrawOptions< / a > < / li >
2022-11-18 17:13:29 +01:00
< li > face, body, hand, gesture, object, person: draws detected results as overlays on canvas< / li >
< / ul >
2023-12-06 21:00:47 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L96" > src/human.ts:96< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "env" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > env< / span > < a href = "#env" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > env< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "Env.html" class = "tsd-signature-type tsd-kind-class" > Env< / a > < span class = "tsd-signature-symbol" > = env< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Object containing environment information used for diagnostics< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L88" > src/human.ts:88< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "events" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > events< / span > < a href = "#events" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > events< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > undefined< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type " > EventTarget< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Container for events dispatched by Human
2022-11-18 17:13:29 +01:00
Possible events:< / p >
< ul >
< li > < code > create< / code > : triggered when Human object is instantiated< / li >
< li > < code > load< / code > : triggered when models are loaded (explicitly or on-demand)< / li >
< li > < code > image< / code > : triggered when input image is processed< / li >
< li > < code > result< / code > : triggered when detection is complete< / li >
< li > < code > warmup< / code > : triggered when warmup is complete< / li >
< li > < code > error< / code > : triggered on some errors< / li >
< / ul >
2023-12-06 21:00:47 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L120" > src/human.ts:120< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "faceTriangulation" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > face< wbr / > Triangulation< / span > < a href = "#faceTriangulation" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > face< wbr / > Triangulation< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > []< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Reference face triangualtion array of 468 points, used for triangle references between points< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L122" > src/human.ts:122< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "faceUVMap" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > faceUVMap< / span > < a href = "#faceUVMap" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > faceUVMap< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > [< / span > < span class = "tsd-signature-type" > number< / span > < 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 > < / div > < div class = "tsd-comment tsd-typography" > < p > Refernce UV map of 468 values, used for 3D mapping of the face mesh< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L124" > src/human.ts:124< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "match" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > match< / span > < a href = "#match" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > match< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "../modules/match.html" class = "tsd-signature-type tsd-kind-namespace" > match< / a > < span class = "tsd-signature-symbol" > = match< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Face Matching< / p >
2022-11-18 17:13:29 +01:00
< ul >
< li > similarity: compare two face descriptors and return similarity index< / li >
< li > distance: compare two face descriptors and return raw calculated differences< / li >
< li > find: compare face descriptor to array of face descriptors and return best match< / li >
< / ul >
2023-12-06 21:00:47 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L103" > src/human.ts:103< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "performance" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > performance< / span > < a href = "#performance" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > performance< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type " > Record< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > , < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > > < / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Performance object that contains values for all recently performed operations< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L126" > src/human.ts:126< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "process" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > process< / span > < a href = "#process" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > process< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > { < / span > < br / > < span > < / span > < span class = "tsd-kind-property" > canvas< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../types/AnyCanvas.html" class = "tsd-signature-type tsd-kind-type-alias" > AnyCanvas< / a > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < span class = "tsd-kind-property" > tensor< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "Tensor-1.html" class = "tsd-signature-type tsd-kind-class" > Tensor< / a > < span class = "tsd-signature-symbol" > < < / span > < a href = "../enums/Rank.html" class = "tsd-signature-type tsd-kind-enum" > Rank< / a > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span class = "tsd-signature-symbol" > }< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > currenty processed image tensor and canvas< / p >
< / div > < div class = "tsd-type-declaration" > < h4 > Type declaration< / h4 > < ul class = "tsd-parameters" > < li class = "tsd-parameter" > < h5 > < span class = "tsd-kind-property" > canvas< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../types/AnyCanvas.html" class = "tsd-signature-type tsd-kind-type-alias" > AnyCanvas< / a > < / h5 > < / li > < li class = "tsd-parameter" > < h5 > < span class = "tsd-kind-property" > tensor< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "Tensor-1.html" class = "tsd-signature-type tsd-kind-class" > Tensor< / a > < span class = "tsd-signature-symbol" > < < / span > < a href = "../enums/Rank.html" class = "tsd-signature-type tsd-kind-enum" > Rank< / a > < span class = "tsd-signature-symbol" > > < / span > < / h5 > < / li > < / ul > < / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L79" > src/human.ts:79< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "result" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > result< / span > < a href = "#result" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > result< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "../interfaces/Result.html" class = "tsd-signature-type tsd-kind-interface" > Result< / a > < / div > < div class = "tsd-comment tsd-typography" > < p > Last known result of detect run< / p >
2022-11-18 17:13:29 +01:00
< ul >
< li > Can be accessed anytime after initial detection< / li >
< / ul >
2023-12-06 21:00:47 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L70" > src/human.ts:70< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "state" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > state< / span > < a href = "#state" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > state< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Current state of Human library< / p >
2022-11-18 17:13:29 +01:00
< ul >
< li > Can be polled to determine operations that are currently executed< / li >
< li > Progresses through: ' config' , ' check' , ' backend' , ' load' , ' run:< model > ' , ' idle' < / li >
< / ul >
2023-12-06 21:00:47 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L76" > src/human.ts:76< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "tf" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > tf< / span > < a href = "#tf" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > tf< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > any< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Instance of TensorFlow/JS used by Human< / p >
2022-11-18 17:13:29 +01:00
< ul >
< li > Can be embedded or externally provided
< a href = "https://js.tensorflow.org/api/latest/" > TFJS API< / a > < / li >
< / ul >
2023-12-06 21:00:47 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L85" > src/human.ts:85< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "version" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > version< / span > < a href = "#version" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > version< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > Current version of Human library in < em > semver< / em > format< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L60" > src/human.ts:60< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "webcam" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > webcam< / span > < a href = "#webcam" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > webcam< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "WebCam.html" class = "tsd-signature-type tsd-kind-class" > WebCam< / a > < span class = "tsd-signature-symbol" > = ...< / span > < / div > < div class = "tsd-comment tsd-typography" > < p > WebCam helper methods< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L279" > src/human.ts:279< / a > < / li > < / ul > < / aside > < / section > < / section > < section class = "tsd-panel-group tsd-member-group" > < h2 > Methods< / h2 > < section class = "tsd-panel tsd-member" > < a id = "analyze" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > analyze< / span > < a href = "#analyze" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "analyze.analyze-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > analyze< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > < span class = "tsd-kind-parameter" > msg< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < a href = "#analyze.analyze-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > internal function to measure tensor leaks< / p >
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < h5 > < code class = "tsd-tag ts-flagRest" > Rest< / code > < span class = "tsd-signature-symbol" > ...< / span > < span class = "tsd-kind-parameter" > msg< / span > : < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L182" > src/human.ts:182< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "compare" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > compare< / span > < a href = "#compare" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "compare.compare-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > compare< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > firstImageTensor< / span > , < span class = "tsd-kind-parameter" > secondImageTensor< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > > < / span > < a href = "#compare.compare-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Compare two input tensors for pixel similarity< / p >
2022-11-18 17:13:29 +01:00
< ul >
< li > use < code > human.image< / code > to process any valid input and get a tensor that can be used for compare< / li >
< li > when passing manually generated tensors:< / li >
< li > both input tensors must be in format [1, height, width, 3]< / li >
< li > if resolution of tensors does not match, second tensor will be resized to match resolution of the first tensor< / li >
< li > return value is pixel similarity score normalized by input resolution and rgb channels< / li >
< / ul >
2023-12-06 21:00:47 +01:00
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < h5 > < span class = "tsd-kind-parameter" > firstImageTensor< / span > : < a href = "Tensor-1.html" class = "tsd-signature-type tsd-kind-class" > Tensor< / a > < span class = "tsd-signature-symbol" > < < / span > < a href = "../enums/Rank.html" class = "tsd-signature-type tsd-kind-enum" > Rank< / a > < span class = "tsd-signature-symbol" > > < / span > < / h5 > < / li > < li > < h5 > < span class = "tsd-kind-parameter" > secondImageTensor< / span > : < a href = "Tensor-1.html" class = "tsd-signature-type tsd-kind-class" > Tensor< / a > < span class = "tsd-signature-symbol" > < < / span > < a href = "../enums/Rank.html" class = "tsd-signature-type tsd-kind-enum" > Rank< / a > < span class = "tsd-signature-symbol" > > < / span > < / h5 > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L261" > src/human.ts:261< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "detect" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > detect< / span > < a href = "#detect" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "detect.detect-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > detect< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > input< / span > , < span class = "tsd-kind-parameter" > userConfig< / span > < span class = "tsd-signature-symbol" > ?< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../interfaces/Result.html" class = "tsd-signature-type tsd-kind-interface" > Result< / a > < span class = "tsd-signature-symbol" > > < / span > < a href = "#detect.detect-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Main detection method< / p >
2022-11-18 17:13:29 +01:00
< ul >
2023-12-06 21:00:47 +01:00
< li > Analyze configuration: < a href = "../interfaces/Config.html" class = "tsd-kind-interface" > Config< / a > < / li >
< li > Pre-process input: < a href = "../types/Input.html" class = "tsd-kind-type-alias" > Input< / a > < / li >
2022-11-18 17:13:29 +01:00
< li > Run inference for all configured models< / li >
2023-12-06 21:00:47 +01:00
< li > Process and return result: < a href = "../interfaces/Result.html" class = "tsd-kind-interface" > Result< / a > < / li >
2022-11-18 17:13:29 +01:00
< / ul >
2023-12-06 21:00:47 +01:00
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < h5 > < span class = "tsd-kind-parameter" > input< / span > : < a href = "../types/Input.html" class = "tsd-signature-type tsd-kind-type-alias" > Input< / a > < / h5 > < div class = "tsd-comment tsd-typography" > < p > < a href = "../types/Input.html" class = "tsd-kind-type-alias" > Input< / a > < / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < li > < h5 > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span class = "tsd-kind-parameter" > userConfig< / span > : < span class = "tsd-signature-type " > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../interfaces/Config.html" class = "tsd-signature-type tsd-kind-interface" > Config< / a > < span class = "tsd-signature-symbol" > > < / span > < / h5 > < div class = "tsd-comment tsd-typography" > < p > < a href = "../interfaces/Config.html" class = "tsd-kind-interface" > Config< / a > < / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../interfaces/Result.html" class = "tsd-signature-type tsd-kind-interface" > Result< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < p > result - < a href = "../interfaces/Result.html" class = "tsd-kind-interface" > Result< / a > < / p >
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L379" > src/human.ts:379< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "emit" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > emit< / span > < a href = "#emit" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "emit.emit-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > emit< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > event< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < a href = "#emit.emit-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > emit event< / p >
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < h5 > < span class = "tsd-kind-parameter" > event< / span > : < span class = "tsd-signature-type" > string< / span > < / h5 > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L315" > src/human.ts:315< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "image" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > image< / span > < a href = "#image" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "image.image-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > image< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > input< / span > , < span class = "tsd-kind-parameter" > getTensor< / span > < span class = "tsd-signature-symbol" > ?< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-symbol" > { < / span > < br / > < span > < / span > < span class = "tsd-kind-property" > canvas< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../types/AnyCanvas.html" class = "tsd-signature-type tsd-kind-type-alias" > AnyCanvas< / a > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < span class = "tsd-kind-property" > tensor< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../types/Tensor4D.html" class = "tsd-signature-type tsd-kind-type-alias" > Tensor4D< / a > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > > < / span > < a href = "#image.image-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Process input as return canvas and tensor< / p >
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < h5 > < span class = "tsd-kind-parameter" > input< / span > : < a href = "../types/Input.html" class = "tsd-signature-type tsd-kind-type-alias" > Input< / a > < / h5 > < div class = "tsd-comment tsd-typography" > < p > any input < a href = "../types/Input.html" class = "tsd-kind-type-alias" > Input< / a > < / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < li > < h5 > < span class = "tsd-kind-parameter" > getTensor< / span > : < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > = false< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < p > should image processing also return tensor or just canvas
2022-11-18 17:13:29 +01:00
Returns object with < code > tensor< / code > and < code > canvas< / code > < / p >
2023-12-06 21:00:47 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-symbol" > { < / span > < br / > < span > < / span > < span class = "tsd-kind-property" > canvas< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../types/AnyCanvas.html" class = "tsd-signature-type tsd-kind-type-alias" > AnyCanvas< / a > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < span class = "tsd-kind-property" > tensor< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../types/Tensor4D.html" class = "tsd-signature-type tsd-kind-type-alias" > Tensor4D< / a > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L231" > src/human.ts:231< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "init" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > init< / span > < a href = "#init" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "init.init-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > init< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < a href = "#init.init-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Explicit backend initialization< / p >
2022-11-18 17:13:29 +01:00
< ul >
< li > Normally done implicitly during initial load phase< / li >
< li > Call to explictly register and initialize TFJS backend without any other operations< / li >
< li > Use when changing backend during runtime< / li >
< / ul >
2023-12-06 21:00:47 +01:00
< / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L270" > src/human.ts:270< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "load" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > load< / span > < a href = "#load" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "load.load-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > load< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > userConfig< / span > < span class = "tsd-signature-symbol" > ?< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < a href = "#load.load-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Load method preloads all configured models on-demand< / p >
2022-11-18 17:13:29 +01:00
< ul >
< li > Not explicitly required as any required model is load implicitly on it' s first run< / li >
< / ul >
2023-12-06 21:00:47 +01:00
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < h5 > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span class = "tsd-kind-parameter" > userConfig< / span > : < span class = "tsd-signature-type " > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../interfaces/Config.html" class = "tsd-signature-type tsd-kind-interface" > Config< / a > < span class = "tsd-signature-symbol" > > < / span > < / h5 > < div class = "tsd-comment tsd-typography" > < p > < a href = "../interfaces/Config.html" class = "tsd-kind-interface" > Config< / a > < / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L286" > src/human.ts:286< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "next" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > next< / span > < a href = "#next" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "next.next-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > next< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > result< / span > < span class = "tsd-signature-symbol" > ?< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/Result.html" class = "tsd-signature-type tsd-kind-interface" > Result< / a > < a href = "#next.next-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Runs interpolation using last known result and returns smoothened result
2022-11-18 17:13:29 +01:00
Interpolation is based on time since last known result so can be called independently< / p >
2023-12-06 21:00:47 +01:00
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < h5 > < span class = "tsd-kind-parameter" > result< / span > : < a href = "../interfaces/Result.html" class = "tsd-signature-type tsd-kind-interface" > Result< / a > < span class = "tsd-signature-symbol" > = ...< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < p > < a href = "../interfaces/Result.html" class = "tsd-kind-interface" > Result< / a > optional use specific result set to run interpolation on< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < a href = "../interfaces/Result.html" class = "tsd-signature-type tsd-kind-interface" > Result< / a > < / h4 > < p > result - < a href = "../interfaces/Result.html" class = "tsd-kind-interface" > Result< / a > < / p >
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L325" > src/human.ts:325< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "now" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > now< / span > < a href = "#now" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "now.now-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > now< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < a href = "#now.now-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Utility wrapper for performance.now()< / p >
< / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > number< / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L221" > src/human.ts:221< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "profile" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > profile< / span > < a href = "#profile" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "profile.profile-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > profile< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > input< / span > , < span class = "tsd-kind-parameter" > userConfig< / span > < span class = "tsd-signature-symbol" > ?< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-symbol" > { < / span > < br / > < span > < / span > < span class = "tsd-kind-property" > kernel< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < span class = "tsd-kind-property" > perc< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < span class = "tsd-kind-property" > time< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > > < / span > < a href = "#profile.profile-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Run detect with tensorflow profiling< / p >
2022-11-18 17:13:29 +01:00
< ul >
< li > result object will contain total exeuction time information for top-20 kernels< / li >
< li > actual detection object can be accessed via < code > human.result< / code > < / li >
< / ul >
2023-12-06 21:00:47 +01:00
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < h5 > < span class = "tsd-kind-parameter" > input< / span > : < a href = "../types/Input.html" class = "tsd-signature-type tsd-kind-type-alias" > Input< / a > < / h5 > < / li > < li > < h5 > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span class = "tsd-kind-parameter" > userConfig< / span > : < span class = "tsd-signature-type " > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../interfaces/Config.html" class = "tsd-signature-type tsd-kind-interface" > Config< / a > < span class = "tsd-signature-symbol" > > < / span > < / h5 > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-symbol" > { < / span > < br / > < span > < / span > < span class = "tsd-kind-property" > kernel< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < span class = "tsd-kind-property" > perc< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < span class = "tsd-kind-property" > time< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L347" > src/human.ts:347< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "reset" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > reset< / span > < a href = "#reset" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "reset.reset-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > reset< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < a href = "#reset.reset-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Reset configuration to default values< / p >
< / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L205" > src/human.ts:205< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "segmentation" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > segmentation< / span > < a href = "#segmentation" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "segmentation.segmentation-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > segmentation< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > input< / span > , < span class = "tsd-kind-parameter" > userConfig< / span > < span class = "tsd-signature-symbol" > ?< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "Tensor-1.html" class = "tsd-signature-type tsd-kind-class" > Tensor< / a > < span class = "tsd-signature-symbol" > < < / span > < a href = "../enums/Rank.html" class = "tsd-signature-type tsd-kind-enum" > Rank< / a > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > > < / span > < a href = "#segmentation.segmentation-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Segmentation method takes any input and returns RGBA tensor
2022-11-18 17:13:29 +01:00
Note: Segmentation is not triggered as part of detect process< / p >
2023-12-06 21:00:47 +01:00
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < h5 > < span class = "tsd-kind-parameter" > input< / span > : < a href = "../types/Input.html" class = "tsd-signature-type tsd-kind-type-alias" > Input< / a > < / h5 > < div class = "tsd-comment tsd-typography" > < p > < a href = "../types/Input.html" class = "tsd-kind-type-alias" > Input< / a >
2022-11-18 17:13:29 +01:00
Returns tensor which contains image data in RGBA format< / p >
2023-12-06 21:00:47 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < li > < h5 > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span class = "tsd-kind-parameter" > userConfig< / span > : < span class = "tsd-signature-type " > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../interfaces/Config.html" class = "tsd-signature-type tsd-kind-interface" > Config< / a > < span class = "tsd-signature-symbol" > > < / span > < / h5 > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "Tensor-1.html" class = "tsd-signature-type tsd-kind-class" > Tensor< / a > < span class = "tsd-signature-symbol" > < < / span > < a href = "../enums/Rank.html" class = "tsd-signature-type tsd-kind-enum" > Rank< / a > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L241" > src/human.ts:241< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "sleep" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > sleep< / span > < a href = "#sleep" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "sleep.sleep-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > sleep< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > ms< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < a href = "#sleep.sleep-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Helper function< / p >
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < h5 > < span class = "tsd-kind-parameter" > ms< / span > : < span class = "tsd-signature-type" > number< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < p > sleep time in miliseconds< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L543" > src/human.ts:543< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "validate" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > validate< / span > < a href = "#validate" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "validate.validate-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > validate< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > userConfig< / span > < span class = "tsd-signature-symbol" > ?< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > < br / > < span > < / span > < span class = "tsd-kind-property" > expected< / span > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < span class = "tsd-kind-property" > reason< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < span class = "tsd-kind-property" > where< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > []< / span > < a href = "#validate.validate-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Validate current configuration schema< / p >
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < h5 > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span class = "tsd-kind-parameter" > userConfig< / span > : < span class = "tsd-signature-type " > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../interfaces/Config.html" class = "tsd-signature-type tsd-kind-interface" > Config< / a > < span class = "tsd-signature-symbol" > > < / span > < / h5 > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-symbol" > { < / span > < br / > < span > < / span > < span class = "tsd-kind-property" > expected< / span > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < span class = "tsd-kind-property" > reason< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < span class = "tsd-kind-property" > where< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > []< / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L214" > src/human.ts:214< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "video" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > video< / span > < a href = "#video" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "video.video-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > video< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > element< / span > , < span class = "tsd-kind-parameter" > run< / span > < span class = "tsd-signature-symbol" > ?< / span > , < span class = "tsd-kind-parameter" > delay< / span > < span class = "tsd-signature-symbol" > ?< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < a href = "#video.video-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Continously detect video frames< / p >
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < h5 > < span class = "tsd-kind-parameter" > element< / span > : < span class = "tsd-signature-type " > HTMLVideoElement< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < p > HTMLVideoElement input< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < li > < h5 > < span class = "tsd-kind-parameter" > run< / span > : < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > = true< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < p > boolean run continously or stop if already running, default true< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < li > < h5 > < span class = "tsd-kind-parameter" > delay< / span > : < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > = 0< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < p > number delay detection between frames for number of miliseconds, default 0< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L554" > src/human.ts:554< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "warmup" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > warmup< / span > < a href = "#warmup" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "warmup.warmup-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > warmup< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > userConfig< / span > < span class = "tsd-signature-symbol" > ?< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > undefined< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/Result.html" class = "tsd-signature-type tsd-kind-interface" > Result< / a > < span class = "tsd-signature-symbol" > > < / span > < a href = "#warmup.warmup-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-comment tsd-typography" > < p > Warmup method pre-initializes all configured models for faster inference< / p >
2022-11-18 17:13:29 +01:00
< ul >
< li > can take significant time on startup< / li >
< li > only used for < code > webgl< / code > and < code > humangl< / code > backends< / li >
< / ul >
2023-12-06 21:00:47 +01:00
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < h5 > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span class = "tsd-kind-parameter" > userConfig< / span > : < span class = "tsd-signature-type " > Partial< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../interfaces/Config.html" class = "tsd-signature-type tsd-kind-interface" > Config< / a > < span class = "tsd-signature-symbol" > > < / span > < / h5 > < div class = "tsd-comment tsd-typography" > < p > < a href = "../interfaces/Config.html" class = "tsd-kind-interface" > Config< / a > < / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type " > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > undefined< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/Result.html" class = "tsd-signature-type tsd-kind-interface" > Result< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < p > result - < a href = "../interfaces/Result.html" class = "tsd-kind-interface" > Result< / a > < / p >
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/human/blob/main/src/human.ts#L335" > src/human.ts:335< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < / section > < / div > < div class = "col-sidebar" > < div class = "page-menu" > < div class = "tsd-navigation settings" > < details class = "tsd-index-accordion" > < summary class = "tsd-accordion-summary" > < h3 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "#icon-chevronDown" > < / use > < / svg > Settings< / h3 > < / summary > < div class = "tsd-accordion-details" > < div class = "tsd-filter-visibility" > < h4 class = "uppercase" > Member Visibility< / h4 > < form > < ul id = "tsd-filter-options" > < li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-inherited" name = "inherited" checked / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < rect class = "tsd-checkbox-background" width = "30" height = "30" x = "1" y = "1" rx = "6" fill = "none" > < / rect > < path class = "tsd-checkbox-checkmark" d = "M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke = "none" stroke-width = "3.5" stroke-linejoin = "round" fill = "none" > < / path > < / svg > < span > Inherited< / span > < / label > < / li > < / ul > < / form > < / div > < div class = "tsd-theme-toggle" > < h4 class = "uppercase" > Theme< / h4 > < select id = "tsd-theme" > < option value = "os" > OS< / option > < option value = "light" > Light< / option > < option value = "dark" > Dark< / option > < / select > < / div > < / div > < / details > < / div > < details open class = "tsd-index-accordion tsd-page-navigation" > < summary class = "tsd-accordion-summary" > < h3 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "#icon-chevronDown" > < / use > < / svg > On This Page< / h3 > < / summary > < div class = "tsd-accordion-details" > < ul > < li > < a href = "#constructor" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-512" > < / use > < / svg > < span > constructor< / span > < / a > < / li > < li > < a href = "#config" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > config< / span > < / a > < / li > < li > < a href = "#draw" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > draw< / span > < / a > < / li > < li > < a href = "#env" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > env< / span > < / a > < / li > < li > < a href = "#events" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > events< / span > < / a > < / li > < li > < a href = "#faceTriangulation" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > face< wbr / > Triangulation< / span > < / a > < / li > < li > < a href = "#faceUVMap" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > faceUVMap< / span > < / a > < / li > < li > < a href = "#match" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > match< / span > < / a > < / li > < li > < a href = "#performance" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > performance< / span > < / a > < / li > < li > < a href = "#process" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > process< / span > < / a > < / li > < li > < a href = "#result" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > result< / span > < / a > < / li > < li > < a href = "#state" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > state< / span > < / a > < / li > < li > < a href = "#tf" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > tf< / span > < / a > < / li > < li > < a href = "#version" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > version< / span > < / a > < / li > < li > < a href = "#webcam" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > webcam< / span > < / a > < / li > < li > < a href = "#analyze" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > analyze< / span > < / a > < / li > < li > < a href = "#compare" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < /use
