2021-04-10 03:53:48 +02:00
<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > Human | @vladmandic/human< / title >
< meta name = "description" content = "Documentation for @vladmandic/human" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "stylesheet" href = "../assets/css/main.css" >
< script async src = "../assets/js/search.js" id = "search-script" > < / script >
< / head >
< body >
< header >
< div class = "tsd-page-toolbar" >
< div class = "container" >
< div class = "table-wrap" >
< div class = "table-cell" id = "tsd-search" data-index = "../assets/js/search.json" data-base = ".." >
< div class = "field" >
< label for = "tsd-search-field" class = "tsd-widget search no-caption" > Search< / label >
< input id = "tsd-search-field" type = "text" / >
< / div >
< ul class = "results" >
< li class = "state loading" > Preparing search index...< / li >
< li class = "state failure" > The search index is not available< / li >
< / ul >
< a href = "../index.html" class = "title" > @vladmandic/human< / a >
< / div >
< div class = "table-cell" id = "tsd-widgets" >
< div id = "tsd-filter" >
< a href = "#" class = "tsd-widget options no-caption" data-toggle = "options" > Options< / a >
< div class = "tsd-filter-group" >
< div class = "tsd-select" id = "tsd-filter-visibility" >
< span class = "tsd-select-label" > All< / span >
< ul class = "tsd-select-list" >
< li data-value = "public" > Public< / li >
< li data-value = "protected" > Public/Protected< / li >
< li data-value = "private" class = "selected" > All< / li >
< / ul >
< / div >
< input type = "checkbox" id = "tsd-filter-inherited" checked / >
< label class = "tsd-widget" for = "tsd-filter-inherited" > Inherited< / label >
< / div >
< / div >
< a href = "#" class = "tsd-widget menu no-caption" data-toggle = "menu" > Menu< / a >
< / div >
< / div >
< / div >
< / div >
< div class = "tsd-page-title" >
< div class = "container" >
< ul class = "tsd-breadcrumb" >
< li >
< a href = "../index.html" > @vladmandic/human< / a >
< / li >
< li >
< a href = "human.html" > Human< / a >
< / li >
< / ul >
< h1 > Class Human< / h1 >
< / div >
< / div >
< / header >
< div class = "container container-main" >
< div class = "row" >
< div class = "col-8 col-content" >
< section class = "tsd-panel tsd-comment" >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > < strong > Human< / strong > library main class< / p >
< / div >
< p > All methods and properties are available only as members of Human class< / p >
< ul >
< li > Configuration object definition: < a href = "../interfaces/config.html" > Config< / a > < / li >
< li > Results object definition: < a href = "../interfaces/result.html" > Result< / a > < / li >
< li > Possible inputs: < a href = "../index.html#input" > Input< / a > < / li >
< / ul >
< / div >
< / section >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > Hierarchy< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > Human< / 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 > Constructors< / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-constructor tsd-parent-kind-class" > < a href = "human.html#constructor" class = "tsd-kind-icon" > constructor< / a > < / li >
< / ul >
< / section >
< section class = "tsd-index-section " >
< h3 > Properties< / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "human.html#classes" class = "tsd-kind-icon" > classes< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "human.html#config" class = "tsd-kind-icon" > config< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "human.html#draw" class = "tsd-kind-icon" > draw< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "human.html#facetriangulation" class = "tsd-kind-icon" > face< wbr > Triangulation< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "human.html#faceuvmap" class = "tsd-kind-icon" > faceUVMap< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "human.html#image" class = "tsd-kind-icon" > image< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "human.html#models" class = "tsd-kind-icon" > models< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "human.html#perf" class = "tsd-kind-icon" > perf< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "human.html#state" class = "tsd-kind-icon" > state< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "human.html#sysinfo" class = "tsd-kind-icon" > sysinfo< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "human.html#tf" class = "tsd-kind-icon" > tf< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "human.html#version" class = "tsd-kind-icon" > version< / a > < / li >
< / ul >
< / section >
< section class = "tsd-index-section " >
< h3 > Methods< / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "human.html#detect" class = "tsd-kind-icon" > detect< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "human.html#enhance" class = "tsd-kind-icon" > enhance< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "human.html#load" class = "tsd-kind-icon" > load< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "human.html#match" class = "tsd-kind-icon" > match< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "human.html#profiledata" class = "tsd-kind-icon" > profile< wbr > Data< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "human.html#similarity" class = "tsd-kind-icon" > similarity< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "human.html#warmup" class = "tsd-kind-icon" > warmup< / a > < / li >
< / ul >
< / section >
< / div >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Constructors< / h2 >
< section class = "tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class" >
< a name = "constructor" class = "tsd-anchor" > < / a >
< h3 > constructor< / h3 >
< ul class = "tsd-signatures tsd-kind-constructor tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > new < wbr > Human< span class = "tsd-signature-symbol" > (< / span > userConfig< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > Object< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/config.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Config< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "human.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Human< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Creates instance of Human library that is futher used for all operations< / p >
< ul >
< li > @param userConfig: < a href = "../interfaces/config.html" > Config< / a > < / li >
< / ul >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > userConfig: < span class = "tsd-signature-type" > Object< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/config.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Config< / a > < span class = "tsd-signature-symbol" > = {}< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "human.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Human< / a > < / h4 >
< / li >
< / ul >
< / 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-class" >
< a name = "classes" class = "tsd-anchor" > < / a >
< h3 > classes< / h3 >
2021-04-25 00:43:59 +02:00
< div class = "tsd-signature tsd-kind-icon" > classes< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > { < / span > body< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > __module< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > __module< / span > < span class = "tsd-signature-symbol" > ; < / span > emotion< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > __module< / span > < span class = "tsd-signature-symbol" > ; < / span > facemesh< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > __module< / span > < span class = "tsd-signature-symbol" > ; < / span > faceres< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > __module< / span > < span class = "tsd-signature-symbol" > ; < / span > hand< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > __module< / span > < span class = "tsd-signature-symbol" > ; < / span > nanodet< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > __module< / span > < span class = "tsd-signature-symbol" > }< / span > < / div >
2021-04-10 03:53:48 +02:00
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Internal: Currently loaded classes< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > body< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > __module< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > __module< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > emotion< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > __module< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > facemesh< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > __module< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > faceres< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > __module< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > hand< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > __module< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > nanodet< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > __module< / span > < / h5 >
< / li >
< / ul >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "config" class = "tsd-anchor" > < / a >
< h3 > config< / h3 >
< div class = "tsd-signature tsd-kind-icon" > config< span class = "tsd-signature-symbol" > :< / span > < a href = "../interfaces/config.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Config< / a > < / div >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Current configuration< / p >
< ul >
< li > Details: < a href = "../interfaces/config.html" > Config< / a > < / li >
< / ul >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "draw" class = "tsd-anchor" > < / a >
< h3 > draw< / h3 >
2021-04-13 17:05:52 +02:00
< div class = "tsd-signature tsd-kind-icon" > draw< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > { < / span > all< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > inCanvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / span > , result< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > , drawOptions< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/drawoptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DrawOptions< / a > < 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 > < span class = "tsd-signature-symbol" > ; < / span > body< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > inCanvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / span > , result< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > , drawOptions< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/drawoptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DrawOptions< / a > < 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 > < span class = "tsd-signature-symbol" > ; < / span > canvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > inCanvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / span > , outCanvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / 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 > < span class = "tsd-signature-symbol" > ; < / span > face< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > inCanvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / span > , result< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > , drawOptions< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/drawoptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DrawOptions< / a > < 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 > < span class = "tsd-signature-symbol" > ; < / span > gesture< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > inCanvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / span > , result< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > , drawOptions< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/drawoptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DrawOptions< / a > < 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 > < span class = "tsd-signature-symbol" > ; < / span > hand< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-s
2021-04-10 03:53:48 +02:00
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Draw helper classes that can draw detected objects on canvas using specified draw styles< / p >
< ul >
< li > options: global settings for all draw operations, can be overriden for each draw method, for details see < a href = "../interfaces/drawoptions.html" > DrawOptions< / a > < / li >
< li > face: draw detected faces< / li >
< li > body: draw detected people and body parts< / li >
< li > hand: draw detected hands and hand parts< / li >
< li > canvas: draw processed canvas which is a processed copy of the input< / li >
< li > all: meta-function that performs: canvas, face, body, hand< / li >
< / ul >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
2021-04-13 17:05:52 +02:00
< h5 > all< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > inCanvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / span > , result< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > , drawOptions< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/drawoptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DrawOptions< / a > < 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 > < / h5 >
2021-04-10 03:53:48 +02:00
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal" >
2021-04-13 17:05:52 +02:00
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > inCanvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / span > , result< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > , drawOptions< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/drawoptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DrawOptions< / a > < 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 > < / li >
2021-04-10 03:53:48 +02:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > inCanvas: < span class = "tsd-signature-type" > HTMLCanvasElement< / span > < / h5 >
< / li >
< li >
< h5 > result: < span class = "tsd-signature-type" > any< / span > < / h5 >
< / li >
2021-04-13 17:05:52 +02:00
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > drawOptions: < a href = "../interfaces/drawoptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DrawOptions< / a > < / h5 >
< / li >
2021-04-10 03:53:48 +02:00
< / ul >
< 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 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< li class = "tsd-parameter" >
2021-04-13 17:05:52 +02:00
< h5 > body< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > inCanvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / span > , result< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > , drawOptions< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/drawoptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DrawOptions< / a > < 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 > < / h5 >
2021-04-10 03:53:48 +02:00
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal" >
2021-04-13 17:05:52 +02:00
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > inCanvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / span > , result< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > , drawOptions< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/drawoptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DrawOptions< / a > < 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 > < / li >
2021-04-10 03:53:48 +02:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > inCanvas: < span class = "tsd-signature-type" > HTMLCanvasElement< / span > < / h5 >
< / li >
< li >
< h5 > result: < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
2021-04-13 17:05:52 +02:00
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > drawOptions: < a href = "../interfaces/drawoptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DrawOptions< / a > < / h5 >
< / li >
2021-04-10 03:53:48 +02:00
< / ul >
< 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 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< li class = "tsd-parameter" >
< h5 > canvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > inCanvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / span > , outCanvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / 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 > < / h5 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > inCanvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / span > , outCanvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / 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 > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > inCanvas: < span class = "tsd-signature-type" > HTMLCanvasElement< / span > < / h5 >
< / li >
< li >
< h5 > outCanvas: < span class = "tsd-signature-type" > HTMLCanvasElement< / span > < / h5 >
< / li >
< / ul >
< 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 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< li class = "tsd-parameter" >
2021-04-13 17:05:52 +02:00
< h5 > face< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > inCanvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / span > , result< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > , drawOptions< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/drawoptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DrawOptions< / a > < 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 > < / h5 >
2021-04-10 03:53:48 +02:00
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal" >
2021-04-13 17:05:52 +02:00
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > inCanvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / span > , result< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > , drawOptions< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/drawoptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DrawOptions< / a > < 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 > < / li >
2021-04-10 03:53:48 +02:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > inCanvas: < span class = "tsd-signature-type" > HTMLCanvasElement< / span > < / h5 >
< / li >
< li >
< h5 > result: < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
2021-04-13 17:05:52 +02:00
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > drawOptions: < a href = "../interfaces/drawoptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DrawOptions< / a > < / h5 >
< / li >
2021-04-10 03:53:48 +02:00
< / ul >
< 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 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< li class = "tsd-parameter" >
2021-04-13 17:05:52 +02:00
< h5 > gesture< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > inCanvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / span > , result< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > , drawOptions< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/drawoptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DrawOptions< / a > < 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 > < / h5 >
2021-04-10 03:53:48 +02:00
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal" >
2021-04-13 17:05:52 +02:00
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > inCanvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / span > , result< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > , drawOptions< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/drawoptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DrawOptions< / a > < 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 > < / li >
2021-04-10 03:53:48 +02:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > inCanvas: < span class = "tsd-signature-type" > HTMLCanvasElement< / span > < / h5 >
< / li >
< li >
< h5 > result: < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
2021-04-13 17:05:52 +02:00
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > drawOptions: < a href = "../interfaces/drawoptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DrawOptions< / a > < / h5 >
< / li >
2021-04-10 03:53:48 +02:00
< / ul >
< 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 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< li class = "tsd-parameter" >
2021-04-13 17:05:52 +02:00
< h5 > hand< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > inCanvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / span > , result< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > , drawOptions< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/drawoptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DrawOptions< / a > < 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 > < / h5 >
2021-04-10 03:53:48 +02:00
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal" >
2021-04-13 17:05:52 +02:00
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > inCanvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / span > , result< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > , drawOptions< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/drawoptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DrawOptions< / a > < 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 > < / li >
2021-04-10 03:53:48 +02:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > inCanvas: < span class = "tsd-signature-type" > HTMLCanvasElement< / span > < / h5 >
< / li >
< li >
< h5 > result: < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
2021-04-13 17:05:52 +02:00
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > drawOptions: < a href = "../interfaces/drawoptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DrawOptions< / a > < / h5 >
< / li >
2021-04-10 03:53:48 +02:00
< / ul >
< 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 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
2021-04-13 17:05:52 +02:00
< li class = "tsd-parameter" >
< h5 > options< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/drawoptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DrawOptions< / a > < / h5 >
< / li >
2021-04-10 03:53:48 +02:00
< / ul >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "facetriangulation" class = "tsd-anchor" > < / a >
< h3 > face< wbr > Triangulation< / h3 >
< div class = "tsd-signature tsd-kind-icon" > face< wbr > Triangulation< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > []< / span > < / div >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Face triangualtion array of 468 points, used for triangle references between points< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "faceuvmap" class = "tsd-anchor" > < / a >
< h3 > faceUVMap< / h3 >
< div class = "tsd-signature tsd-kind-icon" > faceUVMap< 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 >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > UV map of 468 values, used for 3D mapping of the face mesh< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "image" class = "tsd-anchor" > < / a >
< h3 > image< / h3 >
2021-04-13 17:05:52 +02:00
< div class = "tsd-signature tsd-kind-icon" > image< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > { < / span > canvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > OffscreenCanvas< / span > < span class = "tsd-signature-symbol" > ; < / span > tensor< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-symbol" > typeof < / span > < span class = "tsd-signature-type" > __class< / span > < span class = "tsd-signature-symbol" > }< / span > < / div >
2021-04-10 03:53:48 +02:00
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Internal: Instance of current image being processed< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
2021-04-13 17:05:52 +02:00
< h5 > canvas< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > HTMLCanvasElement< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > OffscreenCanvas< / span > < / h5 >
2021-04-10 03:53:48 +02:00
< / li >
< li class = "tsd-parameter" >
2021-04-13 17:05:52 +02:00
< h5 > tensor< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-symbol" > typeof < / span > < span class = "tsd-signature-type" > __class< / span > < / h5 >
2021-04-10 03:53:48 +02:00
< / li >
< / ul >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "models" class = "tsd-anchor" > < / a >
< h3 > models< / h3 >
2021-04-24 22:04:49 +02:00
< div class = "tsd-signature tsd-kind-icon" > models< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > { < / span > age< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < span class = "tsd-signature-symbol" > ; < / span > blazepose< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < span class = "tsd-signature-symbol" > ; < / span > efficientpose< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < span class = "tsd-signature-symbol" > ; < / span > embedding< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < span class = "tsd-signature-symbol" > ; < / span > emotion< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < span class = "tsd-signature-symbol" > ; < / span > face< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > MediaPipeFaceMesh< / span > < span class = "tsd-signature-symbol" > ; < / span > faceres< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < span class = "tsd-signature-symbol" > ; < / span > gender< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < span class = "tsd-signature-symbol" > ; < / span > handpose< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > HandPose< / span > < span class = "tsd-signature-symbol" > ; < / span > iris< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < span class = "tsd-signature-symbol" > ; < / span > nanodet< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < span class = "tsd-signature-symbol" > ; < / span > posenet< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < span class = "tsd-signature-symbol" > }< / span > < / div >
2021-04-10 03:53:48 +02:00
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Internal: Currently loaded models< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > age< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > blazepose< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > efficientpose< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > embedding< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > emotion< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > face< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > MediaPipeFaceMesh< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > faceres< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > gender< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > handpose< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > HandPose< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > iris< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > nanodet< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
2021-04-24 22:04:49 +02:00
< h5 > posenet< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Object< / span > < / h5 >
2021-04-10 03:53:48 +02:00
< / li >
< / ul >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "perf" class = "tsd-anchor" > < / a >
< h3 > perf< / h3 >
< div class = "tsd-signature tsd-kind-icon" > perf< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > any< / span > < / div >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Performance object that contains values for all recently performed operations< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "state" class = "tsd-anchor" > < / a >
< h3 > state< / h3 >
< div class = "tsd-signature tsd-kind-icon" > state< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Current state of Human library< / p >
< ul >
< li > Can be polled to determine operations that are currently executed< / li >
< / ul >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "sysinfo" class = "tsd-anchor" > < / a >
< h3 > sysinfo< / h3 >
< div class = "tsd-signature tsd-kind-icon" > sysinfo< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > { < / span > agent< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > platform< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > }< / span > < / div >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Platform and agent information detected by Human< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< div class = "tsd-type-declaration" >
< h4 > Type declaration< / h4 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > agent< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > platform< 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-class" >
< a name = "tf" class = "tsd-anchor" > < / a >
< h3 > tf< / h3 >
< div class = "tsd-signature tsd-kind-icon" > tf< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > __module< / span > < / div >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Internal: Instance of TensorFlow/JS used by Human< / p >
< ul >
< li > Can be embedded or externally provided< / li >
< / ul >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "version" class = "tsd-anchor" > < / a >
< h3 > version< / h3 >
< div class = "tsd-signature tsd-kind-icon" > version< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Current version of Human library in semver format< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Methods< / h2 >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
< a name = "detect" class = "tsd-anchor" > < / a >
< h3 > detect< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > detect< span class = "tsd-signature-symbol" > (< / span > input< span class = "tsd-signature-symbol" > : < / span > < a href = "../index.html#input" class = "tsd-signature-type" data-tsd-kind = "Type alias" > Input< / a > , userConfig< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > Object< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/config.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Config< / a > < 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 = "../index.html#error" class = "tsd-signature-type" data-tsd-kind = "Type alias" > Error< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/result.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Result< / a > < span class = "tsd-signature-symbol" > > < / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Main detection method< / p >
< ul >
< li > Analyze configuration: < a href = "../interfaces/config.html" > Config< / a > < / li >
< li > Pre-process input: < a href = "../index.html#input" > Input< / a > < / li >
< li > Run inference for all configured models< / li >
< li > Process and return result: < a href = "../interfaces/result.html" > Result< / a > < / li >
< / ul >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > input: < a href = "../index.html#input" class = "tsd-signature-type" data-tsd-kind = "Type alias" > Input< / a > < / h5 >
< / li >
< li >
< h5 > userConfig: < span class = "tsd-signature-type" > Object< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/config.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Config< / a > < span class = "tsd-signature-symbol" > = {}< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../index.html#error" class = "tsd-signature-type" data-tsd-kind = "Type alias" > Error< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/result.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Result< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
< a name = "enhance" class = "tsd-anchor" > < / a >
< h3 > enhance< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > enhance< span class = "tsd-signature-symbol" > (< / span > input< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > typeof < / span > < span class = "tsd-signature-type" > __class< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-symbol" > typeof < / span > < span class = "tsd-signature-type" > __class< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Enhance method performs additional enhacements to face image previously detected for futher processing< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > input: < span class = "tsd-signature-symbol" > typeof < / span > < span class = "tsd-signature-type" > __class< / span > < / h5 >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< p > Tensor as provided in human.result.face[n].tensor< / p >
< / div >
2021-04-10 03:53:48 +02:00
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-symbol" > typeof < / span > < span class = "tsd-signature-type" > __class< / span > < / h4 >
2021-04-13 17:05:52 +02:00
< p > Tensor< / p >
2021-04-10 03:53:48 +02:00
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
< a name = "load" class = "tsd-anchor" > < / a >
< h3 > load< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > load< span class = "tsd-signature-symbol" > (< / span > userConfig< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > Object< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/config.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Config< / a > < 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 > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Load method preloads all configured models on-demand< / p >
< ul >
< li > Not explicitly required as any required model is load implicitly on it' s first run< / li >
< / ul >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > userConfig: < span class = "tsd-signature-type" > Object< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/config.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Config< / a > < span class = "tsd-signature-symbol" > = {}< / span > < / h5 >
< / li >
< / ul >
< 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 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
< a name = "match" class = "tsd-anchor" > < / a >
< h3 > match< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > match< span class = "tsd-signature-symbol" > (< / span > faceEmbedding< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > []< / span > , db< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > embedding< 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 > name< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > source< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > []< / span > , threshold< 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 > < span class = "tsd-signature-symbol" > { < / span > embedding< 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 > name< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > similarity< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > source< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > }< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Math method find best match between provided face descriptor and predefined database of known descriptors< / p >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > faceEmbedding: < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
< li >
< h5 > db: < span class = "tsd-signature-symbol" > { < / span > embedding< 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 > name< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > source< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
< li >
< h5 > threshold: < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > = 0< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-symbol" > { < / span > embedding< 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 > name< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > similarity< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > source< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > }< / span > < / h4 >
2021-04-13 17:05:52 +02:00
< p > best match< / p >
2021-04-10 03:53:48 +02:00
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > embedding< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > name< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > similarity< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > source< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< / ul >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
< a name = "profiledata" class = "tsd-anchor" > < / a >
< h3 > profile< wbr > Data< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > profile< wbr > Data< span class = "tsd-signature-symbol" > (< / 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 > < span class = "tsd-signature-symbol" > { < / span > largestKernelOps< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > ; < / span > newBytes< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > ; < / span > newTensors< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > ; < / span > numKernelOps< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > ; < / span > peakBytes< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > ; < / span > slowestKernelOps< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > ; < / span > timeKernelOps< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > }< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Internal: ProfileData method returns last known profiling information< / p >
< ul >
< li > Requires human.config.profile set to true< / li >
< / ul >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-symbol" > {}< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-symbol" > { < / span > largestKernelOps< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > ; < / span > newBytes< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > ; < / span > newTensors< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > ; < / span > numKernelOps< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > ; < / span > peakBytes< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > ; < / span > slowestKernelOps< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > ; < / span > timeKernelOps< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > }< / span > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
< a name = "similarity" class = "tsd-anchor" > < / a >
< h3 > similarity< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > similarity< span class = "tsd-signature-symbol" > (< / span > embedding1< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > []< / span > , embedding2< 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 > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Simmilarity method calculates simmilarity between two provided face descriptors (face embeddings)< / p >
< ul >
< li > Calculation is based on normalized Minkowski distance between< / li >
< / ul >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > embedding1: < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
< li >
< h5 > embedding2: < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > number< / span > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
< a name = "warmup" class = "tsd-anchor" > < / a >
< h3 > warmup< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > warmup< span class = "tsd-signature-symbol" > (< / span > userConfig< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > Object< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/config.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Config< / a > < 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" data-tsd-kind = "Interface" > Result< / a > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-symbol" > { < / span > error< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > > < / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< / aside >
2021-04-13 17:05:52 +02:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Warmup metho pre-initializes all models for faster inference< / p >
< ul >
< li > can take significant time on startup< / li >
< li > only used for < code > webgl< / code > and < code > humangl< / code > backends< / li >
< / ul >
< / div >
< / div >
2021-04-10 03:53:48 +02:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > userConfig: < span class = "tsd-signature-type" > Object< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/config.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Config< / a > < span class = "tsd-signature-symbol" > = {}< / span > < / h5 >
< / li >
< / ul >
< 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" data-tsd-kind = "Interface" > Result< / a > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-symbol" > { < / span > error< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< / li >
< / ul >
< / section >
< / section >
< / div >
< div class = "col-4 col-menu menu-sticky-wrap menu-highlight" >
< nav class = "tsd-navigation primary" >
< ul >
< li class = " " >
< a href = "../index.html" > Exports< / a >
< / li >
< / ul >
< / nav >
< nav class = "tsd-navigation secondary menu-sticky" >
< ul class = "before-current" >
< li class = " tsd-kind-reference" >
< a href = "../index.html#default" class = "tsd-kind-icon" > default< / a >
< / li >
< / ul >
< ul class = "current" >
< li class = "current tsd-kind-class" >
< a href = "human.html" class = "tsd-kind-icon" > Human< / a >
< ul >
< li class = " tsd-kind-constructor tsd-parent-kind-class" >
< a href = "human.html#constructor" class = "tsd-kind-icon" > constructor< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "human.html#classes" class = "tsd-kind-icon" > classes< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "human.html#config" class = "tsd-kind-icon" > config< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "human.html#draw" class = "tsd-kind-icon" > draw< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "human.html#facetriangulation" class = "tsd-kind-icon" > face< wbr > Triangulation< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "human.html#faceuvmap" class = "tsd-kind-icon" > faceUVMap< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "human.html#image" class = "tsd-kind-icon" > image< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "human.html#models" class = "tsd-kind-icon" > models< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "human.html#perf" class = "tsd-kind-icon" > perf< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "human.html#state" class = "tsd-kind-icon" > state< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "human.html#sysinfo" class = "tsd-kind-icon" > sysinfo< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "human.html#tf" class = "tsd-kind-icon" > tf< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "human.html#version" class = "tsd-kind-icon" > version< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-class" >
< a href = "human.html#detect" class = "tsd-kind-icon" > detect< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-class" >
< a href = "human.html#enhance" class = "tsd-kind-icon" > enhance< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-class" >
< a href = "human.html#load" class = "tsd-kind-icon" > load< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-class" >
< a href = "human.html#match" class = "tsd-kind-icon" > match< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-class" >
< a href = "human.html#profiledata" class = "tsd-kind-icon" > profile< wbr > Data< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-class" >
< a href = "human.html#similarity" class = "tsd-kind-icon" > similarity< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-class" >
< a href = "human.html#warmup" class = "tsd-kind-icon" > warmup< / a >
< / li >
< / ul >
< / li >
< / ul >
< ul class = "after-current" >
< li class = " tsd-kind-interface" >
< a href = "../interfaces/config.html" class = "tsd-kind-icon" > Config< / a >
< / li >
2021-04-13 17:05:52 +02:00
< li class = " tsd-kind-interface" >
< a href = "../interfaces/drawoptions.html" class = "tsd-kind-icon" > Draw< wbr > Options< / a >
< / li >
2021-04-10 03:53:48 +02:00
< li class = " tsd-kind-interface" >
< a href = "../interfaces/result.html" class = "tsd-kind-icon" > Result< / a >
< / li >
< li class = " tsd-kind-type-alias" >
< a href = "../index.html#error" class = "tsd-kind-icon" > Error< / a >
< / li >
< li class = " tsd-kind-type-alias" >
< a href = "../index.html#input" class = "tsd-kind-icon" > Input< / a >
< / li >
< li class = " tsd-kind-type-alias" >
< a href = "../index.html#tensor" class = "tsd-kind-icon" > Tensor< / a >
< / li >
< li class = " tsd-kind-type-alias" >
< a href = "../index.html#tensorflow" class = "tsd-kind-icon" > Tensor< wbr > Flow< / a >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< footer >
< div class = "container" >
< h2 > Legend< / h2 >
< div class = "tsd-legend-group" >
< ul class = "tsd-legend" >
< li class = "tsd-kind-constructor tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Constructor< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< / ul >
< / div >
< / div >
< / footer >
< div class = "overlay" > < / div >
< script src = "../assets/js/main.js" > < / script >
< / body >
< / html >
