2025-02-05 15:15:34 +01:00
|
|
|
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FaceDetectionNet | @vladmandic/face-api - v1.7.15</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/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><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="../assets/icons.svg#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.15</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="../assets/icons.svg#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="FaceDetectionNet.html">FaceDetectionNet</a></li></ul><h1>Class FaceDetectionNet</h1></div><section class="tsd-panel tsd-hierarchy" data-refl="4320"><h4>Hierarchy (<a href="../hierarchy.html#FaceDetectionNet">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="SsdMobilenetv1.html" class="tsd-signature-type tsd-kind-class">SsdMobilenetv1</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">FaceDetectionNet</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/vladmandic/face-api/blob/master/src/ssdMobilenetv1/index.ts#L17">src/ssdMobilenetv1/index.ts:17</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-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="../assets/icons.svg#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="FaceDetectionNet.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
2024-09-10 17:30:23 +02:00
|
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="FaceDetectionNet.html#_name" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_name</span></a>
|
2025-02-05 15:02:06 +01:00
|
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="FaceDetectionNet.html#isloaded" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Loaded</span></a>
|
|
|
|
|
<a href="FaceDetectionNet.html#parammappings" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>param<wbr/>Mappings</span></a>
|
2024-09-10 17:30:23 +02:00
|
|
|
<a href="FaceDetectionNet.html#params" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>params</span></a>
|
|
|
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="FaceDetectionNet.html#dispose" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dispose</span></a>
|
2025-02-05 15:02:06 +01:00
|
|
|
<a href="FaceDetectionNet.html#extractweights" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>extract<wbr/>Weights</span></a>
|
2024-09-10 17:30:23 +02:00
|
|
|
<a href="FaceDetectionNet.html#forward" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>forward</span></a>
|
2025-02-05 15:02:06 +01:00
|
|
|
<a href="FaceDetectionNet.html#forwardinput" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>forward<wbr/>Input</span></a>
|
2024-09-10 17:30:23 +02:00
|
|
|
<a href="FaceDetectionNet.html#freeze" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>freeze</span></a>
|
2025-02-05 15:02:06 +01:00
|
|
|
<a href="FaceDetectionNet.html#getfrozenparams" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Frozen<wbr/>Params</span></a>
|
|
|
|
|
<a href="FaceDetectionNet.html#getparamfrompath" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Param<wbr/>From<wbr/>Path</span></a>
|
|
|
|
|
<a href="FaceDetectionNet.html#getparamlist" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Param<wbr/>List</span></a>
|
|
|
|
|
<a href="FaceDetectionNet.html#gettrainableparams" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Trainable<wbr/>Params</span></a>
|
2024-09-10 17:30:23 +02:00
|
|
|
<a href="FaceDetectionNet.html#load" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load</span></a>
|
2025-02-05 15:02:06 +01:00
|
|
|
<a href="FaceDetectionNet.html#loadfromdisk" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>From<wbr/>Disk</span></a>
|
|
|
|
|
<a href="FaceDetectionNet.html#loadfromuri" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>From<wbr/>Uri</span></a>
|
|
|
|
|
<a href="FaceDetectionNet.html#loadfromweightmap" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>From<wbr/>Weight<wbr/>Map</span></a>
|
|
|
|
|
<a href="FaceDetectionNet.html#locatefaces" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>locate<wbr/>Faces</span></a>
|
|
|
|
|
<a href="FaceDetectionNet.html#reassignparamfrompath" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reassign<wbr/>Param<wbr/>From<wbr/>Path</span></a>
|
|
|
|
|
<a href="FaceDetectionNet.html#serializeparams" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>serialize<wbr/>Params</span></a>
|
2024-09-10 17:30:23 +02:00
|
|
|
<a href="FaceDetectionNet.html#variable" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>variable</span></a>
|
2025-02-05 15:15:34 +01:00
|
|
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><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="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructorfacedetectionnet" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">FaceDetectionNet</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="FaceDetectionNet.html" class="tsd-signature-type tsd-kind-class">FaceDetectionNet</a><a href="#constructorfacedetectionnet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="FaceDetectionNet.html" class="tsd-signature-type tsd-kind-class">FaceDetectionNet</a></h4><aside class="tsd-sources"><p>Inherited from <a href="SsdMobilenetv1.html">SsdMobilenetv1</a>.<a href="SsdMobilenetv1.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/vladmandic/face-api/blob/master/src/ssdMobilenetv1/SsdMobilenetv1.ts#L17">src/ssdMobilenetv1/SsdMobilenetv1.ts:17</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="_name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>_name</span><a href="#_name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="SsdMobilenetv1.html">SsdMobilenetv1</a>.<a href="SsdMobilenetv1.html#_name">_name</a></p><ul><li>Defined in <a href="https://github.com/vladmandic/face-api/blob/master/src/NeuralNetwork.ts#L17">src/NeuralNetwork.ts:17</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Accessors</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isloaded" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Loaded</span><a href="#isloaded" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature" id="isloaded-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">isLoaded</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><p>Inherited from SsdMobilenetv1.isLoaded</p><ul><li>Defined in <a href="https://github.com/vladmandic/face-api/blob/master/src/NeuralNetwork.ts#L23">src/N
|
