2024-02-07 17:20:36 +01:00
|
|
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FaceMatcher | @vladmandic/face-api - v1.7.13</title><meta name="description" content="Documentation for @vladmandic/face-api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@vladmandic/face-api - v1.7.13</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@vladmandic/face-api</a></li><li><a href="FaceMatcher.html">FaceMatcher</a></li></ul><h1>Class FaceMatcher</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Mixtiles/face-api/blob/master/src/globalApi/FaceMatcher.ts#L6">src/globalApi/FaceMatcher.ts:6</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="FaceMatcher.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a>
|
2024-01-17 22:56:53 +01:00
|
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="FaceMatcher.html#distanceThreshold" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>distance<wbr/>Threshold</span></a>
|
|
|
|
|
<a href="FaceMatcher.html#labeledDescriptors" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>labeled<wbr/>Descriptors</span></a>
|
|
|
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="FaceMatcher.html#computeMeanDistance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>compute<wbr/>Mean<wbr/>Distance</span></a>
|
|
|
|
|
<a href="FaceMatcher.html#findBestMatch" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>find<wbr/>Best<wbr/>Match</span></a>
|
|
|
|
|
<a href="FaceMatcher.html#matchDescriptor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>match<wbr/>Descriptor</span></a>
|
|
|
|
|
<a href="FaceMatcher.html#toJSON" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>toJSON</span></a>
|
|
|
|
|
<a href="FaceMatcher.html#fromJSON" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>fromJSON</span></a>
|
2024-02-07 17:20:36 +01:00
|
|
|
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_FaceMatcher" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Face<wbr/>Matcher</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">inputs</span>, <span class="tsd-kind-parameter">distanceThreshold</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="FaceMatcher.html" class="tsd-signature-type tsd-kind-class">FaceMatcher</a><a href="#constructor.new_FaceMatcher" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">inputs</span>: <span class="tsd-signature-type">any</span></h5></li><li><h5><span class="tsd-kind-parameter">distanceThreshold</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0.6</span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="FaceMatcher.html" class="tsd-signature-type tsd-kind-class">FaceMatcher</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Mixtiles/face-api/blob/master/src/globalApi/FaceMatcher.ts#L10">src/globalApi/FaceMatcher.ts:10</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Accessors</h2><section class="tsd-panel tsd-member"><a id="distanceThreshold" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>distance<wbr/>Threshold</span><a href="#distanceThreshold" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="distanceThreshold.distanceThreshold-1"><span class="tsd-signature-keyword">get</span> distanceThreshold<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><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Mixtiles/face-api/blob/master/src/globalApi/FaceMatcher.ts#L26">src/globalApi/FaceMatcher.ts:26</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="labeledDescriptors" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>labeled<wbr/>Descriptors</span><a href="#labeledDescriptors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="labeledDescriptors.labeledDescriptors-1"><span class="tsd-signature-keyword">get</span> labeledDescriptors<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LabeledFaceDescriptors.html" class="tsd-signature-type tsd-kind-class">LabeledFaceDescriptors</a><span class="tsd-signature-symbol">[]</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="LabeledFaceDescriptors.html" class="tsd-signature-type tsd-kind-class">LabeledFaceDescriptors</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Mixtiles/face-api/blob/master/src/globalApi/FaceMatcher.ts#L24">src/globalApi/FaceMatcher.ts:24</a></li></ul></aside></
|
