2022-05-09 14:16:00 +02:00
|
|
|
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@vladmandic/human - v2.7.1</title><meta name="description" content="Documentation for @vladmandic/human - v2.7.1"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@vladmandic/human - v2.7.1</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"><h1>@vladmandic/human - v2.7.1 </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><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>References</h3><ul class="tsd-index-list"><li class="tsd-kind-reference"><a href="index.html#Descriptor" class="tsd-kind-icon">Descriptor</a></li><li class="tsd-kind-reference"><a href="index.html#Models" class="tsd-kind-icon">Models</a></li><li class="tsd-kind-reference"><a href="index.html#default" class="tsd-kind-icon">default</a></li></ul></section><section class="tsd-index-section "><h3>Namespaces</h3><ul class="tsd-index-list"><li class="tsd-kind-namespace"><a href="modules/Tensor.html" class="tsd-kind-icon">Tensor</a></li><li class="tsd-kind-namespace"><a href="modules/draw.html" class="tsd-kind-icon">draw</a></li><li class="tsd-kind-namespace"><a href="modules/match.html" class="tsd-kind-icon">match</a></li><li class="tsd-kind-namespace"><a href="modules/models.html" class="tsd-kind-icon">models</a></li></ul></section><section class="tsd-index-section "><h3>Enumerations</h3><ul class="tsd-index-list"><li class="tsd-kind-enum"><a href="enums/Rank.html" class="tsd-kind-icon">Rank</a></li></ul></section><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/Env.html" class="tsd-kind-icon">Env</a></li><li class="tsd-kind-class"><a href="classes/GraphModel.html" class="tsd-kind-icon">Graph<wbr/>Model</a></li><li class="tsd-kind-class"><a href="classes/Human.html" class="tsd-kind-icon">Human</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/Tensor.html" class="tsd-kind-icon">Tensor</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface"><a href="interfaces/BodyConfig.html" class="tsd-kind-icon">Body<wbr/>Config</a></li><li class="tsd-kind-interface"><a href="interfaces/BodyKeypoint.html" class="tsd-kind-icon">Body<wbr/>Keypoint</a></li><li class="tsd-kind-interface"><a href="interfaces/BodyResult.html" class="tsd-kind-icon">Body<wbr/>Result</a></li><li class="ts
|
2022-02-10 18:27:21 +01:00
|
|
|
<p>Defines all possible canvas types</p>
|
2022-04-01 18:38:05 +02:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="AnyImage" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Any<wbr/>Image<a href="#AnyImage" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Any<wbr/>Image<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLImageElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">Image</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/exports.ts#L33">src/exports.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-02-10 18:27:21 +01:00
|
|
|
<p>Defines all possible image types</p>
|
2022-04-01 18:38:05 +02:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="AnyVideo" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Any<wbr/>Video<a href="#AnyVideo" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Any<wbr/>Video<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLMediaElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLVideoElement</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/exports.ts#L35">src/exports.ts:35</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-02-10 18:27:21 +01:00
|
|
|
<p>Defines all possible video types</p>
|
2022-04-11 17:45:24 +02:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="BackendType" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Backend<wbr/>Type<a href="#BackendType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Backend<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"cpu"</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"wasm"</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"webgl"</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"humangl"</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"tensorflow"</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"webgpu"</span><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/config.ts#L203">src/config.ts:203</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-02-10 18:27:21 +01:00
|
|
|
<p>Possible TensorFlow backends</p>
|
|
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="BodyAnnotation" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Body<wbr/>Annotation<a href="#BodyAnnotation" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Body<wbr/>Annotation<span class="tsd-signature-symbol">:</span> <a href="index.html#BodyAnnotationBlazePose" class="tsd-signature-type" data-tsd-kind="Type alias">BodyAnnotationBlazePose</a><span class="tsd-signature-symbol"> | </span><a href="index.html#BodyAnnotationEfficientPose" class="tsd-signature-type" data-tsd-kind="Type alias">BodyAnnotationEfficientPose</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/result.ts#L83">src/result.ts:83</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="BodyAnnotationBlazePose" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Body<wbr/>Annotation<wbr/>Blaze<wbr/>Pose<a href="#BodyAnnotationBlazePose" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Body<wbr/>Annotation<wbr/>Blaze<wbr/>Pose<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"leftLeg"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightLeg"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"torso"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"leftArm"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightArm"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"leftEye"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightEye"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"mouth"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/result.ts#L81">src/result.ts:81</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="BodyAnnotationEfficientPose" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Body<wbr/>Annotation<wbr/>Efficient<wbr/>Pose<a href="#BodyAnnotationEfficientPose" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Body<wbr/>Annotation<wbr/>Efficient<wbr/>Pose<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"leftLeg"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightLeg"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"tor
|
|
|
|
|
<p>body gesture type</p>
|
|
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="BodyLandmark" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Body<wbr/>Landmark<a href="#BodyLandmark" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Body<wbr/>Landmark<span class="tsd-signature-symbol">:</span> <a href="index.html#BodyLandmarkPoseNet" class="tsd-signature-type" data-tsd-kind="Type alias">BodyLandmarkPoseNet</a><span class="tsd-signature-symbol"> | </span><a href="index.html#BodyLandmarkMoveNet" class="tsd-signature-type" data-tsd-kind="Type alias">BodyLandmarkMoveNet</a><span class="tsd-signature-symbol"> | </span><a href="index.html#BodyLandmarkEfficientNet" class="tsd-signature-type" data-tsd-kind="Type alias">BodyLandmarkEfficientNet</a><span class="tsd-signature-symbol"> | </span><a href="index.html#BodyLandmarkBlazePose" class="tsd-signature-type" data-tsd-kind="Type alias">BodyLandmarkBlazePose</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/result.ts#L80">src/result.ts:80</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="BodyLandmarkBlazePose" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Body<wbr/>Landmark<wbr/>Blaze<wbr/>Pose<a href="#BodyLandmarkBlazePose" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Body<wbr/>Landmark<wbr/>Blaze<wbr/>Pose<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"nose"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"leftEyeInside"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"leftEye"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"leftEyeOutside"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightEyeInside"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightEye"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightEyeOutside"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"leftEar"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightEar"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"leftMouth"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightMouth"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"leftShoulder"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightShoulder"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"leftElbow"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightElbow"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"leftWrist"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signa
|
|
|
|
|
<p>generic box as [x, y, width, height]</p>
|
2022-04-11 17:46:00 +02:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="DrawOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Draw<wbr/>Options<a href="#DrawOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Draw<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>alpha<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>color<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>drawAttention<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>drawBoxes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>drawGaze<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>drawGestures<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>drawLabels<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>drawPoints<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>drawPolygons<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>fillPolygons<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>font<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>labelColor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>lineHeight<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>lineWidth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>pointSize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>roundRect<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>shadowColor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>useCurves<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>useDepth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/draw/options.ts#L4">src/draw/options.ts:4</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-04-11 17:45:24 +02:00
|
|
|
<p>Draw Options</p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Accessed via <code>human.draw.options</code> or provided per each draw method as the drawOptions optional parameter</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>alpha<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>alpha value used for lines</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>color<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>draw line color</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>draw<wbr/>Attention<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>should face attention keypoints be highlighted</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>draw<wbr/>Boxes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>should draw boxes around detection results?</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>draw<wbr/>Gaze<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>should draw gaze arrows?</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>draw<wbr/>Gestures<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>should detected gestures be drawn?</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>draw<wbr/>Labels<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>should labels be drawn?</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>draw<wbr/>Points<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>should points be drawn?</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>draw<wbr/>Polygons<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>should draw polygons from detection points?</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>fill<wbr/>Polygons<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>should fill polygons?</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>font<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>label font</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>label<wbr/>Color<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>label color</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>line<wbr/>Height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>line spacing between labels</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>line<wbr/>Width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>line width for drawn lines</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>point<wbr/>Size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>size of drawn points</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>round<wbr/>Rect<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>draw rounded boxes by n pixels</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>shadow<wbr/>Color<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>label shadow color</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>use<wbr/>Curves<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>should lines be curved?</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>use<wbr/>Depth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>use z-coordinate when available</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="Emotion" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Emotion<a href="#Emotion" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Emotion<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"angry"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"disgust"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"fear"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"happy"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sad"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"surprise"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"neutral"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/result.ts#L14">src/result.ts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="Events" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Events<a href="#Events" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Events<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"create"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"load"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"image"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"result"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"warmup"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"error"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/exports.ts#L28">src/exports.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-02-10 18:27:21 +01:00
|
|
|
<p>Events dispatched by <code>human.events</code></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>
|
|
|
|
|
</ul>
|
2022-04-01 18:38:05 +02:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="ExternalCanvas" class="tsd-anchor"></a><h3 class="tsd-anchor-link">External<wbr/>Canvas<a href="#ExternalCanvas" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">External<wbr/>Canvas<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="classes/Env.html#Canvas" class="tsd-signature-type" data-tsd-kind="Property">Canvas</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/exports.ts#L39">src/exports.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-02-10 18:27:21 +01:00
|
|
|
<p>Defines possible externally defined canvas</p>
|
|
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="FaceGesture" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Face<wbr/>Gesture<a href="#FaceGesture" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Face<wbr/>Gesture<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">`</span><span class="tsd-signature-type">facing </span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">"left"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"center"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"right"</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-type">blink </span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">"left"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"right"</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-type"> eye</span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-type">mouth </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">% open</span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-type">head </span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">"up"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"down"</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">`</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/gesture/gesture.ts#L9">src/gesture/gesture.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>face gesture type</p>
|
|
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="FaceLandmark" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Face<wbr/>Landmark<a href="#FaceLandmark" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Face<wbr/>Landmark<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"leftEye"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightEye"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"nose"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"mouth"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"leftEar"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightEar"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"symmetryLine"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"silhouette"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"lipsUpperOuter"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"lipsLowerOuter"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"lipsUpperInner"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"lipsLowerInner"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightEyeUpper0"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightEyeLower0"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightEyeUpper1"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightEyeLower1"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightEyeUpper2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightEyeLower2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightEyeLower3"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightEyebrowUpper"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightEyebrowLower"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rightEyeIris"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"leftEyeUpper0"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"leftEyeLower0"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"leftEyeUpper1"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"leftEyeLower1"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"leftEyeUpper2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"leftEyeLower2"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"leftEyeLower3"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"leftEyebrowUpper"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"leftEyebrowLowe
|
|
|
|
|
<p>Gesture combined results
|
|
|
|
|
Each result has:</p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>part: part name and number where gesture was detected: <code>face</code>, <code>iris</code>, <code>body</code>, <code>hand</code></li>
|
|
|
|
|
<li>gesture: gesture detected</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="HandGesture" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Hand<wbr/>Gesture<a href="#HandGesture" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Hand<wbr/>Gesture<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">`</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">"thumb"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"index"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"middle"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ring"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"pinky"</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-type"> forward</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-type">"thumb"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"index"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"middle"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ring"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"pinky"</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-type"> up</span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"victory"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thumbs up"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/gesture/gesture.ts#L28">src/gesture/gesture.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>hand gesture type</p>
|
2022-04-01 18:38:05 +02:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="HandType" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Hand<wbr/>Type<a href="#HandType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Hand<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"hand"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"fist"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"pinch"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"point"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"face"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"tip"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"pinchtip"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/result.ts#L115">src/result.ts:115</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="ImageObjects" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Image<wbr/>Objects<a href="#ImageObjects" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Image<wbr/>Objects<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ImageData</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ImageBitmap</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/exports.ts#L37">src/exports.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-02-10 18:27:21 +01:00
|
|
|
<p>Defines all possible image objects</p>
|
2022-04-01 18:38:05 +02:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="Input" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Input<a href="#Input" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Input<span class="tsd-signature-symbol">:</span> <a href="classes/Tensor.html" class="tsd-signature-type" data-tsd-kind="Class">Tensor</a><span class="tsd-signature-symbol"> | </span><a href="index.html#AnyCanvas" class="tsd-signature-type" data-tsd-kind="Type alias">AnyCanvas</a><span class="tsd-signature-symbol"> | </span><a href="index.html#AnyImage" class="tsd-signature-type" data-tsd-kind="Type alias">AnyImage</a><span class="tsd-signature-symbol"> | </span><a href="index.html#AnyVideo" class="tsd-signature-type" data-tsd-kind="Type alias">AnyVideo</a><span class="tsd-signature-symbol"> | </span><a href="index.html#ImageObjects" class="tsd-signature-type" data-tsd-kind="Type alias">ImageObjects</a><span class="tsd-signature-symbol"> | </span><a href="index.html#ExternalCanvas" class="tsd-signature-type" data-tsd-kind="Type alias">ExternalCanvas</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/exports.ts#L41">src/exports.ts:41</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-02-10 18:27:21 +01:00
|
|
|
<p>Defines all possible input types for <strong>Human</strong> detection</p>
|
|
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="IrisGesture" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Iris<wbr/>Gesture<a href="#IrisGesture" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Iris<wbr/>Gesture<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"facing center"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-type">looking </span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">"left"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"right"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"up"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"down"</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"looking center"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/gesture/gesture.ts#L16">src/gesture/gesture.ts:16</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>iris gesture type</p>
|
|
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="ObjectType" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Object<wbr/>Type<a href="#ObjectType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Object<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"person"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"bicycle"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"car"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"motorcycle"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"airplane"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"bus"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"train"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"truck"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"boat"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"traffic light"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"fire hydrant"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"stop sign"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"parking meter"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"bench"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"bird"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"cat"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dog"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"horse"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sheep"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"cow"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"elephant"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"bear"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"zebra"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"giraffe"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"backpack"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"umbrella"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"handbag"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"tie"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"suitcase"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"frisbee"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"skis"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"snowboard"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type"
|
|
|
|
|
<p>generic point as [x, y, z?]</p>
|
2022-04-21 15:38:36 +02:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="Race" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Race<a href="#Race" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Race<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"white"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"black"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"asian"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"indian"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"other"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/result.ts#L16">src/result.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="TensorLike" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Tensor<wbr/>Like<a href="#TensorLike" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Tensor<wbr/>Like<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TypedArray</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">boolean</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">RecursiveArray</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><span class="tsd-signature-type">TypedArray</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RecursiveArray</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RecursiveArray</span><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><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/@tensorflow+tfjs-core@3.16.0/node_modules/@tensorflow/tfjs-core/dist/types.d.ts:78</li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>docalias</dt><dd><p>TypedArray|Array</p>
|
2022-04-11 17:45:24 +02:00
|
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="WarmupType" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Warmup<wbr/>Type<a href="#WarmupType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Warmup<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">""</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"none"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"face"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"full"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"body"</span><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/config.ts#L206">src/config.ts:206</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-02-10 18:27:21 +01:00
|
|
|
<p>Possible values for <code>human.warmup</code></p>
|
2022-04-11 17:45:24 +02:00
|
|
|
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable"><a id="defaults" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> defaults<a href="#defaults" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">defaults<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></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/config.ts#L303">src/config.ts:303</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-02-10 18:27:21 +01:00
|
|
|
<ul>
|
|
|
|
|
<li><a href="https://github.com/vladmandic/human/blob/main/src/config.ts#L262">See all default Config values...</a></li>
|
|
|
|
|
</ul>
|
2022-04-11 17:45:24 +02:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="env" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> env<a href="#env" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">env<span class="tsd-signature-symbol">:</span> <a href="classes/Env.html" class="tsd-signature-type" data-tsd-kind="Class">Env</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/util/env.ts#L175">src/util/env.ts:175</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="index.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="modules/Tensor.html">Tensor</a></li><li class=" tsd-kind-namespace"><a href="modules/draw.html">draw</a></li><li class=" tsd-kind-namespace"><a href="modules/match.html">match</a></li><li class=" tsd-kind-namespace"><a href="modules/models.html">models</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-reference"><a href="index.html#Descriptor" class="tsd-kind-icon">Descriptor</a></li><li class="tsd-kind-reference"><a href="index.html#Models" class="tsd-kind-icon">Models</a></li><li class="tsd-kind-reference"><a href="index.html#default" class="tsd-kind-icon">default</a></li><li class="tsd-kind-enum"><a href="enums/Rank.html" class="tsd-kind-icon">Rank</a></li><li class="tsd-kind-class"><a href="classes/Env.html" class="tsd-kind-icon">Env</a></li><li class="tsd-kind-class"><a href="classes/GraphModel.html" class="tsd-kind-icon">Graph<wbr/>Model</a></li><li class="tsd-kind-class"><a href="classes/Human.html" class="tsd-kind-icon">Human</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/Tensor.html" class="tsd-kind-icon">Tensor</a></li><li class="tsd-kind-interface"><a href="interfaces/BodyConfig.html" class="tsd-kind-icon">Body<wbr/>Config</a></li><li class="tsd-kind-interface"><a href="interfaces/BodyKeypoint.html" class="tsd-kind-icon">Body<wbr/>Keypoint</a></li><li class="tsd-kind-interface"><a href="interfaces/BodyResult.html" class="tsd-kind-icon">Body<wbr/>Result</a></li><li class="tsd-kind-interface"><a href="interfaces/Config.html" class="tsd-kind-icon">Config</a></li><li class="tsd-kind-interface"><a href="interfaces/FaceAntiSpoofConfig.html" class="tsd-kind-icon">Face<wbr/>Anti<wbr/>Spoof<wbr/>Config</a></li><li class="tsd-kind-interface"><a href="interfaces/FaceAttentionConfig.html" class="tsd-kind-icon">Face<wbr/>Attention<wbr/>Config</a></li><li class="tsd-kind-interface"><a href="interfaces/FaceConfig.html" class="tsd-kind-icon">Face<wbr/>Config</a></li><li class="tsd-kind-interface"><a href="interfaces/FaceDescriptionConfig.html" class="tsd-kind-icon">Face<wbr/>Description<wbr/>Config</a></li><li class="tsd-kind-interface"><a href="interfaces/FaceDetectorConfig.html" class="tsd-kind-icon">Face<wbr/>Detector<wbr/>Config</a></li><li class="tsd-kind-interface"><a href="interfaces/FaceEmotionConfig.html" class="tsd-kind-icon">Face<wbr/>Emotion<wbr/>Config</a></li><li class="tsd-kind-interface"><a href="interfaces/FaceIrisConfig.html" class="tsd-kind-icon">Face<wbr/>Iris<wbr/>Config</a></li><li class="tsd-kind-interface"><a href="interfaces/FaceLivenessConfig.html" class="tsd-kind-icon">Face<wbr/>Liveness<wbr/>Config</a></li><li class="tsd-kind-interface"><a href="interfaces/FaceMeshConfig.html" class="tsd-kind-icon">Face<wbr/>Mesh<wbr/>Config</a></li><li class="tsd-kind-interface"><a
|
